TenUp: Switch reference

Switches specify the various arguments available in TenUp.

TenUp provides two forms for most switches, a short form and a long form. The short form is a dash and a character:

-u
The long form uses two dashes and the switch name:
--username
These forms are interchangeable. The order you in which you provide the switches does not matter.

Most of the table tree and spec tree options have an analogous TenUp switch. For more information, see Option analog table.

Required

The following arguments are required in your TenUp command.

Short form syntax Long form syntax Description
-u [USERNAME] --username= [USERNAME] Your 1010data Insights Platform user name.

When using SAM pool IDs to upload, specify the user ID of the SAM pool owner, not the group ID.

For more information, see -u, --username.

-p [PASSWORD] --password= [PASSWORD] Your 1010data Insights Platform password.

When using SAM pool IDs to upload, specify the password of the SAM pool group owner.

For more information, see -p, --password.

-C [CONNSTR] --connection-string=[CONNSTR] When you are loading data out of an ODBC-compliant database, the ODBC connection string.

Usually, an ODBC connection string looks like the following: "DSN=DataSourceName;UID=DatabaseUid;PWD=DatabasePwd;"

For more information, see -C, --connection-string.

[NEW_TABLE], [QUERY], and [FILE_NAME] are necessary arguments in a basic TenUp command, but they do not have a corresponding switch. For more information, see:

General settings

The following arguments are general TenUp settings. These are optional.

Short form syntax Long form syntax Description
-? --help Displays the help message for TenUp.

For more information, see -?, --help.

-v --verbose Prints verbose debugging information.

For more information, see -v, --verbose.

N/A --log-data Specifies to TenUp to log everything and all of the data in the source database.

For more information, see --log-data.

-G --log-interval Prints a message to the log after extracting a certain number of rows from the source database.

For more information, see -G, --log-interval.

-V --version Prints the version number of TenUp to the screen.

For more information, see -V, --version.

-o --out Specifies the path and file name where TenUp writes log output.

+ is optional. If used, output is appended.

For more information, see -o, --out.

-O -err Specifies the path to write error messages.

+ is optional. If used, output is appended.

For more information, see -O, --err.

-x --xmllog Specifies the path to the XML transaction log (LOG).

+ is optional. If used, output is appended.

For more information, see -x, --xmllog.

-B --bug-report Specifies the path to write a zip file containing the OUT, ERR, and LOG files.

For more information, see -B, --bug-report

-r --report Specifies a file to write the <table> input generated by TenUp and used for that upload. (In the case of flat files, it also specifies <spec> input.)

For more information, see -r, --report.

-D --dry-run Tests the upload for correct permissions without executing the full query.

For more information, see -D, --dry-run.

-/ --restarted Restarts TenUp if there is a client-side error.

For more information, see -/, --restarted

Connection options

The following arguments are TenUp connection credentials. These are optional.

Short form Long form Description
-s --sid-epw Use a pre-existing session.

For more information, see -s, --sid-epw.

-S --outsidepw Prints the current session's SID and EPW to OUT after login.

For more information, see -S, --outsidepw.

-l --log-out Logs the user out of 1010data Insights Platform before terminating the connection.

For more information, see -l, --log-out.

-L --no-log-out Keeps TenUp from logging out of a 1010data Insights Platform session before termination.

For more information, see -L, --no-log-out.

-U --pool Specifies a SAM pool group ID.

For more information, see -U, --pool.

Use only if connecting via a SAM pool.

N/A --auth-retry Specifies the number of retry attempts that are made when logging into 1010data Insights Platform.

For more information, see --auth-retry.

-k --kill Specifies that TenUp should end an existing active session and start a new session.

For more information, see -k, --kill.

-K --possess Specifies that TenUp should possess an existing active session instead of quitting with an error.

For more information, see -K, --possess.

-g --gateway Specifies the gateway to the instance of 1010data Insights Platform to connect to.

For more information, see -g, --gateway.

-P --proxy Specifies a proxy server used to connect to 1010data Insights Platform.

For more information, see -P, --proxy.

