orbitra lake
Commands provided by the orbitra-lake plugin.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
orbitra lakeorbitra-lake plugin.
orbitra lake create-or-update-tableorbitra lake create-or-update-table [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | The namespace where the table lives (or will be created). | |
--schema | str | yes | The table schema as a JSON object, identical to the lake-api TableSchema payload. It has “name” (str) and “columns” (a list of objects with “name”, “type” and optional “kind”/“exclude_from_hash”). Allowed “type”: “string”, “int”, “long”, “float”, “double”, “boolean”, “timestamp”, “date”. Allowed “kind”: “partition” or “regular” (default). | |
--allow-column-removal | bool | no | False | Allow removing columns absent from the schema when updating an existing table. |
--include-hash | bool | no | False | Add the orbitra_hash column for content-based change detection. |
--env | str | no | 'prod' | Target environment. |
orbitra lake create-or-update-table --namespace <namespace> --schema '{"name": "my_table", "columns": [{"name": "id", "type": "long"}, {"name": "dt", "type": "date", "kind": "partition"}]}'
orbitra lake create-or-update-table --namespace finance --schema '{"name": "my_table", "columns": [{"name": "id", "type": "long"}, {"name": "dt", "type": "date", "kind": "partition"}]}' --allow-column-removal
orbitra lake download-bytes-from-raworbitra lake download-bytes-from-raw [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | Namespace used to compose the raw storage container. | |
--name | str | yes | The blob path within the container to read. | |
--output | str | yes | Local path to write the downloaded bytes to. | |
--env | str | no | 'prod' | Target environment. |
orbitra lake download-bytes-from-raw --namespace <namespace> --name "finance/2025/report.pdf" --output <output>
orbitra lake download-bytes-from-raw --namespace finance --name "finance/2025/report.pdf" --output ./output.json --env dev
orbitra lake get-dataorbitra lake get-data [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | The namespace where the table is located. | |
--table | str | yes | The name of the table to read from. | |
--filter | str | no | None | A JSON array of column filters, identical to the lake-api query payload. Each item is an object with “column”, “op” and “value”. Allowed “op”: ”==”, ”>”, ”>=”, ”<”, ”<=”, “in” (for “in”, “value” must be a JSON list). Value types are read from the JSON as-is (numbers, booleans, strings, lists); filters are combined with AND. |
--select | list | no | None | Columns to project from the table. If omitted, all columns are returned. Restricting the projection to the columns you need is the recommended way to read subsets of wide tables. Repeat the flag or pass several names: —select col_a —select col_b. |
--limit | int | no | None | Maximum number of rows to return. If omitted, all rows are returned. |
--output | str | no | None | Write the result to this path instead of printing it. The format is inferred from the extension: .parquet, .csv or .json. |
--env | str | no | 'prod' | Target environment. |
orbitra lake get-data --namespace <namespace> --table <table>
orbitra lake get-data --namespace finance --table daily_prices --filter '[{"column": "DT_COMPTC", "op": ">=", "value": "2025-01-01"}, {"column": "NR_COTST", "op": "in", "value": [10, 40]}]' --select close_price --limit 100 --output ./output.json
orbitra lake get-table-metadataorbitra lake get-table-metadata [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | The namespace where the table is located. | |
--table | str | yes | The name of the table. | |
--output | str | no | None | Write the schema to this path instead of printing it. Only .json is supported (the TableSchema as JSON). |
--env | str | no | 'prod' | Target environment. |
orbitra lake get-table-metadata --namespace <namespace> --table <table>
orbitra lake get-table-metadata --namespace finance --table daily_prices --output ./output.json
orbitra lake list-namespacesorbitra lake list-namespaces [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--output | str | no | None | Write the result to this path instead of printing it. Only .json is supported (a JSON array of namespace names). |
--env | str | no | 'prod' | Target environment. |
orbitra lake list-namespaces
orbitra lake list-namespaces --output ./output.json
orbitra lake list-tablesorbitra lake list-tables [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | The namespace whose tables are listed. | |
--output | str | no | None | Write the result to this path instead of printing it. Only .json is supported (a JSON array of table names). |
--env | str | no | 'prod' | Target environment. |
orbitra lake list-tables --namespace <namespace>
orbitra lake list-tables --namespace finance --output ./output.json
orbitra lake overwrite-dataorbitra lake overwrite-data [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | The namespace where the table is located. | |
--table | str | yes | The name of the table to overwrite. | |
--input | str | yes | Path to the data file. The format is inferred from the extension: .parquet, .csv or .json. | |
--check-hash | bool | no | False | Only overwrite partitions whose content hash changed (requires a hashed table). |
--output | str | no | None | Write the operation result (inserted rows, modified partitions, operation id) to this path. Only .json is supported. |
--env | str | no | 'prod' | Target environment. |
orbitra lake overwrite-data --namespace <namespace> --table <table> --input <input>
orbitra lake overwrite-data --namespace finance --table daily_prices --input ./data.parquet --check-hash --output ./output.json
orbitra lake run-queryorbitra lake run-query [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | The namespace to run the query in. | |
--query | str | yes | The SQL query to execute. | |
--engine | Literal | no | 'local' | The query engine to use: “local” (default) or “remote”. |
--limit | int | no | None | Truncate the result to at most this many rows (applied after the query runs). If omitted, all rows are returned. |
--output | str | no | None | Write the result to this path instead of printing it. The format is inferred from the extension: .parquet, .csv or .json. |
--env | str | no | 'prod' | Target environment. |
orbitra lake run-query --namespace <namespace> --query <query>
orbitra lake run-query --namespace finance --query "SELECT * FROM daily_prices LIMIT 10" --engine remote --limit 100 --output ./output.json
orbitra lake upload-bytes-to-raworbitra lake upload-bytes-to-raw [OPTIONS]
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--namespace | str | yes | Namespace used to compose the raw storage container. | |
--input | str | yes | Path to the local file whose bytes are uploaded. | |
--dest | str | yes | Destination blob path within the container. | |
--env | str | no | 'prod' | Target environment. |
orbitra lake upload-bytes-to-raw --namespace <namespace> --input <input> --dest "finance/2025/report.pdf"
orbitra lake upload-bytes-to-raw --namespace finance --input ./data.parquet --dest "finance/2025/report.pdf" --env dev