Skip to main content
Complete installation and authentication, then select your organization and project. This task reads an existing shared database table; it does not create one.

Discover the table and schema

Replace table-example with an ID from the list. The list command returns an array; --name filters names by a case-insensitive substring. For a compact view, add --fields id,name,schema_version. For a large list, --limit and --offset shape the fetched records locally. tables get is the CLI’s table description and schema inspection command. Its object includes id, name, schema_version, columns, and access metadata. Inspect columns before building queries. There are no separate db tables describe, schema, or preview commands.

Preview a bounded row sample

The JSON body is the backend query, so this asks the server for a small sample. A query result has an items array and a meta object. Each row has an id and user column values under data, alongside row metadata. This abbreviated example shows how row values are nested:
After confirming that your table actually has a sku column, project it or export a bounded sample:
Replace row-example with an ID from the query. Compare its data with the sample to verify you selected the correct table and row. --fields can use dotted paths; projection changes the displayed shape. Optional command-local --limit and --offset slice the received rows, whereas page and page_size inside --body are sent to the server. Local slicing does not fetch another server page. Inspect returned meta and the deployed query contract before implementing pagination. If you get an empty sample, check context, table access, and the table ID before changing the query. A missing projected column may indicate a schema mismatch. Use API discovery to inspect deployed request requirements rather than guessing filters. For reusable code, see the SDK database workflow and error handling. All CLI options are in the command reference.