Data Hauler: Switch reference

The Data Hauler switches specify various options for connecting and uploading to 1010data Insights Platform.

Some Data Hauler options can:
  • Be added to a config file.
  • Use a wildcard character.
  • Be specified in an environment variable.

Data Hauler provides two forms for some 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.
Short switch Long switch Argument Description
-u --username [USERNAME] Specifies the 1010data Insights Platform user name.

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

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

-p --password [PASSWORD] Specifies the 1010data Insights Platform password of the user.

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

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

N/A --pool [GROUPNAME] Specifies a SAM pool group ID.

Use only if connecting via a SAM pool.

For more information, see --pool.

N/A --pool-max [GROUPMAX] Specifies the maximum number of user IDs from the SAM pool to use when uploading the data.

Use only if connecting via a SAM pool.

For more information, see --pool-max.

-C --connection-string [CONNSTR] Specifies the connection string for the ODBC-compliant database.

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

-d --destination [DSTPATH] Clone the source database into an existing 1010data Insights Platform directory.

The user must have write access to the specified path.

For more information, see -d, --destination.

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

By default, this is https://www2.1010data.com/gw

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

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

Use if connecting to the platform via a proxy.

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

N/A --whitelist [WHITESRCPATH] Designates specific directories and tables to upload.

For more information, see --whitelist.

N/A --blacklist [BLACKSRCPATH] Designates the specific tables or folders to exclude from the upload.

For more information, see --blacklist.

N/A --rename [SRCPREFIX]=[DSTPREFIX] Upload the subset of directories/tables matching a particular path in the source database to a different path in the destination database.

For more information, see --rename.

N/A --passthrough [SRC_PATH]=[PASSTHROUGH] Executes a subset of TenUp command(s) with the specified options.

For more information, see --passthrough.

-0 --owner [OWNER] Set the owner for all directories and tables in a clone to a single user or group owner.

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

-Y --permissions [PERMISSIONS] Specifies user and group permissions for the directories and tables in a clone created by Data Hauler.

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

N/A --uploaders [UPLOADERS] Set upload permissions for all directories in a clone.

For more information, see --uploaders.

N/A --config [CONFIG] Specifies the path to an existing configuration file for whitelist, blacklist, rename, and passthrough options.

For more information, see --config.

-o --out[+] [OUT] Specifies the path where Data Hauler writes log output.

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

-O --err[+] [ERR] Specifies the path to write error messages.

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

N/A --xmllog[+] [LOG] Specifies the path where Data Hauler writes XML logs.

For more information, see --xmllog.

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

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

N/A --include-sys N/A Specifies whether to include system databases and tables in the upload.

For more information, see --include-sys.

-y --replace N/A Overwrite an existing table with the same name in the same directory.

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

-a --append N/A Appends data to an existing table with the same name in the same directory.

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

-v --verbose N/A Specifies the amount of information written to [OUT] or [ERR].

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

N/A --log-progress N/A Prints the log to the command line or to the [OUT] log file while the upload is in progress.

For more information, see --log-progress.

N/A --fast-fail N/A Requires Data Hauler to terminate if it encounters a failing upload instead of passing over it.

For more information, see --fast-fail.

-k --kill N/A Kills an active 1010data Insights Platform session if it exists.

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

-K --possess N/A Possesses an active 1010data Insights Platform session if it exists.

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

N/A --auth-retry [AUTHRETRY] Tells 1010data Insights Platform to make [AUTHRETRY] number of attempts to log in before terminating.

For more information, see --auth-retry.

N/A --wait [WAIT] Number of seconds to wait between retried login attempts.

For more information, see --wait.

-i --ignore-ssl N/A Causes Data Hauler to ignore all SSL errors.

For more information, see -i, --ignore-ssl.

N/A --version N/A Prints the version number of Data Hauler.

For more information, see --version.

-?, -h --help N/A Prints the help message.

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

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

For more information, see --authentication.