Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
66775e0
PSMDB-2163 vector search
rasika-chivate Jul 3, 2026
b391b9f
Update overview-search.md
rasika-chivate Jul 3, 2026
0ac2ea1
Update overview-search.md
rasika-chivate Jul 3, 2026
563fd72
Create vector-search-architecture.md
rasika-chivate Jul 6, 2026
b5cb9bd
added files for compatibility and architecture
rasika-chivate Jul 13, 2026
8b1200e
added install mongot
rasika-chivate Jul 13, 2026
91200d3
Update install-mongot.md
rasika-chivate Jul 13, 2026
ff3c759
Update install-mongot.md
rasika-chivate Jul 13, 2026
3f49f26
updated config files
rasika-chivate Jul 14, 2026
6fdf6c0
Update mkdocs-base.yml
rasika-chivate Jul 14, 2026
450ce29
updated files
rasika-chivate Jul 14, 2026
be0d87c
Update install-mongot.md
rasika-chivate Jul 15, 2026
4f7257a
Update mkdocs-base.yml
rasika-chivate Jul 15, 2026
14d389e
Update install-mongot.md
rasika-chivate Jul 15, 2026
645ac28
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
ada5b26
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
dfbdadb
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
bf0c3b3
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
636d413
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
5d01d37
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
1bd8a6f
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
05b69c8
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
5c01fcb
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
e3ff9f8
formatting fix
rasika-chivate Jul 15, 2026
3e62644
Merge branch 'PSMDB-2163-vector-search' of https://github.com/percona…
rasika-chivate Jul 15, 2026
602f107
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
01709f2
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
ce14b03
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
c40800f
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
538a98b
docs: remove broken vector-search image reference
Copilot Jul 15, 2026
0e23b0d
Update install-mongot.md
rasika-chivate Jul 15, 2026
3d09f61
Merge branch 'PSMDB-2163-vector-search' of https://github.com/percona…
rasika-chivate Jul 15, 2026
f9d060b
Update install-mongot.md
rasika-chivate Jul 15, 2026
52b4db3
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
afc04cd
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
a242dce
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
cf4ec25
Update install-mongot.md
rasika-chivate Jul 15, 2026
e19ab36
Update install-mongot.md
rasika-chivate Jul 15, 2026
a4016d0
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
7febf59
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
fb16e2b
Update install-mongot.md
rasika-chivate Jul 15, 2026
71941d8
Merge branch 'PSMDB-2163-vector-search' of https://github.com/percona…
rasika-chivate Jul 15, 2026
18b742f
Update install-mongot.md
rasika-chivate Jul 15, 2026
0aff96d
Update install-mongot.md
rasika-chivate Jul 15, 2026
5d198a0
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
2048494
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
95d7b2c
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
23432b9
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
214dd2a
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
863ca96
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
bc1d9ed
docs: complete Docker mongot run command details
Copilot Jul 15, 2026
f094f5f
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
e0b2b7b
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
efcb291
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
24ce877
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
6578216
Potential fix for pull request finding
rasika-chivate Jul 15, 2026
81ecc95
format docker section properly
rasika-chivate Jul 15, 2026
e638102
Update install-mongot.md
rasika-chivate Jul 16, 2026
5d082ab
Potential fix for pull request finding
rasika-chivate Jul 16, 2026
0c1502b
Potential fix for pull request finding
rasika-chivate Jul 16, 2026
daf67d9
Update install-mongot.md
rasika-chivate Jul 17, 2026
c66aadb
Update install-mongot.md
rasika-chivate Jul 17, 2026
f882998
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
04133d9
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
dff2373
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
009045e
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
3b66962
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
e543d04
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
dbd10ee
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
487cb8e
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
247e327
Update install-mongot.md
rasika-chivate Jul 17, 2026
c4e1b64
format fix
rasika-chivate Jul 17, 2026
ba1a617
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
ff2473d
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
54178e3
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
df012f5
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
6e8f996
Update install-mongot.md
rasika-chivate Jul 17, 2026
1ad3b6b
Update install-mongot.md
rasika-chivate Jul 17, 2026
a3357ac
Update install-mongot.md
rasika-chivate Jul 17, 2026
5607a93
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
8fd3cc5
Update install-mongot.md
rasika-chivate Jul 17, 2026
e21c1ce
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
561f48b
Potential fix for pull request finding
rasika-chivate Jul 17, 2026
236ff5d
Update install-mongot.md
rasika-chivate Jul 17, 2026
15da0c0
Update install-mongot.md
rasika-chivate Jul 17, 2026
9f642bd
Update install-mongot.md
rasika-chivate Jul 17, 2026
a7f7010
Update install-mongot.md
rasika-chivate Jul 17, 2026
c5d45da
Created a folder for Vector Search and moved the files
rasika-chivate Jul 20, 2026
0bca53f
Update create-search-index.md
rasika-chivate Jul 20, 2026
2809dd0
Update create-search-index.md
rasika-chivate Jul 20, 2026
c365f1e
added search index topic
rasika-chivate Jul 20, 2026
238a725
Update create-search-index.md
rasika-chivate Jul 20, 2026
b59e232
create search index topic
rasika-chivate Jul 20, 2026
ebcb4c5
update index and dele index topics created
rasika-chivate Jul 20, 2026
9120a83
Update delete-search-index.md
rasika-chivate Jul 20, 2026
369cc81
update files
rasika-chivate Jul 20, 2026
79df643
Update mkdocs-base.yml
rasika-chivate Jul 20, 2026
bb542c6
update the files
rasika-chivate Jul 20, 2026
39bb4cd
Update create-search-index.md
rasika-chivate Jul 20, 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
29 changes: 29 additions & 0 deletions docs/vector_search/configure-mongot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Configure mongot

