Skip to content
v0.5.1GitHub

Using

Returns a table's schema (columns, indexes) plus HATEOAS links. A view name answers 404 here — use `GET …/views` for views.

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

Relational domain

table
required
string

Table name

Table schema detail

Media typeapplication/json
object
_links
required
object
rows
required
string
self
required
string
columns
required
Array<object>
object
autoincrement
required
boolean
default
name
required
string
nullable
required
boolean
primary_key
required
boolean
references
string | null
type
required
string
unique
required
boolean
created_at
required
integer format: int64
indexes
required
Array<object>
object
column
required
string
name
required
string
unique
required
boolean
name
required
string

Example generated

{
"_links": {
"rows": "example",
"self": "example"
},
"columns": [
{
"autoincrement": true,
"default": "example",
"name": "example",
"nullable": true,
"primary_key": true,
"references": "example",
"type": "example",
"unique": true
}
],
"created_at": 1,
"indexes": [
{
"column": "example",
"name": "example",
"unique": true
}
],
"name": "example"
}

Domain or table not found (a view is not a table)

Media typetext/plain
string

Domain is being deleted

Media typetext/plain
string

Per-domain request budget exceeded

Media typetext/plain
string

Relational engine disabled

Media typetext/plain
string