Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.oleander.dev/llms.txt

Use this file to discover all available pages before exploring further.

Run SQL queries, browse your catalogs and tables, register S3 Tables catalogs, and open a DuckDB terminal connected to your lake from the command line. For a full overview of the lake, see the Lake documentation.

​
Query

Execute ad-hoc SQL queries against the lake: 
oleander query "<sql>"
Example: 
oleander query "SELECT * FROM oleander.default.flowers LIMIT 10"
Results are printed as a formatted table with row counts and execution time.

​
Save results

Use --save to persist query results as a table in your lake: 
oleander query "SELECT * FROM oleander.default.flowers LIMIT 100" --save

​
Catalogs

​
List catalogs

List all available catalogs in your organization: 
oleander catalogs list

​
Register an S3 Tables catalog

Register a catalog backed by S3 Tables: 
oleander catalogs register <catalog_name> \
  --region <region> \
  --account-id <aws_account_id> \
  --bucket <bucket_name> \
  --role-arn <role_arn>
--type is optional and defaults to s3tables.

​
List tables

List tables in a catalog namespace: 
oleander catalogs tables list --catalog <catalog_name> --namespace <namespace>
If you omit --catalog or --namespace, the CLI prompts you interactively.

​
Describe a table

View the schema of a table: 
oleander catalogs tables describe \
  --catalog <catalog_name> \
  --namespace <namespace> \
  --table <table_name>
If you omit any of --catalog, --namespace, or --table, the CLI prompts you interactively.

​
DuckDB terminal

Launch a DuckDB terminal pre-configured with your registered catalogs: 
oleander duckdb
The CLI loads registered lakekeeper and s3tables catalogs into DuckDB before opening the interactive shell. 
SHOW ALL TABLES;
The duckdb command requires DuckDB to be installed on your machine.