TenDo: Switch reference

Switches specify the various arguments available in TenDo.

Basic options

The following are basic TenDo arguments:

Argument Description
-u [USERNAME] Your 1010data Insights Platform user name.

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

For more information, see -u.

-p [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.

--version Prints the version number of TenDo to the screen.

For more information, see --version.

[TABLE] and [QUERY] or SQL_QUERY are also part of a basic TenDo command. For more information, see:

Session options

The following arguments relate to your TenDo session.

Argument Description
--pool Specifies a SAM pool group ID.

For more information, see --pool.

-k Kill a user's prior existing session of one exists at login.

For more information, see -k.

-K Possess a user's prior existing session, if one exists, at login.

-K.

-S Returns session information.

For more information, see -S.

-s Use the known session instead of logging in.

For more information, see -s.

-l Log out after performing the query.

For more information, see -l.

-L Do not log out after running the query.

For more information, see -L.

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

--auth-retry.

-j Report total 1010data Insights Platform session memory allocation, in bytes.

For more information, see -j.

-J Clears cache before running the query.

For more information, see -J.

--clear Clears the cache after the workspace reaches a certain threshold.

For more information, see --clear.

--authentication Specifies the customized SSO login for the DataBlazer tools.

For more information, see --authentication.

Communication options

The following options deal with how TenDo communicates with 1010data Insights Platform.

Argument Description
-g Connect to the specified 1010data Insights Platform URL.

For more information, see -g.

--get-1010-version Print the version of 1010data Insights Platform to the standard output or to a file.

For more information, see --get-1010-version.

-P Communicate with 1010data Insights Platform through a proxy.

For more information, see -P.

-~ Set the timeout before TenDo resubmits the query.

For more information, see -~.

--retries Set the number of retries to perform in case of network errors.

For more information, see --retries.

-w Specifies how many cells to fetch at once.

For more information, see -w.

-W Fetch a certain number of rows with each getdata.

For more information, see -W.

-X Transfer data as XML instead of compressed binary.

For more information, see-X.

-Z Use binary transfer with 1010data Insights Platform, but not compression.

For more information, see -Z.

Data formatting

The following options deal with how TenDo formats query results.

Argument Description
-f Output should be formatted according to 1010data Insights Platform format specifications.

For more information, see -f.

-F Output data in fixed-width text format using column widths.

For more information, see -F.

-c Use character(s) as a column separator after the column data.

For more information, see -c.

-C Use character(s) as a column separator before each column of data.

For more information, see -C.

-r Use character(s) as a row separator after the row.

For more information, see -r.

-R Use character(s) as a row separator before each row.

For more information, see -R.

-q Use character for CSV-style quoting.

For more information, see -q.

-e Use character for C-style escaping instead of quoting.

For more information, see -e.

-Q Do not use an escaping or quoting character.

For more information, see -Q.

--quoteall Wrap all fields in the CSV quote character.

For more information, see --quoteall.

-I Identifier used to represent floating-point infinities.

For more information, see -I.

-. Specify floating point decimal precision.

For more information, see -..

Output options

The following are output options for the query results.

Argument Description
-M Returns the number of columns in the dataset.

For more information, see -M.

-N Returns the number of rows in the dataset.

For more information, see -N.

-n Puts a limit on the number of rows to return from 1010data Insights Platform.

For more information, see -n.

-i Specifies the row in which to start fetching data.

For more information, see -i.

-h Include a column name header at the top of the output.

For more information, see -h.

-H Include a column label header at the top of the output.

For more information, see -H.

-d Include a raw column datatype header before the data.

For more information, see -d.

-m Include the 1010data Insights Platform column display format header before the data.

For more information, see -m.

-` Replace the newline character with ` in headers.

For more information, see -`.

-o Output data to [OUTPUT_FILE] instead of stdout.

For more information, see -o.

--append Use with -o to append the data to an existing file instead of replacing the file.

For more information, see --append.

-@ Output data in tab-separated format, including column headers and metadata.

For more information, see -@.

-x Output in XML format suitable for uploading to 1010data Insights Platform.

For more information, see -x.

--xlsx Get results as an Excel-compatible XLSX file.

For more information, see --xlsx.

--pdf Get results as a PDF file.

For more information, see --pdf.

--data Get results of a query through the QuickApp DATA renderer.

For more information, see --data.

--static-html Get results of a query through the QuickApp Static HTML renderer.

For more information, see --static-html.

Macro substitution

Macro substitution allows you to use parameters in saved queries and assign the parameters values on the command line.

Argument Description
-[[PARAM]] Substitute arguments for parameters in queries.

For more information, see -[[PARAM]].

Error logging options

The following options pertain to error logging in TenDo.

Argument Description
-v Print verbose information to the error stream.

For more information, see -v.

--xmllog Record XML transactions and responses to a file.

For more information, see --xmllog.

Advanced usage

Argument Description
[DIR] List the contents of a 1010data Insights Platform directory, and perform other directory functions.

For more information, see [DIR].

[TABLE] A table in 1010data Insights Platform accessible by the current user ID.

For more information, see [TABLE].

[NEW_TABLE] Save query results as a new table, or append results to an existing table.

For more information, see [NEW_TABLE].

--query Use with [NEW_TABLE] to save results as a quick query instead of a table.

For more information, see --query.

--update Updates your session's view of [TABLE] before executing the rest of the command.

For more information, see --update.

ftp:[FILE] Saves results as a file on the 1010data FTP site.

For more information, see ftp:[FILE].

-y Allow replacement or deletion of existing table.

For more information, see -y.

-Y or --permissions Gives permissions to users/groups to see the new table/query when creating or modifying an object.

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

--mkdir Creates a new directory.

For more information, see --mkdir.

--uploaders Specifies uploading permissions to the directory you are making or modifying.

For more information, see --uploaders.

--owner Specifies the owner of a table or directory when saving a table, merging tables, making a directory, or modifying table or directory metadata.

For more information, see --owner.

--flushpool Flushes a SAM pool.

For more information, see --flushpool.

--resetpool Resets a SAM pool.

For more information, see --resetpool.

--warmpool Warms a SAM pool.

For more information, see --warmpool.

Advanced table creation

The following are segmenting and sorting options after the table is saved.

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

For more information, see --segby.

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

For more information, see --segby-advise.

--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 --sortseg.

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

For more information, see --sortseg-advise.

--sort Specifies the sorting performed on each segment after the table is saved.

For more information, see --sort.

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

--time-series.