Skip to content
v0.5.1GitHub

Using

Lists rows of `table`. Every query parameter other than `expand`/`limit`/ `offset` is an equality filter on the like-named column (`?col=value`, AND-combined); parse errors and unknown filter columns answer 400. This compiles onto the same bound `*`-SELECT plan `/sql` would use.

applies to v0.5.1
GET
/store-api/rel/{domain}/tables/{table}/rows
curl --request GET \
--url https://example.com/store-api/rel/example/tables/example/rows \
--header 'Authorization: Bearer <token>'
domain
required
string

Relational domain

table
required
string

Table name

expand
string

Comma-separated REFERENCES columns to resolve, or “*” for all

limit
integer format: int64

Max rows to return (falls back to the configured default, capped at the configured max)

offset
integer format: int64

Rows to skip

Matching rows as objects, with row_count/limit/offset/limit_applied

Media typeapplication/json
object
limit
required
integer format: int64
limit_applied
required
boolean
offset
required
integer format: int64
row_count
required
integer
rows
required

One JSON object per row (catalog column order in principle; serde_json’s default map is unordered/alphabetical here, see rel_browse.rs module docs), with an optional _expanded block.

Array<object>
object

Example generated

{
"limit": 1,
"limit_applied": true,
"offset": 1,
"row_count": 1,
"rows": [
{}
]
}

Unknown filter column, or a filter/limit/offset parse/type error

Media typetext/plain
string

Domain or table not found

Media typetext/plain
string

Domain is being deleted

Media typetext/plain
string

Response exceeds max_response_bytes

Media typetext/plain
string

Per-domain request budget exceeded

Media typetext/plain
string

Relational engine disabled

Media typetext/plain
string