# *********************************************************************
# nblparser.txt: help text
# Copyright (c) 2003,2006 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,v 1.4 2006/03/10 11:26:13 carlo Exp $

                   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 'nosql_'.

    --no-hide (-n)
      Ignore any Type=hidden directive in 'field-schema'.

    --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 schema.rdb < input.nbl | sh


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

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


For more information on NBL see the relevant documentation at:

  http://www.scriptaworks.com/cgi-bin/wiki.cgi/NoSQL/NoSQLBrokeringLanguage

