REST from your database catalog
    DocumentationCheat sheetQuestionsDownloadSource
    Questions
    • How do I...?
    Start here
    • Getting started
    • What a table becomes
    • Compared with PostgREST
    Setting up
    • Tables, columns and relations
    • Security and hooks
    • Writes and procedures
    • Prefer: return=representation
    • Node, Fastify, Express
    Reading
    • select
    • /{key}
    • relation(...)
    • order
    • limit, offset
    • relation.order, .limit
    • count
    • count(), sum(), avg()...
    • "name"
    Filtering
    • eq, neq
    • gt, gte, lt, lte
    • in
    • like, ilike
    • match, imatch
    • is
    • ov, cs, cd
    • not
    • relation.column
    • or, and
    Databases
    • Supported databases
    • Adding a database
    Reference
    • Cheat sheet
    • Errors
    Reading

    Names that are keywords

    Wrap a column name in double quotes so it can never be read as a keyword.

    "limit"=gte.2select=id,"limit"order="limit".desc

    select, order, limit, offset, count, or and and mean something in a query string. A table can still have a column called limit: quote it and it is always that column.

    Quotes work everywhere a column can appear: in select, in a filter, in order, and after a relation name.

    Examples

    Each user's own limit column, filtered and sorted.
    /users?select=name,"limit"&"limit"=gte.2&order="limit".desc

    Asking the database...

    See alsoChoose the columns
    PreviousTotals per groupNext Equal, not equal
    restloom - a REST API generated from your database catalog
    DocumentationDownloadSource