CLI Reference¶
Complete reference for all drls CLI commands.
Global Options¶
Commands¶
init¶
Initialize catalog configuration.
| Option | Type | Required | Default | Description |
|---|---|---|---|---|
--catalog |
Choice | Yes | — | hadoop, hive, rest, polaris, glue, nessie |
--warehouse |
String | Yes | — | Warehouse path (s3://..., /path/...) |
--uri |
String | No | None |
Catalog URI |
--name |
String | No | drls |
Catalog name |
tables¶
List all tables in the catalog.
| Option | Type | Default | Description |
|---|---|---|---|
--catalog |
String | None |
Iceberg catalog type |
--warehouse |
String | None |
Warehouse path |
--catalog-uri |
String | None |
Catalog URI |
health¶
Show health report for a table.
| Argument/Option | Type | Required | Description |
|---|---|---|---|
TABLE |
String | Yes | Fully qualified table name |
--catalog |
String | No | Catalog type |
--warehouse |
String | No | Warehouse path |
--catalog-uri |
String | No | Catalog URI |
compact¶
Run compaction on a table.
| Argument/Option | Type | Required | Default | Description |
|---|---|---|---|---|
TABLE |
String | Yes | — | Fully qualified table name |
--strategy |
Choice | No | binpack |
binpack, sort, zorder |
--catalog |
String | No | None |
Catalog type |
--warehouse |
String | No | None |
Warehouse path |
--catalog-uri |
String | No | None |
Catalog URI |
expire¶
Expire old snapshots from a table.
| Argument/Option | Type | Required | Default | Description |
|---|---|---|---|---|
TABLE |
String | Yes | — | Fully qualified table name |
--retain |
Integer | No | 5 |
Number of snapshots to retain |
--older-than |
String | No | None |
Expire before this (ISO8601) |
--catalog |
String | No | None |
Catalog type |
--warehouse |
String | No | None |
Warehouse path |
--catalog-uri |
String | No | None |
Catalog URI |
remove-orphans¶
Remove orphan files from a table.
| Argument/Option | Type | Required | Default | Description |
|---|---|---|---|---|
TABLE |
String | Yes | — | Fully qualified table name |
--dry-run |
Flag | No | false |
List files without removing |
--catalog |
String | No | None |
Catalog type |
--warehouse |
String | No | None |
Warehouse path |
--catalog-uri |
String | No | None |
Catalog URI |
history¶
Show snapshot history for a table.
| Argument/Option | Type | Required | Description |
|---|---|---|---|
TABLE |
String | Yes | Fully qualified table name |
--catalog |
String | No | Catalog type |
--warehouse |
String | No | Warehouse path |
--catalog-uri |
String | No | Catalog URI |
stream¶
Start a streaming bridge reading from an Iceberg table.
| Argument/Option | Type | Required | Default | Description |
|---|---|---|---|---|
SOURCE_TABLE |
String | Yes | — | Source Iceberg table for streaming reads |
--sink-table |
String | No | None |
Sink Iceberg table for writes |
--checkpoint |
String | No | None |
Checkpoint location for streaming state |
--trigger-interval |
String | No | 10 seconds |
Processing time trigger interval |
--max-batches |
Integer | No | 0 |
Max batches (0=unlimited) |
--catalog |
String | No | None |
Catalog type |
--warehouse |
String | No | None |
Warehouse path |
--catalog-uri |
String | No | None |
Catalog URI |
grpc-codegen¶
Generate Python protobuf/gRPC stubs from lakehouse.proto. No options.
grpc-serve¶
Start the gRPC server.
| Option | Type | Default | Description |
|---|---|---|---|
--host |
String | 127.0.0.1 |
Bind host |
--port |
Integer | 50051 |
Bind port |
mcp-server¶
Start the MCP server for agentic tool access.
| Option | Type | Default | Description |
|---|---|---|---|
--host |
String | 127.0.0.1 |
Bind host |
--port |
Integer | 8100 |
Bind port |
agent¶
Run a natural language command via TRex.
| Argument/Option | Type | Required | Default | Description |
|---|---|---|---|---|
PROMPT |
String | Yes | — | Natural language command |
--provider |
String | No | ollama |
LLM provider |
--model |
String | No | llama3:70b |
Model name |
--catalog |
String | No | None |
Catalog type |
--warehouse |
String | No | None |
Warehouse path |
--catalog-uri |
String | No | None |
Catalog URI |