Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,11 @@ node_modules
cdk*
.dev*
CLAUDE.md
mcp.json

# Copilot customization files - workspace agent and instructions
.github/copilot-instructions.md
.github/agents/*.agent.md

# VS Code Copilot cache
.vscode/.copilot-cache/
4 changes: 2 additions & 2 deletions _analyzers/token-filters/hunspell.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Parameter | Required/Optional | Data type | Description
`dedup` | Optional | Boolean | Determines whether to remove multiple duplicate stemming terms for the same token. Default is `true`.
`dictionary` | Optional | Array of strings | Configures the dictionary files to be used for the Hunspell dictionary. Default is all files in the `<OS_PATH_CONF>/hunspell/<locale>` directory if `ref_path` is not specified or all files in the `<OS_PATH_CONF>/<ref_path>/hunspell/<locale>/` directory when `ref_path` is specified. See [Custom dictionary loading with ref_path](#custom-dictionary-loading).
`longest_only` | Optional | Boolean | Specifies whether only the longest stemmed version of the token should be returned. Default is `false`.
`updateable` | Optional | Boolean | When set to `true`, the filter operates in search-time analysis mode, allowing dictionaries to be hot-reloaded by using the [Refresh search analyzer]({{site.url}}{{site.baseurl}}/im-plugin/refresh-analyzer/) API without restarting the node. Default is `false`. **Introduced 3.7.**
`updateable` | Optional | Boolean | When set to `true`, the filter operates in search-time analysis mode, allowing dictionaries to be hot-reloaded by using the [Refresh search analyzer]({{site.url}}{{site.baseurl}}/im-plugin/index-other/refresh-analyzer/) API without restarting the node. Default is `false`. **Introduced 3.7.**

## Example

Expand Down Expand Up @@ -197,7 +197,7 @@ To hot-reload a Hunspell dictionary, follow these steps:

1. Replace the `.aff` and `.dic` files on disk on every node that holds a shard for the index.

1. Call the [Refresh Search Analyzer API]({{site.url}}{{site.baseurl}}/im-plugin/refresh-analyzer/). When `reload_cached_resources` is `false` (the default), the API rebuilds analyzer factories but reuses the previously cached Hunspell dictionary. Specify `reload_cached_resources=true` to force the dictionary to be reloaded from disk:
1. Call the [Refresh Search Analyzer API]({{site.url}}{{site.baseurl}}/im-plugin/index-other/refresh-analyzer/). When `reload_cached_resources` is `false` (the default), the API rebuilds analyzer factories but reuses the previously cached Hunspell dictionary. Specify `reload_cached_resources=true` to force the dictionary to be reloaded from disk:

```json
POST /_plugins/_refresh_search_analyzers/my_index?reload_cached_resources=true
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/alias/alias-exists.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ If you use the Security plugin, make sure you have the appropriate permissions:

## Related documentation

For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
4 changes: 2 additions & 2 deletions _api-reference/alias/aliases-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Manage aliases API performs multiple index alias operations in a single atom

This API is distinct from the [Create or update alias API]({{site.url}}{{site.baseurl}}/api-reference/alias/create-alias/), which operates on a single alias at a time and uses different request parameters. Use the Manage aliases API for bulk operations and atomic transactions involving multiple aliases or indexes.

For conceptual information about index aliases, including use cases and examples, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For conceptual information about index aliases, including use cases and examples, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).


## Endpoints
Expand Down Expand Up @@ -521,4 +521,4 @@ If you use the Security plugin, make sure you have the appropriate permissions:

## Related documentation

For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
4 changes: 2 additions & 2 deletions _api-reference/alias/create-alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ redirect_from:
**Introduced 1.0**
{: .label .label-purple }

The Create or Update Alias API adds one or more indexes to an index alias or updates the settings for an existing alias. For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
The Create or Update Alias API adds one or more indexes to an index alias or updates the settings for an existing alias. For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).

The Create or Update Alias API is distinct from the [Manage aliases API]({{site.url}}{{site.baseurl}}/api-reference/alias/aliases-api/), which supports the addition and removal of aliases and the removal of indexes with their aliases. In contrast, the following API only supports adding or updating an alias without updating the index itself. Each API also uses different request body parameters.
{: .note}
Expand Down Expand Up @@ -324,4 +324,4 @@ If you use the Security plugin, make sure you have the appropriate permissions:

## Related documentation

For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
2 changes: 1 addition & 1 deletion _api-reference/alias/delete-alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ If you use the Security plugin, make sure you have the appropriate permissions:

## Related documentation

For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
2 changes: 1 addition & 1 deletion _api-reference/alias/get-alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,4 +223,4 @@ If you use the Security plugin, make sure you have the appropriate permissions:

## Related documentation

For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
4 changes: 2 additions & 2 deletions _api-reference/alias/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ redirect_from:

OpenSearch index alias APIs allow you to create, update, delete, and retrieve information about aliases.

For conceptual information about index aliases, including use cases and examples, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For conceptual information about index aliases, including use cases and examples, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).

## Available APIs

Expand All @@ -32,4 +32,4 @@ OpenSearch supports the following index alias APIs.

## Related documentation

For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
For more information about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
2 changes: 1 addition & 1 deletion _api-reference/document-apis/reindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before using the Reindex API, note the following requirements and limitations:
Reindexing large datasets can be resource intensive and may impact cluster performance. Monitor cluster health during reindex operations and consider using throttling parameters for production environments. For more information, see [Performance optimization](#performance-optimization).
{: .warning }

For a practical, tutorial-style guide to reindexing with common use cases and examples, see [Reindex data]({{site.url}}{{site.baseurl}}/im-plugin/reindex-data/).
For a practical, tutorial-style guide to reindexing with common use cases and examples, see [Reindex data]({{site.url}}{{site.baseurl}}/im-plugin/reindex/index/).
{: .tip }

Unlike update operations that modify documents within the same index, reindex operations work on different sources and destinations. Thus, version conflicts are unlikely. The `version_type` parameter controls how OpenSearch handles document versions during reindexing. By default, version conflicts stop the reindex process. To continue reindexing when conflicts occur, set the `conflicts` parameter to `proceed`. The response will include a count of version conflicts encountered. Other error types are unaffected by the `conflicts` parameter.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Field | Data type | Description
`settings` | Object | Configuration options for the target index. For a list of index settings, see [Index settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index-settings/). Optional.
`settings.index.number_of_shards` | Integer | The number of primary shards in the target index. This value must equal the number of primary shards in the source index. Optional. Default is the same as the source index.
`settings.index.number_of_replicas` | Integer | The number of replica shards for each primary shard in the target index. Optional. Default is the same as the source index.
`aliases` | Object | Index aliases to apply to the target index. Each key is an alias name, and the value is an alias configuration object. For more information, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/). Optional.
`aliases` | Object | Index aliases to apply to the target index. Each key is an alias name, and the value is an alias configuration object. For more information, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/). Optional.

**Note**: You cannot specify mappings in the clone request. The mappings from the source index are automatically used for the target index.
{: .note}
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/create-index-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
`priority` | Integer | A number that determines which index templates take precedence during the creation of a new index or data stream. OpenSearch chooses the template with the highest priority. When no priority is given, the template is assigned a `0`, signifying the lowest priority. Optional.
`template` | Object | The template that includes the `aliases`, `mappings`, or `settings` for the index. For more information, see [#template]. Optional.
`version` | Integer | The version number used to manage index templates. Version numbers are not automatically set by OpenSearch. Optional.
`context` | Object | (Experimental) The `context` parameter provides use-case-specific predefined templates that can be applied to an index. Among all settings and mappings declared for a template, context templates hold the highest priority. For more information, see [index-context]({{site.url}}{{site.baseurl}}/im-plugin/index-context/).
`context` | Object | (Experimental) The `context` parameter provides use-case-specific predefined templates that can be applied to an index. Among all settings and mappings declared for a template, context templates hold the highest priority. For more information, see [index-context]({{site.url}}{{site.baseurl}}/im-plugin/index-other/index-context).

Check failure on line 51 in _api-reference/index-apis/create-index-template.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/im-plugin/index-other/index-context)'. Raw Output: {"message": "[OpenSearch.LinksEndSlash] Add a trailing slash to the link '({{site.url}}{{site.baseurl}}/im-plugin/index-other/index-context)'.", "location": {"path": "_api-reference/index-apis/create-index-template.md", "range": {"start": {"line": 51, "column": 285}}}, "severity": "ERROR"}

### Template

Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/create-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Field | Data type | Description
`settings.number_of_replicas` | Integer | Simplified syntax for specifying the number of replica shards without the `index` prefix. Optional.
`mappings` | Object | Field mappings for documents in the index. Defines the data type and properties for each field. For more information, see [Mappings]({{site.url}}{{site.baseurl}}/field-types/). Optional.
`mappings.properties` | Object | Defines the fields and their data types in documents. Each key is a field name, and each value is a field definition object. Optional.
`aliases` | Object | Index aliases for the index. Each key is an alias name, and each value is an alias definition object. For more information, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/). Optional.
`aliases` | Object | Index aliases for the index. Each key is an alias name, and each value is an alias definition object. For more information, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/). Optional.

**Note**: You do not have to explicitly specify the `index` section inside the `settings` section. You can use the simplified syntax instead.
{: .note}
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/get-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ The response contains a separate object for each index, for which the key is the

Field | Data type | Description
:--- | :--- | :---
`aliases` | Object | Index aliases associated with the index. Each key is an alias name, and each value is an alias configuration object. For more information, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/index-alias/).
`aliases` | Object | Index aliases associated with the index. Each key is an alias name, and each value is an alias configuration object. For more information, see [Index aliases]({{site.url}}{{site.baseurl}}/im-plugin/aliases/index/).
`mappings` | Object | Field mappings for documents in the index. Defines the data type and properties for each field. For more information, see [Mappings]({{site.url}}{{site.baseurl}}/field-types/).
`settings` | Object | Index settings that control index behavior, such as the number of shards and replicas. For more information, see [Index settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index-settings/).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
---
layout: default
title: Index operations
title: Index operations APIs
parent: Index APIs
nav_order: 30
has_children: true
has_toc: false
---

# Index operations
# Index operation APIs

Index operations APIs provide advanced functionality for maintaining and optimizing indexes in your OpenSearch cluster. These operations help you manage index performance, data organization, and cluster efficiency.

## Available APIs

OpenSearch supports the following index operations APIs.
OpenSearch supports the following index operation APIs:

| API | Description |
|-----|-------------|
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/index-apis/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ The following index API operations are available, organized by category:

- [Alias APIs]({{site.url}}{{site.baseurl}}/api-reference/alias/) - Create, update, delete, and retrieve information about index aliases
- [Core index APIs]({{site.url}}{{site.baseurl}}/api-reference/index-apis/core-index-apis/) - Fundamental operations for managing the lifecycle of indexes
- [Index operations]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index-operations/) - Advanced functionality for maintaining and optimizing indexes
- [Index operations]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index-operation-apis/) - Advanced functionality for maintaining and optimizing indexes
- [Index settings and mappings]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index-settings-mappings/) - Configure and modify index behavior and structure
- [Index templates]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index-templates/) - Create and manage templates for automatic index configuration
- [Index blocks and allocation]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index-blocks-allocation/) - Control index access restrictions and shard allocation
- [Data stream stats]({{site.url}}{{site.baseurl}}/api-reference/index-apis/data-stream-stats/) - Returns statistics for data streams
- [Data streams]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/) - Create, delete, and get information and statistics about data streams
- [Dangling index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/dangling-index/) - Manage indexes that exist on disk but are not part of cluster state

If you use the Security plugin, make sure you have the appropriate permissions.
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/modify-data-stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ If you use the Security plugin, make sure you have the appropriate permissions:
## Related documentation

- [Data streams]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/)
- [Data Stream Stats API]({{site.url}}{{site.baseurl}}/api-reference/index-apis/data-stream-stats/)
- [Viewing data stream statistics]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/api-datastream/#viewing-data-stream-statistics)
2 changes: 1 addition & 1 deletion _api-reference/index-apis/shrink-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ You can track the progress of shard recovery using the [CAT recovery API]({{site

## Index codec considerations

For index codec considerations, see [Index codecs]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/#splits-and-shrinks).
For index codec considerations, see [Index codecs]({{site.url}}{{site.baseurl}}/im-plugin/index-other/index-codecs/#splits-and-shrinks).

## Example: Shrinking an index

Expand Down
2 changes: 1 addition & 1 deletion _api-reference/index-apis/split.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ The following table lists the available request body fields. All fields are opti

## Index codec considerations

For index codec considerations, see [Index codecs]({{site.url}}{{site.baseurl}}/im-plugin/index-codecs/#splits-and-shrinks).
For index codec considerations, see [Index codecs]({{site.url}}{{site.baseurl}}/im-plugin/index-other/index-codecs/#splits-and-shrinks).

## Example: Splitting an index

Expand Down
8 changes: 4 additions & 4 deletions _api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ OpenSearch supports the following REST APIs:
- [Count]({{site.url}}{{site.baseurl}}/api-reference/count/)
- [Cross-cluster replication API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/replication-plugin/api/)
- [Explain]({{site.url}}{{site.baseurl}}/api-reference/explain/)
- [Index rollups API]({{site.url}}{{site.baseurl}}/im-plugin/index-rollups/rollup-api/)
- [Index state management API]({{site.url}}{{site.baseurl}}/im-plugin/ism/api/)
- [Index rollups API]({{site.url}}{{site.baseurl}}/im-plugin/index-rollups/api-rollup/)
- [Index state management API]({{site.url}}{{site.baseurl}}/im-plugin/ism/api-ism/)
- [ISM error prevention API]({{site.url}}{{site.baseurl}}/im-plugin/ism/error-prevention/api/)
- [Job Scheduler APIs]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/job-scheduler/index/#job-scheduler-apis)
- [Vector search API]({{site.url}}{{site.baseurl}}/vector-search/api/)
Expand All @@ -59,7 +59,7 @@ OpenSearch supports the following REST APIs:
- [Performance Analyzer API]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/pa/api/)
- [Point in Time API]({{site.url}}{{site.baseurl}}/search-plugins/point-in-time-api/)
- [Ranking evaluation]({{site.url}}{{site.baseurl}}/api-reference/rank-eval/)
- [Refresh search analyzer]({{site.url}}{{site.baseurl}}/im-plugin/refresh-analyzer/)
- [Refresh search analyzer]({{site.url}}{{site.baseurl}}/im-plugin/index-other/refresh-analyzer/)
- [Remote cluster information]({{site.url}}{{site.baseurl}}/api-reference/remote-info/)
- [Root cause analysis API]({{site.url}}{{site.baseurl}}/monitoring-your-cluster/pa/rca/api/)
- [Snapshot management API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/snapshots/sm-api/)
Expand All @@ -69,7 +69,7 @@ OpenSearch supports the following REST APIs:
- [Security Analytics APIs]({{site.url}}{{site.baseurl}}/security-analytics/api-tools/index/)
- [Stats API]({{site.url}}{{site.baseurl}}/tuning-your-cluster/availability-and-recovery/stats-api/)
- [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks/)
- [Transforms API]({{site.url}}{{site.baseurl}}/im-plugin/index-transforms/transforms-apis/)
- [Transforms API]({{site.url}}{{site.baseurl}}/im-plugin/index-transforms/api-transform/)
- [Hot reload TLS certificates]({{site.url}}{{site.baseurl}}/security/configuration/tls/#hot-reloading-tls-certificates)

## gRPC APIs
Expand Down
2 changes: 1 addition & 1 deletion _benchmark/reference/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ This device supports the `shard-stats-sample-interval` parameter, which defines
## data-stream-stats
<!-- vale on -->

The `data-stream-stats` telemetry device regularly calls the [Data Stream Stats API]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/#step-2-create-a-data-stream) and records one metrics document for cluster-level stats (`_all`) and one metrics document per data stream.
The `data-stream-stats` telemetry device regularly calls the [data stream stats API]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/api-datastream/#viewing-data-stream-statistics) and records one metrics document for cluster-level stats (`_all`) and one metrics document per data stream.

The following is an example of recorded documents given two data streams in the cluster:

Expand Down
Loading
Loading