Indexes

Database indexes are a way to optimize the performance of your database by allowing it to quickly locate and retrieve data. If you have a field that you frequently query or sort by, adding an index to that field can significantly improve the speed of those operations. When your query runs, the database will not scan the entire document to find that one field, but will instead use the index to quickly locate the data. To index a field, set the index option to true in your field’s config:

import type { CollectionConfig } from 'frogbot'

export const MyCollection: CollectionConfig = {
  // ...
  fields: [
    // ...
    {
      name: 'title',
      type: 'text',
      // highlight-start
      index: true,
      // highlight-end
    },
  ],
}

Compound Indexes

In addition to indexing single fields, you can also create compound indexes that index multiple fields together. This can be useful for optimizing queries that filter or sort by multiple fields. To create a compound index, use the indexes option in your Collection Config:

import type { CollectionConfig } from 'frogbot'

export const MyCollection: CollectionConfig = {
  // ...
  fields: [
    // ...
  ],
  indexes: [
    {
      fields: ['title', 'createdAt'],
      unique: true, // Optional, if you want the combination of fields to be unique
    },
  ],
}

Each entry in indexes accepts:

Option	Type	Default	Description
`fields`	`string[]`	Required	Field paths to index together, in order. Dot notation reaches nested fields, such as `group.title`.
`unique`	`boolean`	`false`	Rejects two documents with the same combination of values.

Unique Fields

Setting unique: true on a field creates a collection-wide database unique index on that field’s path. This means no two documents in the collection can share the same value for that field.

Localized fields and MongoDB indexes

When you set index: true or unique: true on a localized field, MongoDB creates one index per locale path (e.g., slug.en, slug.da-dk, etc.). With many locales and indexed fields, this can quickly approach MongoDB’s per-collection index limit. If you know you’ll query specifically by a locale, you can insert a custom MongoDB index for the locale path manually or with a migration script.

Start here

Basics

Managing Data

Features

Ecosystem

Deployment

Compound Indexes

Unique Fields

Localized fields and MongoDB indexes

​Compound Indexes

​Unique Fields

​Localized fields and MongoDB indexes

Compound Indexes

Unique Fields

Localized fields and MongoDB indexes