# *********************************************************************
# getrow.txt: help text
#
# Copyright (c) 2001,2007 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.
#
# *********************************************************************

                      NoSQL operator: getrow

Selects rows matching a given AWK expression using column names.

Usage: getrow [options] [--] expression

Options:

    -i 'file'
      Read input from 'file' instead of STDIN.

    -h
      Display this help text.

    -N
      Remove header from output.

    -p
      Display the resulting AWK program instead of running it.


Notes:

This program is meant to be used interactively at the command-line,
where speed does not matter much. Programs and scripts should
preferably use 'awktable' and the relevant native syntax.

The following names are reserved to the AWK language, and should not
be used to indicate column names:

BEGIN, END, break, continue, else, exit, exp, for, getline, if, in,
index, int, length, log, next, print, printf, split, sprintf, sqrt,
substr, while, and possibly others. See awk(1) for more on this.

Hint: if all you need is to pick records that match a list of primary
keys, then a better/faster alternative would be to use the 'filtertable'
operator, like this:

     filtertable -- grep -f pick_list < input_table

where 'pick_list' is a file containing one key per line, each prepended
by a caret (^) and followed by a TAB, to make sure that it matches the
table leftmost field, that is the primary key.

