<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id$ -->

<!DOCTYPE book [
  <!ENTITY % dummy22 SYSTEM "../entities/global.ent"> %dummy22;
  <!ENTITY % dummy25 SYSTEM "entities/versions.ent"> %dummy25;
]>

<appendix version="5.0" xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink">
  <!-- We declare the default namespace + those for prefixes xlink: and xi: in
       the root element, so we can use them anywhere in this file. -->

  <info xml:id="systempls-app">
    <title>SqlTool System PL Variables</title>
    <subtitle>As of SqlFile revision &SqlFile_rev;</subtitle>
  </info>

  <variablelist>
    <varlistentry><term>*ALL_QUOTED</term><listitem><simpara>
          Boolean.  Whether to quote all values (excluding null values)
          in a \xq export.  No effect on any command other than \xq.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*BOTTOM_HTMLFRAG_FILE</term><listitem><simpara>
          File path to HTML fragment file to close the HTML report or
          DSV import reject file.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_COL_DELIM</term><listitem><simpara>
          DSV or CSV output column delimiter literal.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_COL_SPLITTER</term><listitem><simpara>
          DSV or CSV input column delimiter regular expression.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_CONST_COLS</term><listitem><simpara>
          Specifies constant import values.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_RECORDS_PER_COMMIT</term><listitem><simpara>
          Integer.  How often to commit upon DSV/CSV imports.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_REJECT_FILE</term><listitem><simpara>
          Path to DSV file of rejects rejected upon CSV/DSV imports.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_REJECT_REPORT</term><listitem><simpara>
          Path to HTML report about CSV/DSV import failures.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_ROW_DELIM</term><listitem><simpara>
          DSV or CSV output row delimiter literal.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_ROW_SPLITTER</term><listitem><simpara>
          DSV or CSV input row delimiter regular expression.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_SKIP_COLS</term><listitem><simpara>
          Specifies columns to omit from CSV or DSV importing or exporting.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_SKIP_PREFIX</term><listitem><simpara>
          Specifies comment delimeter character or string in DSV or CSV files.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_TRIM_ALL</term><listitem><simpara>
          Trim leading and trailing white space from every cell in
          CSV or DSV file upon mport.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_TARGET_FILE</term><listitem><simpara>
          File where to export CSV or DSV to.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*DSV_TARGET_TABLE</term><listitem><simpara>
          Table where to import CSV or DSV to.
          Run \x? to see default value and details.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*NULL_REP_HTML</term><listitem><simpara>
          Same as <varname>*NULL_REP_TOKEN</varname>, but only applies to
          HTML reports.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*NULL_REP_TOKEN</term><listitem><simpara>
        String value to represent SQL nulls from VARCHAR columns and
        null (unset) PL variable values.
        Applies to what displays on screen and what gets written into
        export files.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*REVISION</term><listitem><simpara>
        Automatically set to the SqlFile program revision.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*START_TIME</term><listitem><simpara>
        Automatically set to a localized string presenting the date and time.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*TIMESTAMP</term><listitem><simpara>
        Only usable if <varname>*TIMESTAMP_FORMAT</varname> has been set.
        Displays the date and/or time at which this variable is dereferenced.
    </simpara></listitem></varlistentry>
    <varlistentry><term>*TIMESTAMP_FORMAT</term><listitem><simpara>
        Setting this variable enables the <varname>*TIMESTAMP</varname>
        read-only variable to be used.
        Set to a date and/or time format like
        <literal>yyyy-MM-dd'T'HH:mm:ss.SSSZ</literal>, as described at
        <link xlink:href='http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html'/>
    </simpara></listitem></varlistentry>
    <varlistentry><term>*TOP_HTMLFRAG_FILE</term><listitem><simpara>
          File path to HTML fragment file to open the HTML report or
          DSV import reject file.
   </simpara></listitem></varlistentry>
  </variablelist>
</appendi>