N/A --authentication Specifies the customized SSO login for the DataBlazer tools.

For more information, see --authentication.

Table metadata

The following switches refer to metadata in the 1010data Insights Platform table.

Short form Long form Description
N/A --upload-path Provides the full path to the new table to be created in 1010data Insights Platform.
-t --title Specifies the title of the new table.

For more information, see -t, --title.

-N --ldesc Specifies the long description of the new table.

For more information, see -N, --ldesc.

-n --sdesc Specifies the short description of the new table.

For more information, see -n, --sdesc

-I --link-header Specifies the table's default header during link operations.

For more information, see -I, --link-header.

-d --maxdown Specifies the maximum number of cells that a user can download in a single transaction from this table.

For more information, see -d, --max-down.

-h --column-names Specifies the names of the columns as they will be in the table created in 1010data Insights Platform.

For more information, see -h, --column-names.

-H --column-labels Specifies the column labels for the newly-created table in 1010data Insights Platform.

For more information, see -H, --column-labels

-E --column-descs Specifies the column descriptions as they will be in the table created in 1010data Insights Platform.

For more information, see -E, --column-descs.

-f --column-formats Specifies the column display formats as they will appear in the table created in 1010data Insights Platform.

For more information, see -f, --column-formats.

-i --column-types Specifies the column data type as they will be in the table created in 1010data Insights Platform.

For more information, see -i, --column-types.

-F --fix-columns Specifies the column names that should be fixed (non-scrolling).

For more information, see -F, --fix-columns

-X --index-columns Specifies the column names to be indexed.

For more information, see -X, --index-columns.

-Y --permissions Specifies the user/group permissions for the new table.

For more information, see -Y, --permissions.

-0 --owner Specifies the owner of the new table.

For more information, see -0, --owner.

- b --segment-size Specifies the number of records per segment.

For more information, see -b, --segment-size.

-$ --sort Specifies the sorting performed on each segment.

For more information, see -$, --sort.

-j --segby Specifies the column or columns by which to segment the table.

For more information, see -j, --segby.

-q --segby-advise Specifies additional information about the relationship between columns when segmenting a table.

For more information, see -q, --segby-advise.

-J --sortseg Sortseg is a more powerful form of table segmentation that in addition to segmenting, sorts the data in the specified column(s).

For more information, see -J, --sortseg.

-Q --sortseg-advise Specifies additional information about the relationship between columns when segmenting a table.

For more information, see -Q, --sortseg-advise.

-+ --time-series Specifies a time or date+time column to sort by.

For more information, see -+, --time-series.

-, --link Specifies a table and columns to pre-link the new table to.

For more information, see -,, --link.

Source database settings

Short form Long form Description
-M --drop-milliseconds Truncates milliseconds and loads TIME and UTCTIME columns as ansitime columns.

For more information, see -M, --drop-milliseconds.

-m --max-column-size Specifies the mask width for the columns in the source file.

For more information, see -m, --max-column-size.

-T --ignore-trunc Specifies that TenUp should ignore SQLSTATE 01004 errors.

For more information, see -T, --ignore-trunc.

-w --wide-only Specifies that TenUp should always request columns as wide character columns.

For more information, see -w, --wide-only.

-8 --utf-8 Skips the data validation step done on SQL_[[LONG]VAR]CHAR columns.

For more information, see -8, --utf-8.

-c --prompt-dsn-pwd Prompts user for a DSN password before connecting with an ODBC-compliant database.

For more information, see -c, --prompt-dsn-pwd.

-. --base-table Automatically populates the column descriptions for the new table from [BASETABLE] if the column names are the same.

For more information, see -., --base-table.

-R --fetch-size Specifies the number of records per call to SQLFetch.

For more information, see -R, --fetch-size.

-: --param Specifies values used to parameterize a SQL query.

For more information, see -:, --param

N/A --default-column-width Specifies the number of characters to display in the column in the web interface.

For more information, see --default-column-width.

ODBC load settings

Short form Long form Description
-z --bundle-size Specifies how many columns to upload at a time.