After installing `mongot`, configure it to connect to the Percona Server for MongoDB replica set, store search indexes, and accept search requests from `mongod`.

Vector Search requires configuration on both sides:

- `mongot` must be able to connect to the replica set and synchronize data.
- `mongod` must know where to send search queries and search-index management requests.

!!! note
The examples in this section use a single-node test environment with `mongod` listening on port **27017** and `mongot` listening on port **27028**. Replace the host names, ports, paths, and credentials with values that are applicable for your deployment.

## Before you begin

- PSMDB is running as an initialized replica set.
- Authentication is enabled.
- The `mongot` binary is installed.
- The user running `mongot` can write to the search data and log directories.
- The host running `mongot` can connect to the replica set.
- The required ports are available.

## Procedure




Comment on lines +22 to +26
Comment on lines +22 to +26
Comment thread
rasika-chivate marked this conversation as resolved.
Comment thread
rasika-chivate marked this conversation as resolved.
Comment thread
rasika-chivate marked this conversation as resolved.



Comment thread
rasika-chivate marked this conversation as resolved.
Comment thread
rasika-chivate marked this conversation as resolved.
Comment on lines +22 to +29
Comment thread
rasika-chivate marked this conversation as resolved.
Comment thread
rasika-chivate marked this conversation as resolved.
167 changes: 167 additions & 0 deletions docs/vector_search/create-search-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
# Create Index

You can use the `createSearchIndex()` method to create a single Search or Vector Search index on a collection, or the `createSearchIndexes()` method to create multiple indexes simultaneously.

## Create single Search Index

Follow these steps to create a single search index:
{.power-number}

1. Insert test data from mongosh:

```javascript
use test
db.docs.insertMany([
{ text: "MongoDB search is powerful" },
{ text: "Vector search is the future" },
{ text: "Full text search with mongot" }
])

{
acknowledged: true,
insertedIds: {
'0': ObjectId('69ebae2599c54be2ea44ba89'),
'1': ObjectId('69ebae2599c54be2ea44ba8a'),
'2': ObjectId('69ebae2599c54be2ea44ba8b')
}
}
```

