query-proposal.md

Query Proposal

Pagination

Offset

Possible keys:

• offset: Int
• limit: Int

{ "limit": 100 }

{ "offset": 10, "limit": 100 }

Sorting

Possible keys:

• orderBy
  • Field: SortOrder

{ "id": "desc" }

[{ "id": "desc" }, { "author": "ascNullsFirst" }]

Possible sort orders:

• "asc"
• "ascNullsFirst"
• "desc"
• "descNullsFirst"

Filtering

Possible keys:

• condition(s)
• filter(s)
• where

{ "<fieldName>" : { "<operator>": "<value>" }

Possible operators:

• _eq
• _neq
• _in
• _nin
• _gt
• _lt
• _gte
• _lte
• _contains
• _ncontains
• _and
• _or

Request Examples

{
  "limit": 100,
  "offset": 500,
  "orderBy": [{ "name": "asc" }],
  "condition": {
    "firstName": { "_eq": "Taylor" },
    "lastName": { "_neq": "McGann" },
    "_or": [
      { "age": { "_lt": 40 }},
      { "age": { "_gte": 30 }}
    ]
  },
  "commit": <Commit>
}

Response Examples

Possible limit-offset response:

{
  "headers": [...],
  "rows": [...],
  "pageInfo": {
    "offset": <Int>,
    "limit": <Int>,
    "totalCount": <Int>,
    "currentCommit": <Commit>,
    "headCommit": <Commit>
  }
}