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

    Choose the columns

    List the columns you want, in the order you want them.

    select=col,colselect=*

    Without select, each row comes with every visible column. With it, only the columns you name, in that order.

    Asking for a column that does not exist answers unknown_column. So does asking for a hidden one, such as password_hash: a client cannot tell a hidden column from a missing one.

    Examples

    Two columns of every todo.
    /todos?select=name,status

    Asking the database...

    Hidden columns answer as if they were not there.
    /users?select=password_hash

    Asking the database...

    A column can be named only once.
    /todos?select=name,name

    Asking the database...

    See alsoBring related rows along Names that are keywords
    PreviousNode, Fastify, ExpressNext One row by its key
    restloom - a REST API generated from your database catalog
    DocumentationDownloadSource