Skip to content

Commit 9c08fb8

Browse files
authored
docs(db-mongodb): fix note on indexing localized fields (#14071)
It was explained in #14025 that defining indexes via collection-level `indexes` for locale paths is not actually supported. This removes the recommendation and configuration example, and replaces them with workarounds provided in #14025. Fixes: 379ef87
1 parent fa28dca commit 9c08fb8

File tree

1 file changed

+1
-15
lines changed

1 file changed

+1
-15
lines changed

docs/database/indexes.mdx

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,4 @@ export const MyCollection: CollectionConfig = {
6767

6868
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.
6969

70-
If you know you'll query specifically by a locale, index only those locale paths using the collection-level `indexes` option instead of setting `index: true` on the localized field. This approach gives you more control and helps avoid unnecessary indexes.
71-
72-
```ts
73-
import type { CollectionConfig } from 'payload'
74-
75-
export const Pages: CollectionConfig = {
76-
fields: [{ name: 'slug', type: 'text', localized: true }],
77-
indexes: [
78-
// Index English slug only (rather than all locales)
79-
{ fields: ['slug.en'] },
80-
// You could also make it unique:
81-
// { fields: ['slug.en'], unique: true },
82-
],
83-
}
84-
```
70+
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.

0 commit comments

Comments
 (0)