Sort

Documents in FrogBot can be sorted by a specific Field. When querying Documents, pass the name of any top-level field to sort the Documents by that field in ascending order. If prefixed with a minus symbol (”-”), they will be sorted in descending order. In Local API multiple fields can be specified by using an array of strings. In REST API multiple fields can be specified by separating fields with comma. The minus symbol can be in front of individual fields. Because sorting is handled by the database, the field cannot be a Virtual Field unless it’s linked with a relationship field. It must be stored in the database to be searchable.

For performance reasons, it is recommended to enable index: true for the fields that will be sorted upon. More details.

Local API

To sort Documents in the Local API, you can use the sort option in your query:

import type { FrogBot } from 'frogbot'

const getPosts = async (frogbot: FrogBot) => {
  const posts = await frogbot.find({
    collection: 'posts',
    overrideAccess: true,
    sort: '-createdAt',
  })

  return posts
}

To sort by multiple fields, you can use the sort option with fields in an array:

import type { FrogBot } from 'frogbot'

const getPosts = async (frogbot: FrogBot) => {
  const posts = await frogbot.find({
    collection: 'posts',
    overrideAccess: true,
    sort: ['priority', '-createdAt'],
  })

  return posts
}

REST API

To sort in the REST API, you can use the sort parameter in your query:

fetch('https://localhost:3000/api/posts?sort=-createdAt')
  .then((response) => response.json())
  .then((data) => console.log(data))

To sort by multiple fields, you can use the sort parameter with fields separated by comma:

fetch('https://localhost:3000/api/posts?sort=priority,-createdAt')
  .then((response) => response.json())
  .then((data) => console.log(data))

You can also pass sort as an array so each item is a single field when using query string builder:

import { stringify } from 'qs-esm'

const getPosts = async () => {
  const stringifiedQuery = stringify(
    {
      sort: ['priority', '-createdAt'],
    },
    { addQueryPrefix: true },
  )

  const response = await fetch(
    `https://localhost:3000/api/posts${stringifiedQuery}`,
  )
  const data = await response.json()
  return data
}

GraphQL API

To sort in the GraphQL API, you can use the sort parameter in your query:

query {
  Posts(sort: "-createdAt") {
    docs {
      color
    }
  }
}

To sort by multiple fields in GraphQL, pass a comma-separated list:

query {
  Posts(sort: "priority,-createdAt") {
    docs {
      color
    }
  }
}

Start here

Basics

Managing Data

Features

Ecosystem

Deployment

Local API

REST API

GraphQL API

​Local API

​REST API

​GraphQL API

Local API

REST API

GraphQL API