2. Create a **single Search Index**:

```javascript
db.docs.createSearchIndex({
name: "search_idx",
definition: {
mappings: {
dynamic: true
}
}
})

search_idx
```

3. Check the status.

```javascript
db.docs.getSearchIndexes()
[
{
id: '69ebae2a651bce4d10f57bdc',
name: 'search_idx',
status: 'READY',
queryable: true,
latestDefinitionVersion: { version: 0, createdAt: ISODate('2026-04-24T17:53:46.000Z') },
latestDefinition: { mappings: { dynamic: true } },
statusDetail: [
{
hostname: '69eb5fc573906b6bfb8cefe7',
status: 'READY',
queryable: true,
mainIndex: {
status: 'READY',
queryable: true,
definitionVersion: { version: 0, createdAt: ISODate('2026-04-24T17:53:46.000Z') },
definition: { mappings: { dynamic: true, fields: {} } }
}
}
]
}
]
```

## Create multiple Search Indexes

The following example creates two Search indexes:

```javascript
db.docs.createSearchIndexes([
{
name: "search_idx",
definition: {
mappings: {
dynamic: true
}
}
},
{
name: "text_search_idx",
definition: {
mappings: {
dynamic: false,
fields: {
text: {
type: "string"
}
}
}
}
}
])
[ 'search_idx', 'text_search_idx' ]
```
This creates:

- `search_idx`, which dynamically indexes supported fields.
- `text_search_idx`, which indexes only the text field.

## Create Search and Vector Search Indexes together

You can include Search and Vector Search index definitions in the same command.

```javascript
db.docs.createSearchIndexes([
{
name: "search_idx",
type: "search",
definition: {
mappings: {
dynamic: false,
fields: {
text: {
type: "string"
}
}
}
}
},
{
name: "vector_idx",
type: "vectorSearch",
definition: {
fields: [
{
type: "vector",
path: "embedding",
numDimensions: 3,
similarity: "cosine"
}
]
}
}
])
[ 'search_idx', 'vector_idx' ]
```

## Supported field types

The following field types are supported:

| Field type | Supported source data| Use|
| -----------| ----------------------| --|
| `boolean` | Boolean | Supports exact matching and filtering on `true` and `false` values. |
| `date` | BSON Date | Supports exact matches, range and proximity queries, sorting, and faceting. |
| `document` | Object or subdocument | Defines mappings for fields within a nested object. |
| `embeddedDocuments` | Array of objects | Indexes objects within an array so that each embedded object can be evaluated independently. |
| `number` | `int32`, `int64`, or `double` | Supports exact matches, numeric range and proximity queries, sorting, and faceting. |
| `objectId` | `ObjectId` | Supports matching, filtering, and range operations on `ObjectId` values. |
| `string` | String | Analyzes text for full-text operators such as `text`, `phrase`, `regex`, and `wildcard`. |

For detailed inforamtion on supported feild types, see MongoDB documentation](https://www.mongodb.com/docs/search/index/define-field-mappings/#mongodb-search-field-types)


[Update a search index :material-arrow-right:](../update-search-index.md){.md-button}

[Delete a search index :material-arrow-right:](../delete-search-index.md){.md-button}

14 changes: 14 additions & 0 deletions docs/vector_search/delete-search-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Delete Index

Use the `dropSearchIndex()` method to delete a search or vector search index. The method works the same way for both index types:

```javascript
db.products.dropSearchIndex("products_text_idx");
```

Deleting an index is irreversible. To restore search functionality, create the index again with `createSearchIndex()`, and wait for the initial sync to
complete before running queries against it.

!!! warning
`$search` and `$vectorSearch` queries that reference an index that does not exist return an empty result set rather than an error. If your application starts receiving empty search results after an index change, verify that the index exists and check its status with `getSearchIndexes()`.

Loading