babylon
babylon¶
CLI used for cloud interactions between CosmoTech and multiple cloud environment
Usage:
babylon [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--verbosity, -v |
text | Either CRITICAL, ERROR, WARNING, INFO or DEBUG | INFO |
-n, --dry-run |
boolean | Will run commands in dry-run mode. | False |
--version |
boolean | Print version number and return. | False |
--log-path |
directory | Path to the directory where log files will be stored. If not set, defaults to current working directory. | /home/runner/work/Babylon/Babylon |
--help |
boolean | Show this message and exit. | False |
Subcommands
- api: Cosmotech API
- apply: Macro Apply
- destroy: Macro Destroy
- init:
- namespace: Babylon namespace
api¶
Cosmotech API
Usage:
babylon api [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- about: Get API about information
- create-dataset:
- create-dataset-part: Create dataset part
- create-organization:
- create-runner:
- create-solution:
- create-workspace:
- delete-dataset: Delete a dataset by ID
- delete-dataset-part: Delete dataset part by ID
- delete-organization:
- delete-run: Delete a run
- delete-runner: Delete a runner by ID
- delete-solution: Delete a solution by ID
- delete-workspace: Delete a workspace by ID
- download-dataset-part: Download dataset part
- get-dataset: Get dataset
- get-dataset-part: Get dataset part
- get-organization: Get organization
- get-run: Get a run
- get-run-logs: Get run logs
- get-run-status: Get run status
- get-runner: Get runner
- get-solution: Get solution
- get-workspace: Get workspace
- list-dataset-parts: List dataset parts
- list-datasets:
- list-organizations:
- list-runners: List runners
- list-runs: List runs
- list-solutions: List solutions
- list-workspaces:
- query-data: Query data from a dataset part
- start-run: Start a run
- stop-run: Stop a run
- update-dataset: Update dataset
- update-dataset-part: Update dataset part
- update-organization:
- update-runner: Update runner
- update-solution: Update solution
- update-workspace: Update workspace
about¶
Get API about information
Usage:
babylon api about [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
create-dataset¶
Create a dataset using a YAML payload file.
Usage:
babylon api create-dataset [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
create-dataset-part¶
Create dataset part
Usage:
babylon api create-dataset-part [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
create-organization¶
Create an organization using a YAML payload file.
Usage:
babylon api create-organization [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
create-runner¶
Create a runner using a YAML payload file.
Usage:
babylon api create-runner [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--sid |
text | Solution ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
create-solution¶
Create a solution using a YAML payload file.
Usage:
babylon api create-solution [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
create-workspace¶
Create a workspace using a YAML payload file.
Usage:
babylon api create-workspace [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--sid |
text | Solution ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-dataset¶
Delete a dataset by ID
Usage:
babylon api delete-dataset [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-dataset-part¶
Delete dataset part by ID
Usage:
babylon api delete-dataset-part [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--dpid |
text | Dataset Part ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-organization¶
Delete an organization by ID
Usage:
babylon api delete-organization [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-run¶
Delete a run
Usage:
babylon api delete-run [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--rnid |
text | Run ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-runner¶
Delete a runner by ID
Usage:
babylon api delete-runner [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-solution¶
Delete a solution by ID
Usage:
babylon api delete-solution [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--sid |
text | Solution ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
delete-workspace¶
Delete a workspace by ID
Usage:
babylon api delete-workspace [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
download-dataset-part¶
Download dataset part
Usage:
babylon api download-dataset-part [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--dpid |
text | Dataset Part ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-dataset¶
Get dataset
Usage:
babylon api get-dataset [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-dataset-part¶
Get dataset part
Usage:
babylon api get-dataset-part [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--dpid |
text | Dataset Part ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-organization¶
Get organization
Usage:
babylon api get-organization [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-run¶
Get a run
Usage:
babylon api get-run [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--rnid |
text | Run ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-run-logs¶
Get run logs
Usage:
babylon api get-run-logs [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--rnid |
text | Run ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-run-status¶
Get run status
Usage:
babylon api get-run-status [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--rnid |
text | Run ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-runner¶
Get runner
Usage:
babylon api get-runner [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-solution¶
Get solution
Usage:
babylon api get-solution [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--sid |
text | Solution ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
get-workspace¶
Get workspace
Usage:
babylon api get-workspace [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-dataset-parts¶
List dataset parts
Usage:
babylon api list-dataset-parts [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-datasets¶
List all datasets
Usage:
babylon api list-datasets [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-organizations¶
List all organizations
Usage:
babylon api list-organizations [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-runners¶
List runners
Usage:
babylon api list-runners [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-runs¶
List runs
Usage:
babylon api list-runs [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-solutions¶
List solutions
Usage:
babylon api list-solutions [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
list-workspaces¶
List all workspaces
Usage:
babylon api list-workspaces [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
query-data¶
Query data from a dataset part
Usage:
babylon api query-data [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--dpid |
text | Dataset Part ID | Sentinel.UNSET |
--selects |
text | Column names that should be part of the response data. | Sentinel.UNSET |
--sums |
text | Column names to sum by. | Sentinel.UNSET |
--avgs |
text | Column names to average by. | Sentinel.UNSET |
--counts |
text | Column names to count by. | Sentinel.UNSET |
--mins |
text | Column names to min by. | Sentinel.UNSET |
--maxs |
text | Column names to max by. | Sentinel.UNSET |
--offset |
integer | The query offset | Sentinel.UNSET |
--limit |
integer | The query limit | Sentinel.UNSET |
--group-bys |
text | Column names to group by | Sentinel.UNSET |
--order-bys |
text | Column names to order by. Default order is ascending. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
start-run¶
Start a run
Usage:
babylon api start-run [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
stop-run¶
Stop a run
Usage:
babylon api stop-run [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
update-dataset¶
Update dataset
Usage:
babylon api update-dataset [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
update-dataset-part¶
Update dataset part
Usage:
babylon api update-dataset-part [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--did |
text | Dataset ID | Sentinel.UNSET |
--dpid |
text | Dataset Part ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
update-organization¶
Update organization
Usage:
babylon api update-organization [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
update-runner¶
Update runner
Usage:
babylon api update-runner [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--rid |
text | Runner ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
update-solution¶
Update solution
Usage:
babylon api update-solution [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--sid |
text | Solution ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
update-workspace¶
Update workspace
Usage:
babylon api update-workspace [OPTIONS] PAYLOAD_FILE
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
-o, --output |
choice (json | yaml | wide) |
Output format. One of: json, yaml, or wide | Sentinel.UNSET |
-f, --file |
text | Path to the file to save the response | Sentinel.UNSET |
--oid |
text | Organization ID | Sentinel.UNSET |
--wid |
text | Workspace ID | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
apply¶
Macro Apply
Usage:
babylon apply [OPTIONS] DEPLOY_DIR
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--var-file |
path | Specify the path of your variable file. By default, it takes the variables.yaml file. | ['./variables.yaml'] |
--include |
text | Specify the resources to deploy. | Sentinel.UNSET |
--exclude |
text | Specify the resources to exclude from deployment. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
destroy¶
Macro Destroy
Usage:
babylon destroy [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name without any special character | Sentinel.UNSET |
-t, --tenant |
text | Tenant Id without any special character | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--include |
text | Specify the resources to destroy. | Sentinel.UNSET |
--exclude |
text | Specify the resources to exclude from destroction. | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |
init¶
Scaffolds a new Babylon project structure using YAML templates.
Usage:
babylon init [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--project-folder |
text | Name of the project folder to create (default: 'project'). | project |
--variables-file |
text | Name of the variables file (default: 'variables.yaml'). | variables.yaml |
--help |
boolean | Show this message and exit. | False |
namespace¶
Babylon namespace
Usage:
babylon namespace [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- get-contexts: Display the currently active namespace
- get-states: Display all states in your local machine
- use: Switch to a specific Babylon namespace or create a new one
get-contexts¶
Display the currently active namespace
Usage:
babylon namespace get-contexts [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
get-states¶
Display all states in your local machine
Usage:
babylon namespace get-states [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
use¶
Switch to a specific Babylon namespace or create a new one
Usage:
babylon namespace use [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --context |
text | Context Name | Sentinel.UNSET |
-t, --tenant |
text | Tenant Name | Sentinel.UNSET |
-s, --state-id |
text | State Id | Sentinel.UNSET |
--help |
boolean | Show this message and exit. | False |