Skip to content
HyperlakeHyperlake

Run your first query

List targets you can access:

Terminal window
hyperlake clusters list

Inspect catalogs:

Terminal window
hyperlake catalog list --cluster CLUSTER_ID

Run a read-only query:

Terminal window
hyperlake query run \
  --cluster CLUSTER_ID \
  --catalog iceberg \
  --schema analytics \
  --sql 'SELECT * FROM orders LIMIT 20'

For scripts, request JSON or CSV output:

Terminal window
hyperlake query run --cluster CLUSTER_ID --sql 'SELECT count(*) FROM orders' --json
hyperlake query run --cluster CLUSTER_ID --sql 'SELECT * FROM orders' --csv

Discover schemas and tables before writing a query:

Terminal window
hyperlake query schemas --cluster CLUSTER_ID --catalog iceberg
hyperlake query tables --cluster CLUSTER_ID --catalog iceberg --schema analytics

The CLI does not bypass catalog policy. A query can fail because the user, catalog, schema, table, row filter, or column mask is not authorized.