Argument Flags - Aster Client

Teradata Aster® Client Guide

Product
Aster Client
Release Number
7.00
Published
May 2017
Language
English (United States)
Last Update
2018-04-13
dita:mapPath
hki1475000360386.ditamap
dita:ditavalPath
Generic_no_ie_no_tempfilter.ditaval
dita:id
B700-2005
lifecycle
previous
Product Category
Software

Aster Export accepts the following flags.

Aster Export Flags
Column Type
-? [ --help ] Shows the online help.
-B [ --begin-script ] arg Specifies the qualified path of the file containing SQL commands that should be executed when the transaction starts, i.e. immediately after the begin command is issued to Aster Database.
Data-returning statements such as SELECT are not allowed. Each command in the begin script should be on a separate line. Do not include BEGIN or END statements.
-c [ --csv ] Exports the output files in CSV format (the default is to use Text format).
-C [ --columns ] arg An optional comma-separated list of columns to be exported from the source table (the default is to export all columns).
-d [ --dbname ] arg Specifies the name of the database to connect to (the default is 'beehive').
-D [ --delimiter ]arg Specifies the delimiter character to use when exporting data (must be a string that represents a valid single character, such as 'd' or '\n'). The default is a tab character ('\t') in text mode, a comma (',') in CSV mode.
-E [ --end-script ] arg Specifies the qualified path of the file containing SQL commands that should be executed when the transaction finishes, i.e. immediately before the end command is issued to Aster Database.
Data-returning statements such as SELECT are not allowed. Each command in the end script should be on a separate line. Do not include BEGIN or END statements.
-e [ --escape ] arg Specifies the escape character for CSV output (must be a string that represents a valid single character, such as 'd' or '\n'). The default is the quote value - double-quote by default. This option is only valid when CSV mode is specified.
-f [ --force-loader ] Instructs ncluster_export to use the loader node specified with the '-l/--loader' option even if the IP address provided is not known to Aster Database.
ncluster_export will only try that single IP address and return an error status if the connection fails for any reason.
filename

(Not a flag; you pass the file or directory name itself!)

filename indicates the name of the file that will receive the exported data. If you don’t supply a file or directory name argument, Aster Export assumes you want to export to STDOUT. If the filename contains spaces, make sure you enclose it in double quotes.
-h [ --hostname ] arg Specifies the hostname or IP address of the machine on which Aster Database is running. Default is 'localhost'.
-l [ --loader ] arg Preferred loader IP address. If a value is provided, ncluster_export will try to export through this IP address before trying any other loader node. NOTE: ncluster_export expects this IP address to be known by Aster Database and will simply ignore the address provided if this is not the case. To change this behavior one can use the '-f/--force-loader' option.
-m [ --map-file ] arg Specifies the name of the file containing mappings of the tables to be exported. This option allows export of multiple tables within the same transaction. For details about the format used for the map file, see the Exporting from Multiple Tables section.
-M [ --max-tuples-per-file ] arg Specifies how many records are exported to a single file. If the total number of records exceeds this number multiple output files with the suffix '_N' are produced, where N is an integer.
-n [ --null ] arg Specifies a string that represents a NULL value. The default is '\N' in text mode and an empty value with no quotes in CSV mode. See also --null-backslash-escapes.
--null-backslash-escapes Indicates that backslashes in the '-n/--null' flag should be treated as special characters, which will be processed according to the default rules for escaped strings.

You should use this flag whenever the null string contains a backslash, to ensure compatibility with future versions of Aster Database.

-p [ --port ] arg Specifies the TCP port on which Aster Database is listening for connections. The default is port 2406.
-q [ --quote ] arg Specifies the quote character for CSV output (must be a string that represents a valid single character, such as 'd' or '\n'). The default is the double-quote. This option is only valid if CSV mode is specified.
schemaname

(Not a flag; you pass the schema name itself!)

schemaname is the optional name of the source table’s schema. If no schema name is provided, Aster Database will search the schemas listed in your current schema search path.
-t [ --timeout ] arg Specifies the timeout value (in seconds) to use when connecting to Aster Database (default is 30).
tablename

(Not a flag; you pass the table name itself!)

tablename is the name of the source table. See the Case-Sensitive Handling for Table Names section if you want to have Aster Database evaluate table names in a case-sensitive manner. To export from multiple tables, see the Exporting from Multiple Tables section.
-U [ --username ] arg Connects to the database with the specified username instead of the default ('beehive'). (You must have permission to do so.) Note that when the --enable-sso parameter is not specified, the user needs to specify the username and password in order to connect to Aster Database (this is the default mode of authenticating while using the tool).
-V [ --version ] Prints the version of ncluster_export and exit.
-w [ --password ] arg Connects to the database with the specified password (as opposed to providing a password at the prompt). Note that when the --enable-sso parameter is not specified, the user needs to specify the username and password in order to connect to Aster Database (this is the default mode of authenticating while using the tool).
-W [ --password-prompt ] Forces ncluster_export to prompt for a password before connection to the database.
--enable-sso Enables SSO support for Aster Loader Tool.
Log in to the client machine using your key distribution center (KDC) domain username and password.

The user needs to use the --enable-sso parameter in order to connect to Aster Database for authentication using SSO. When the --enable-sso parameter is not specified, the user needs to specify the username and password in order to connect to Aster Database (this is the default mode of authenticating while using the tool).

--gss-lib-path <path> [Linux only] Sets the GSS shared library path (default on Linux is /opt/quest/lib32 or /opt/quest/lib64). Ignored on Windows.