Skip to content

RDoc-3905 Debugging index errors #2550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ppekrol merged 2 commits into from
Jul 7, 2026
Merged

RDoc-3905 Debugging index errors #2550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d23852
RDoc-3905 Debugging index errors
Danielle9897 Jul 2, 2026
883cabe
RDoc-3905 fix links
Danielle9897 Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
274 changes: 186 additions & 88 deletions docs/indexes/troubleshooting/debugging-index-errors.mdx
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 17 additions & 3 deletions docs/server/configuration/indexing-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,18 @@ Disable query optimizer generated indexes (auto-indexes). Dynamic queries will n

## Indexing.ErrorIndexStartupBehavior

Set how faulty indexes should behave on database startup when they are loaded.
By default they are not started.
* Set how faulty indexes should behave on database startup when they are loaded.

* Optional values:
* `Default`:
Faulty indexes are loaded but not started; they remain in the error state until handled manually.
* `Start`:
An index that was marked as errored is set back to the normal state and started, without rebuilding it.
This does not recover an index that failed to open.
* `ResetAndStart`:
The index is reset (rebuilt from scratch) and then started.
From version 5.2 this also resets faulty indexes that could not be opened -
for example, after a [Database ID mismatch](../../indexes/troubleshooting/debugging-index-errors.mdx#index-marked-as-faulty-on-startup).

- **Type**: `enum ErrorIndexStartupBehaviorType` (`Default`, `Start`, `ResetAndStart`)
- **Default**: `Default`
Expand Down Expand Up @@ -377,7 +387,11 @@ Optional values:
## Indexing.SkipDatabaseIdValidationOnIndexOpening

EXPERT ONLY:
Allow to open an index without checking if current Database ID matched the one for which index was created.

* Allow to open an index without checking if current Database ID matches the one for which index was created.

* When enabled, an index whose storage belongs to a different database will be allowed to open and may silently return incomplete query results.
Intended for support scenarios; learn more in [Index marked as faulty on startup](../../indexes/troubleshooting/debugging-index-errors.mdx#index-marked-as-faulty-on-startup).

- **Type**: `bool`
- **Default**: `false`
Expand Down
275 changes: 187 additions & 88 deletions versioned_docs/version-6.2/indexes/troubleshooting/debugging-index-errors.mdx
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 17 additions & 3 deletions versioned_docs/version-6.2/server/configuration/indexing-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,18 @@ Disable query optimizer generated indexes (auto-indexes). Dynamic queries will n

## Indexing.ErrorIndexStartupBehavior

Set how faulty indexes should behave on database startup when they are loaded.
By default they are not started.
* Set how faulty indexes should behave on database startup when they are loaded.

* Optional values:
* `Default`:
Faulty indexes are loaded but not started; they remain in the error state until handled manually.
* `Start`:
An index that was marked as errored is set back to the normal state and started, without rebuilding it.
This does not recover an index that failed to open.
* `ResetAndStart`:
The index is reset (rebuilt from scratch) and then started.
From version 5.2 this also resets faulty indexes that could not be opened -
for example, after a [Database ID mismatch](../../indexes/troubleshooting/debugging-index-errors.mdx#index-marked-as-faulty-on-startup).

- **Type**: `enum ErrorIndexStartupBehaviorType` (`Default`, `Start`, `ResetAndStart`)
- **Default**: `Default`
Expand Down Expand Up @@ -345,7 +355,11 @@ Optional values:
## Indexing.SkipDatabaseIdValidationOnIndexOpening

EXPERT ONLY:
Allow to open an index without checking if current Database ID matched the one for which index was created.

* Allow to open an index without checking if current Database ID matches the one for which index was created.

* When enabled, an index whose storage belongs to a different database will be allowed to open and may silently return incomplete query results.
Intended for support scenarios; learn more in [Index marked as faulty on startup](../../indexes/troubleshooting/debugging-index-errors.mdx#index-marked-as-faulty-on-startup).

- **Type**: `bool`
- **Default**: `false`
Expand Down
275 changes: 187 additions & 88 deletions versioned_docs/version-7.0/indexes/troubleshooting/debugging-index-errors.mdx
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 17 additions & 3 deletions versioned_docs/version-7.0/server/configuration/indexing-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,8 +301,18 @@ Disable query optimizer generated indexes (auto-indexes). Dynamic queries will n

## Indexing.ErrorIndexStartupBehavior

Set how faulty indexes should behave on database startup when they are loaded.
By default they are not started.
* Set how faulty indexes should behave on database startup when they are loaded.

* Optional values:
* `Default`:
Faulty indexes are loaded but not started; they remain in the error state until handled manually.
* `Start`:
An index that was marked as errored is set back to the normal state and started, without rebuilding it.
This does not recover an index that failed to open.
* `ResetAndStart`:
The index is reset (rebuilt from scratch) and then started.
From version 5.2 this also resets faulty indexes that could not be opened -
for example, after a [Database ID mismatch](../../indexes/troubleshooting/debugging-index-errors.mdx#index-marked-as-faulty-on-startup).

- **Type**: `enum ErrorIndexStartupBehaviorType` (`Default`, `Start`, `ResetAndStart`)
- **Default**: `Default`
Expand Down Expand Up @@ -374,7 +384,11 @@ Optional values:
## Indexing.SkipDatabaseIdValidationOnIndexOpening

EXPERT ONLY:
Allow to open an index without checking if current Database ID matched the one for which index was created.

* Allow to open an index without checking if current Database ID matches the one for which index was created.

* When enabled, an index whose storage belongs to a different database will be allowed to open and may silently return incomplete query results.
Intended for support scenarios; learn more in [Index marked as faulty on startup](../../indexes/troubleshooting/debugging-index-errors.mdx#index-marked-as-faulty-on-startup).

- **Type**: `bool`
- **Default**: `false`
Expand Down
Loading
Loading