# *********************************************************************
# nblparser.txt: help text
# Copyright (c) 2003,2006,2012 Carlo Strozzi
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 dated June, 1991.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
# *********************************************************************
# $Id: nblparser.txt 78 2014-06-06 20:51:24Z carlo $

                   NoSQL operator: nblparser

NoSQL Brokering Language (NBL) interpreter

Usage: nblparser [options] file-schema [field-schema]

Options:
    --input (-i) 'file'
      Read input NBL statements from 'file' instead of STDIN.

    --output (-o) 'file'
      Write output sh(1) script to 'file' instead of STDOUT.

    --unsafe (-U)
      Accept unsafe NBL directives, i.e. 'system'.
      By default unsafe directives are refused.

    --delete (-d) 'n'
      Remove temporary files created by 'remember-as' after 'n' seconds.
      By default they are deteted after the default delay applied by
      the 'tmptable' operator.

    --directory (-D) 'path'
      Consider all file-names (both listed on the command-line and
      found in schema files) relative to 'path', except those that
      are already expressed in full-path.

    --prefix (-P) 'string'
      Assume that column names in 'file-schema' and 'field-schema'
      tables begin with 'string'. If this option is not specified,
      then 'string' defaults to null.

    --no-hide (-n)
      Ignore 'hidden' flags in 'field-schema'.

    --no-lock (-L)
      Omit printing any table-locking shell commands.

    --help (-h)
      Display this help text.

Notes:

Takes a database schema table on the command-line, and a batch of NBL
statements on STDIN, and produces a sh(1) script with the corresponding
NoSQL pipeline of commands.

Here is an example usage at the command-line:

              nblparser table.rdb < input.nbl | sh


A field schema may optionally be specified, i.e.:

          nblparser files.rdb fields.rdb < input.nbl | sh

A properly construed schema, containing both field (i.e. table columns)
and file (i.e. table names and paths) information in one single file
may also be used. In this case it will have to be passed twice to the
program, i.e.:

          nblparser schema.rdb schema.rdb < input.nbl | sh

For more information on NBL see the relevant documentation at:

  http://www.strozzi.it/cgi-bin/CSA/tw7/I/en_US/NoSQL/NoSQL%20Brokering%20Language

