Gantry CLI#

application#

Use this to handle application metadata in gantry.

application [OPTIONS] COMMAND [ARGS]...

hard-delete#

Hard delete an existing application in Gantry. This is an irreversible action!

application hard-delete [OPTIONS]

Options

--application-name <application_name>#

--version <version>#

bucket#

Use this to manage your bucket with gantry.

bucket [OPTIONS] COMMAND [ARGS]...

create#

bucket create [OPTIONS]

Options

--name <name>#: Required Bucket name

--region <region>#: Required Region of your bucket, for GCS buckets you can set this to auto

--storage-type <storage_type>#

Required

Options: S3 | GCS

--secret <secret>#: Secret name

list#

List buckets.

bucket list [OPTIONS]

update-secret#

Update bucket secret key.

bucket update-secret [OPTIONS]

Options

--bucket <bucket>#: Required Bucket name

--storage-type <storage_type>#

Required

Options: S3 | GCS

--secret-id <secret_id>#: Secret id

data_connector#

Use this to manage your data connectors with gantry.

data_connector [OPTIONS] COMMAND [ARGS]...

create#

Creates a new data connector to your data source with Gantry.

data_connector create [OPTIONS]

Options

--name <name>#: Required A unique name of the data connector

--connection-type <connection_type>#

Required Type of the source data connection

Options: SNOWFLAKE | S3

--database-name <database_name>#: Name of the source database. WARNING: this field is DEPRECATED and will be removed in a future release. Please provide database name to ‘options’ field.

--secret-name <secret_name>#: Required Name of the secret registered with Gantry

--description <description>#: Required Description of the data connector

--options <options>#

Required JSON string of the options for the data connector.

For SNOWFLAKE connection type, the options should be:

{: “snowflake_database_name”: “string”, “snowflake_schema_name”: “string”, “snowflake_table_name”: “string”

}

For S3 connection type, the options should be:

{: “s3_bucket_name”: “string”, “s3_path_prefix”: “string”, “s3_filetype”: “string”,

} S3 bucket name is the one provided in the secret you have registered with Gantry.

delete#

Deletes a data connector.

data_connector delete [OPTIONS]

Options

--name <name>#: Required A unique name of the data connector

delete-pipeline#

Deletes a data pipeline.

data_connector delete-pipeline [OPTIONS]

Options

--pipeline-name <pipeline_name>#: Required The data pipeline name

--app-name <app_name>#: Required The name of the application

--app-version <app_version>#: The version of the model

list#

List data connectors registered with Gantry.

data_connector list [OPTIONS]

list-pipeline-operations#

Lists pipeline operations for a given pipeline name, appname, and status.

data_connector list-pipeline-operations [OPTIONS]

Options

--pipeline-name <pipeline_name>#: Required The data pipeline name

--app-name <app_name>#: Required The name of the application

--status <status>#

The pipeline operation status to filter by

Options: QUEUED | RUNNING | SUCCEEDED | FAILED

list-pipelines#

Lists the pipelines for a given app name and status.

data_connector list-pipelines [OPTIONS]

Options

--app-name <app_name>#: Required The name of the application

--status <status>#

The status of the data connectors

Options: enabled | disabled | any

projection#

Use this to register a new custom projection to Gantry.

projection [OPTIONS] COMMAND [ARGS]...

get-build-logs#

Display custom projection build logs given task ID

projection get-build-logs [OPTIONS]

Options

--task-id <task_id>#

get-logs#

Retrieve custom projection run logs given a time range

projection get-logs [OPTIONS]

Options

--projection-name <projection_name>#

--start <start>#: Provide a start time to search for logs

--end <end>#: Provide an end time to search for logs

--tail <tail>#: Get the most recent events. If this option is used, –start and –end will be ignored

-v, --verbose#: List raw event logs

update#

Create or update a custom projection in Gantry

projection update [OPTIONS]

Options

--projection-dir <projection_dir>#

--dry-run#: Enable dry run to verify inputs before actually submitting a custom projection to Gantry

secret#

Use this to manage your secret with gantry.

secret [OPTIONS] COMMAND [ARGS]...

create#

Create a secret.

secret create [OPTIONS]

Options

--name <name>#: Required Secret name

--secret-type <secret_type>#

Required

Options: AWS | GCP | SNOWFLAKE_CONN_STR

--secret-file <secret_file>#: Required Json file name which contain your secret info

delete#

Delete secret

secret delete [OPTIONS]

Options

--secret-id <secret_id>#: Required Secret id

list#

List your secrets.

secret list [OPTIONS]