Depth

Documents in FrogBot Collections can have relationships to other Documents. When you query a Document, you can specify the depth at which to populate related Documents either as full objects or only their IDs. Since Documents can be infinitely nested or recursively related, it’s important to be able to control how deep your API populates. Depth can impact the performance of your queries by affecting the load on the database and the size of the response. For example, when you specify a depth of 0, the API response might look like this:

{
  "id": "5ae8f9bde69e394e717c8832",
  "title": "This is a great post",
  "author": "5f7dd05cd50d4005f8bcab17"
}

But with a depth of 1, the response might look like this:

{
  "id": "5ae8f9bde69e394e717c8832",
  "title": "This is a great post",
  "author": {
    "id": "5f7dd05cd50d4005f8bcab17",
    "name": "John Doe"
  }
}

Depth has no effect in the GraphQL API, because there, depth is based on the shape of your queries.

Local API

To specify depth in the Local API, you can use the depth option in your query:

import type { FrogBot } from 'frogbot'

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

  return posts
}

REST API

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

fetch('https://localhost:3000/api/posts?depth=2')
  .then((res) => res.json())
  .then((data) => console.log(data))

Default Depth

If no depth is specified in the request, FrogBot will use its default depth for all requests. By default, this is set to 1. To change the default depth on the application level, you can use the defaultDepth option in your root FrogBot config:

import { buildConfig } from 'frogbot'

export default buildConfig({
  // ...
  defaultDepth: 2,
  // ...
})

Max Depth

Relationship and Upload fields can also set a maximum depth. If exceeded, this limits the population depth regardless of the depth requested. To set a max depth for a field, use the maxDepth property in your field configuration:

{
  slug: 'posts',
  fields: [
    {
      name: 'author',
      type: 'relationship',
      relationTo: 'users',
      maxDepth: 2,
    }
  ]
}

Start here

Basics

Managing Data

Features

Ecosystem

Deployment

Local API

REST API

Default Depth

Max Depth

​Local API

​REST API

​Default Depth

​Max Depth

Local API

REST API

Default Depth

Max Depth