airt db
A set of commands for importing and processing the data from sources like CSV files, databases, or AWS S3 bucket.
Usage:
$ airt db [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion [bash|zsh|fish|powershell|pwsh]: Install completion for the specified shell.--show-completion [bash|zsh|fish|powershell|pwsh]: Show completion for the specified shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
details: Return details of a datablob.from-clickhouse: Create and return a datablob that...from-csv: Process the CSV data and return a...from-local: Create and return a datablob from local...from-mysql: Create and return a datablob that...from-parquet: Process the parquet data and return a...from-s3: Create and return a datablob that...ls: Return the list of datablobs.rm: Delete a datablob from the server.tag: Tag an existing datablob in the server.
airt db details
Return details of a datablob.
Usage:
$ airt db details [OPTIONS] ID
Arguments:
ID: Datablob id in the server. [required]
Options:
-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db from-clickhouse
Create and return a datablob that encapsulates the data from a ClickHouse database.
If the database requires authentication, pass the username/password as commandline arguments or store it in the CLICKHOUSE_USERNAME and CLICKHOUSE_PASSWORD environment variables.
Usage:
$ airt db from-clickhouse [OPTIONS]
Options:
--host TEXT: Remote database host name. [required]--database TEXT: Database name. [required]--table TEXT: Table name. [required]--protocol TEXT: Protocol to use (native/http). [required]--index-column TEXT: The column to use as index (row labels). [required]--timestamp-column TEXT: Timestamp column column name. [required]--port INTEGER: Host port number. If not passed, then the default value 0 will be used. [default: 0]-u, --username TEXT: Database username. If not passed, then the value set in the environment variable CLICKHOUSE_USERNAME will be used else the default value root will be used.-p, --password TEXT: Database password. If not passed, then the value set in the environment variable CLICKHOUSE_PASSWORD will be used else the default value "" will be used.-f, --filters-json TEXT: Any extra filters to apply while importing the data as a JSON string.-t, --tag TEXT: A string to tag the datablob. If not passed, then the tag latest will be assigned to the datablob.-q, --quiet: Output datablob id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db from-csv
Process the CSV data and return a datasource object.
Usage:
$ airt db from-csv [OPTIONS]
Options:
--id INTEGER: Datablob id in the server. [required]--index-column TEXT: The column to use as index (row labels). [required]--sort-by TEXT: The column(s) to sort the data. Can either be a string or a JSON encoded sequence of strings. [required]--deduplicate-data / --no-deduplicate-data: If set to True (default value False), then duplicate rows are removed while uploading. [default: no-deduplicate-data]--blocksize TEXT: Data split size in bytes. If None, then the split size is set to 256MB. [default: 256MB]--kwargs-json TEXT: Any additional parameters to be used while processing the data in a JSON string format.-q, --quiet: Output datasource id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db from-local
Create and return a datablob from local csv file.
Usage:
$ airt db from-local [OPTIONS]
Options:
-p, --path TEXT: The relative or absolute path to a local CSV file or to a directory containing the CSV files. [required]-t, --tag TEXT: A string to tag the datablob. If not passed, then the tag latest will be assigned to the datablob.-q, --quiet: Output data id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db from-mysql
Create and return a datablob that encapsulates the data from a mysql database.
If the database requires authentication, pass the username/password as commandline arguments or store it in the AIRT_CLIENT_DB_USERNAME and AIRT_CLIENT_DB_PASSWORD environment variables.
Usage:
$ airt db from-mysql [OPTIONS]
Options:
--host TEXT: Remote database host name. [required]--database TEXT: Database name. [required]--table TEXT: Table name. [required]--port INTEGER: Host port number. If not passed, then the default value 3306 will be used. [default: 3306]-u, --username TEXT: Database username. If not passed, then the value set in the environment variable AIRT_CLIENT_DB_USERNAME will be used else the default value root will be used.-p, --password TEXT: Database password. If not passed, then the value set in the environment variable AIRT_CLIENT_DB_PASSWORD will be used else the default value "" will be used.--tag TEXT: A string to tag the datablob. If not passed, then the tag latest will be assigned to the datablob.-q, --quiet: Output datablob id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db from-parquet
Process the parquet data and return a datasource object.
Usage:
$ airt db from-parquet [OPTIONS]
Options:
--id INTEGER: Datablob id in the server. [required]--index-column TEXT: The column to use as index (row labels). [required]--sort-by TEXT: The column(s) to sort the data. Can either be a string or a JSON encoded sequence of strings. [required]--deduplicate-data / --no-deduplicate-data: If set to True (default value False), then duplicate rows are removed while uploading. [default: no-deduplicate-data]--blocksize TEXT: Data split size in bytes. If None, then the split size is set to 256MB. [default: 256MB]--kwargs-json TEXT: Any additional parameters to be used while processing the data in a JSON string format.-q, --quiet: Output datasource id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db from-s3
Create and return a datablob that encapsulates the data from an AWS S3 bucket.
Usage:
$ airt db from-s3 [OPTIONS] URI
Arguments:
URI: The AWS S3 bucket uri. [required]
Options:
--access-key TEXT: Access key for the S3 bucket. If None (default value), then the value from AWS_ACCESS_KEY_ID environment variable is used.--secret-key TEXT: Secret key for the S3 bucket. If None (default value), then the value from AWS_SECRET_ACCESS_KEY environment variable is used.--tag TEXT: A string to tag the datablob. If not passed, then the tag latest will be assigned to the datablob.-q, --quiet: Output datablob id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db ls
Return the list of datablobs.
Usage:
$ airt db ls [OPTIONS]
Options:
-o, --offset INTEGER: The number of datablobs to offset at the beginning. If None, then the default value 0 will be used. [default: 0]-l, --limit INTEGER: The maximum number of datablobs to return from the server. If None, then the default value 100 will be used. [default: 100]--disabled: If set to True, then only the deleted datablobs will be returned.Else, the default value False will be used to return only the listof active datablobs.--completed: If set to True, then only the datablobs that are successfully downloadedto the server will be returned. Else, the default value False will be used toreturn all the datablobs.-q, --quiet: Output only ids of datablob separated by space-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db rm
Delete a datablob from the server.
Usage:
$ airt db rm [OPTIONS] ID
Arguments:
ID: Datablob id in the server. [required]
Options:
-q, --quiet: Output the deleted datablob id only.-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.
airt db tag
Tag an existing datablob in the server.
Usage:
$ airt db tag [OPTIONS]
Options:
-id, --datablob_id INTEGER: Datablob id in the server. [required]-n, --name TEXT: A string to tag the datablob. [required]-d, --debug: Set logger level to DEBUG and output everything.--help: Show this message and exit.