For more information, see -z, --bundle-size.

-A --abort-old Aborts an unfinished chunkload session before starting a new session.

For more information, see -A, --abort-old.

-~ --idle-poll Sends a background transaction to 1010data Insights Platform every five minutes to keep the connection.

For more information, see -~, --idle-poll.

N/A --use-long-ints Uploads 64-bit integers with the big integer data type.

For more information, see --use-long-ints.

N/A --use-doubles Uploads integer columns with values greater than 2,147,483,647 and less than -2,147,483,648 as columns with the doubles (decimal) data type.

For more information, see --use-doubles.

Flat file load settings

Short form Long form Description
N/A --column-separator Specifies the column separator, or delimiter, of the data to be uploaded.

For more information, see

N/A --fixed-width Loads fixed-width columns from a flat file.
-e --eor Specifies the end of record delimiter.

For more information, see -e, --eor.

N/A --big-endian Loads flat file data stored with big endian byte order. The default byte order is little endian.

For more information, see --big-endian.

N/A --little-endian Loads flat file data stored with little endian byte order.

For more information, see --little-endian.

N/A --skip-rows Specifies the number of leading rows to discard when uploading from a flat file.

For more information, see --skip-rows.

N/A --limit-rows Specifies the number of leading rows, [NUMRECS], to upload from a flat file.
N/A --mask-character Specifies the default masking character (double quote) of the flat file being loaded.

For more information, see --mask-character.

N/A --input-types Specifies the input types of columns in flat file uploads.

For more information, see --input-types.

N/A --input-widths Specifies the input widths of columns in flat file uploads.

For more information, see --input-widths.

N/A --input-expressions Specifies the input expressions of columns in flat file uploads.

For more information, see --input-expressions.

N/A --skip-columns Provides a list of names of columns that should be excluded from the table upload.

For more information, see --skip-columns.

N/A --nowrite-columns Provides a list of names of columns that should be excluded from the table upload but remain available for use in input expressions.

For more information, see --nowrite-columns.

N/A --lowercase-columns Provide a list of names for text columns that should be loaded in lower case.

For more information, see --lowercase-columns.

N/A --uppercase-columns Provide a list of names for text columns that should be loaded in upper case.

For more information, see --uppercase-columns.

N/A --column-orders The order in which the columns appear in the uploaded table in 1010data Insights Platform.

For more information, see --column-orders.

N/A --auto-spec Extrapolates input metadata from flat file(s) prior to and for use with upload.

For more information, see --auto-spec.

N/A --auto-correct Automatically repairs flat file input data errors caused by mask characters and/or column delimiters.

For more information, see --auto-correct.

N/A --ignore-null Replaces null characters in the flat file input data with spaces.

For more information, see --ignore-null.

N/A --stripefactor Replicates the flat file input data across [STRIPEFACTOR] servers.

For more information, see --stripefactor.

N/A --ftp-upload Tells TenUp to use your FTP account and upload flat files with non-transactional addtab.

For more information, see --ftp-upload.

Generic load settings

Short form Long form Description
-1 --serial Downloads and uploads data using a single thread.

For more information, see -1, --serial.

-2 --pipeline Downloads and uploads data on two different threads.

For more information, see -2, --pipeline.

-Z --no-compress Specifies that TenUp should not use compression when uploading.

For more information, see -Z, --no-compress.

-y --replace Replaces an existing table with the same name in the same directory.

For more information, see -y, --replace.

-a --append Appends data to an existing table with the same name in the same directory, if it exists.

For more information, see -a, --append.

-W --window Uploads a [WINDOW] number of records at a time to 1010data Insights Platform.

For more information, see -W, --window.

N/A --no-empty Instructs TenUp to terminate with an exit code if the table to upload is empty.

For more information, see --no-empty.

N/A --upload-datetime Includes the table upload timestamps in an additional column with the date+time type.

For more information, see --upload-datetime.

N/A --upload-date Includes table upload timestamps in an additional column with the date type.

For more information, see --upload-date.