This page View Markdown Open in ChatGPT Open in Claude

skip¶

skip leaves out the first rows of the result. With limit, it pages through a table : page 3 of 10 rows is skip=20&limit=10.

Query param

GET /api/schema/admin/mysql8/inventory/customers?skip=2&sort=customer_id

Body of the query APIs

{ "find": {}, "skip": 2, "sort": "customer_id" }

Answer : rows 3, 4 and 5

{
    "success": true,
    "statusCode": 200,
    "data": [
        { "customer_id": 3, "first_name": "Mallory", "last_name": "Brown" },
        { "customer_id": 4, "first_name": "Eve", "last_name": "Mathly" },
        { "customer_id": 5, "first_name": "Eve", "last_name": "Page" }
    ]
}

A whole number ; 0 or absent skips nothing.
Always add a sort when you page : without an order, the database is free to return the rows in any order and a page may repeat or miss rows.
getTotalCount=true gives the total to compute the number of pages.
Inside a deep item, skip applies to the related rows of each parent.

limit → getTotalCount