docs/TechRef/qstore/test_qstore.txt

   1 test_qstore
   2
   3 This command-line utility exercises most of the code used in the qstore server, but
   4 without the complications of sending and receiving OSRF messages.
   5
   6 Synopsis:
   7
   8 test_qstore  [options]  query_id
   9
  10 Query_id is the id of a row in the query.stored_query table, defining a stored query.
  11
  12 The program reads the specified row in query.stored_query, along with associated rows
  13 in other tables, and displays the corresponding query as an SQL command.  Optionally it
  14 may execute the query, display the column names of the query result, and/or display the
  15 bind variables.
  16
  17 In order to connect to the database, test_qstore uses various connection parameters
  18 that may be specified on the command line.  Any connection parameter not specified
  19 reverts to a plausible default.
  20
  21 The database password may be read from a specified file or entered from the keyboard.
  22
  23 Options:
  24
  25 -b  Boolean; Display the name of any bind variables, and their default values.
  26
  27 -D  Specifies the name of the database driver; defaults to "pgsql".
  28
  29 -c  Boolean; display column names of the query results, as assigned by PostgreSQL.
  30
  31 -d  Specifies the database name; defaults to "evergreen".
  32
  33 -h  Specifies the hostname of the database; defaults to "localhost".
  34
  35 -i  Specifies the name of the IDL file; defaults to "/openils/conf/fm_IDL.xml".
  36
  37 -p  Specifies the port number of the database; defaults to 5432.
  38
  39 -u  Specifies the database user name; defaults to "evergreen".
  40
  41 -v  Boolean; Run in verbose mode, spewing various detailed messages.  This option is not
  42         likely to be useful unless you are troubleshooting the code that loads the stored
  43         query.
  44
  45 -w  Specifies the name of a file containing the database password (no default).
  46
  47 -x  Boolean: Execute the query and display the results.
  48