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:

1import type { CollectionConfig } from 'payload'
2
3export MyCollection: CollectionConfig = {
4  // ...
5  fields: [
6    // ...
7    {
8      name: 'title',
9      type: 'text',
10      index: true,
11    },
12  ]
13}

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:

1import type { CollectionConfig } from 'payload'
2
3export const MyCollection: CollectionConfig = {
// ...
fields: [
  // ...
],
indexes: [
  {
    fields: ['title', 'createdAt'],
    unique: true, // Optional, if you want the combination of fields to be unique
  },
],
14}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Get the resources you need to start building today

Microsoft chose Payload to tell the world about AI.

Indexes

Compound Indexes

MongoDB