-
Notifications
You must be signed in to change notification settings - Fork 183
DOC-12444 add vector indexes to index+overview #3913
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.
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
ggray-cb
merged 2 commits into
release/8.0
from
DOC-12444_Add_vector_indexes_to_index+overview
Oct 13, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
91 changes: 56 additions & 35 deletions
91
modules/learn/pages/services-and-indexes/indexes/indexes.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,69 @@ | ||
| = Indexes | ||
| :description: Couchbase Server indexes enhance the performance of query and search operations. | ||
| :description: Couchbase Server uses indexes to improve the performance of queries and searches. | ||
| :page-aliases: understanding-couchbase:services-and-indexes/indexes/indexes,concepts:indexing | ||
|
|
||
| [abstract] | ||
| {description} | ||
| Each index makes a specific subset of data available for searching. | ||
|
|
||
| _Indexes_ are used by certain services, such as _Query_, _Analytics_, and _Search_, as targets for search-routines. | ||
| Each index makes a predefined subset of data available for the search. | ||
| The Query Service uses indexes from the xref:learn:services-and-indexes/services/index-service.adoc[]. | ||
| The xref:learn:services-and-indexes/services/search-service.adoc[Search] and xref:learn:services-and-indexes/services/analytics-service.adoc[Analytics Services] create and use their own indexes. | ||
|
|
||
| The _Query_ service relies on indexes provided by the _Index_ service. | ||
| The _Search_ and _Analytics_ services both provide their own indexes, internally. | ||
| Couchbase Server supports two classes of indexes: <<#traditional-indexes>> and <<#vector-indexes>>. | ||
|
|
||
| Indexes, when well-designed, provide significant enhancements to the performance of search-operations. | ||
| [#traditional-indexes] | ||
| == Traditional Indexes | ||
|
|
||
| == Indexes | ||
| You can use the following types of indexes for traditional scalar data: | ||
|
|
||
| The following forms of index are available: | ||
| Primary:: | ||
| The xref:services-and-indexes/services/index-service.adoc[Index Service] provides primary indexes based on the unique key of each item in a collection. | ||
| Couchbase Server maintains every primary index asynchronously. | ||
| Use a primary index for basic queries without filters or predicates. | ||
| For more information about primary indexes, see xref:indexes:indexing-overview.adoc[]. | ||
|
|
||
| Primary:: Provided by the xref:services-and-indexes/services/index-service.adoc[Index Service], this is based on the unique key of every item in a specified collection. | ||
| Every primary index is maintained asynchronously. | ||
| A primary index is intended to be used for simple queries, which have no filters or predicates. | ||
| For information on primary indexes, see xref:indexes:indexing-overview.adoc[]. | ||
| Secondary:: | ||
| The xref:services-and-indexes/services/index-service.adoc[Index Service] provides secondary indexes based on attributes in a document. | ||
| The attribute value can be a scalar, object, or array. | ||
|
|
||
| Secondary:: Provided by the xref:services-and-indexes/services/index-service.adoc[Index Service], this is based on an attribute _within_ a document. | ||
| The value associated with the attribute can be of any type: scalar, object, or array. | ||
| + | ||
| A Secondary Index is frequently referred to as a _Global Secondary Index_, or _GSI_. | ||
| This is the kind of index used most frequently in Couchbase Server, for queries performed with {sqlpp}. | ||
| For information on Global Secondary Indexes, see xref:indexes:indexing-overview.adoc[]. | ||
|
|
||
| Search:: Provided by the xref:services-and-indexes/services/search-service.adoc[Search Service], this is a specially purposed index, which contains targets derived from the contents of documents within one or more specified keyspaces. | ||
| Search indexes support text matching, geospatial, date-time, numeric range searches, and more. | ||
| For text matching, you can add filters to remove undesirable characters from input and target text values, such as punctuation marks or HTML tags. | ||
| For information on how to create Search indexes, see xref:search:create-search-indexes.adoc[]. | ||
|
|
||
| Vector Search:: Provided by the xref:services-and-indexes/services/search-service.adoc[Search Service], this is a type of Search index which supports vector embeddings. | ||
| Use Vector Search indexes to run searches with the Search service using vector comparisons. | ||
| You can use Vector Search indexes for Retrieval Augmented Generation (RAG) with an existing Large Language Model (LLM). | ||
| To create Vector Search indexes, see xref:vector-search:create-vector-search-index-ui.adoc[] or xref:vector-search:create-vector-search-index-rest-api.adoc[]. | ||
|
|
||
| Analytics:: Provided by the xref:services-and-indexes/services/analytics-service.adoc[Analytics Service], this is a materialized access path for the shadow data in an Analytics collection. | ||
| Analytics indexes can be used to speed up Analytics selection queries and join queries. | ||
| If changes in operational data result in corresponding modifications to shadow data, Analytics indexes are updated automatically. | ||
| See the section on xref:analytics:7_using_index.adoc[Using Indexes] in Couchbase Analytics. | ||
|
|
||
| View:: Supports xref:learn:views/views-intro.adoc[Couchbase Views], with fields and information extracted from documents. | ||
| Views are deprecated in Couchbase Server 7.0, and will be removed in a future release. | ||
| A secondary index is also called a Global Secondary Index (GSI). | ||
| Most queries in Couchbase Server use GSIs with {sqlpp}. | ||
| For more information about Global Secondary Indexes, see xref:indexes:indexing-overview.adoc[]. | ||
|
|
||
| Search:: | ||
| The xref:services-and-indexes/services/search-service.adoc[Search Service] provides Search indexes that support text matching, geospatial, date-time, and numeric range searches. | ||
| For text matching, you can add filters to remove unwanted characters from input and target text, such as punctuation marks or HTML tags. | ||
| For more information about creating Search indexes, see xref:search:create-search-indexes.adoc[]. | ||
|
|
||
| Analytics:: | ||
| The xref:services-and-indexes/services/analytics-service.adoc[Analytics Service] provides analytics indexes for shadow data in an Analytics collection. | ||
| Analytics indexes speed up selection and join queries in Analytics. | ||
| When operational data changes, Couchbase Server updates analytics indexes automatically. | ||
| For more information about using analytics indexes, see xref:analytics:7_using_index.adoc[]. | ||
|
|
||
| Views:: | ||
| xref:learn:views/views-intro.adoc[Couchbase Views] extract fields and information from documents to create their own index. | ||
|
|
||
| + | ||
| IMPORTANT: Views were deprecated in Couchbase Server 7.0 and will be removed in a future release. | ||
|
|
||
| [#vector-indexes] | ||
| == Vector Indexes | ||
|
|
||
| Couchbase Server also supports indexes for vector search. | ||
| These indexes let you perform semantic similarity searches that form the basis of AI applications. | ||
| See xref:vector-index/vectors-and-indexes-overview.adoc[] for more information about using vector indexes. | ||
|
|
||
| Hyperscale Vector Indexes:: | ||
| The Index Service provides xref:vector-index/hyperscale-vector-index.adoc[Hyperscale Vector Indexes] which index a single vector column. | ||
| They offer the highest performance of any index when it comes to vector data. | ||
| These indexes can scale up to a billion documents containing vectors with a large number of dimensions. | ||
|
|
||
| Composite Vector Indexes:: | ||
| The Index Service provides xref:vector-index/composite-vector-index.adoc[Composite Vector Indexes] which are Global Secondary Indexes (GSIs) with a single vector column. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same thing here |
||
| These indexes let your application use searches for scalar, array, and object index entries to pre-filter the dataset before performing a vector similarity search. | ||
|
|
||
| Search Vector Indexes:: | ||
| The Search Service provides xref:vector-search/vector-search.adoc[Search Vector Indexes] that support a single vector column. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I assume they go to a vector index page but again doesn't seem to work on the preview |
||
| You can use Search Vector Indexes for tasks such as Retrieval Augmented Generation (RAG) with a Large Language Model (LLM). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does the link go to a specific page for Hyperscale vector indexes? it doesn't seem to go anywhere on the preview
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I should have stated in the PR... the links to the vector docs won't work until the GSI vector index work has been merged to the devex release/8.0.