Skip to content

Commit d6233a5

Browse files
pre-review fixes
1 parent dae1767 commit d6233a5

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

.code-samples.meilisearch.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1482,4 +1482,4 @@ update_network_1: |-
14821482
"searchApiKey": "ANOTHER_INSTANCE_API_KEY"
14831483
}
14841484
}
1485-
}'
1485+
}'

learn/multi_search/implement_sharding.mdx

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Implement sharding with remote federated search — Meilisearch documenta
33
description: This guide walks you through implemnting a sharding strategy by activating the `/network` route, configuring the network object, and performing remote federated searches.
44
---
55

6-
# Implement sharding with remote federated search
6+
# Implement sharding with remote federated search <NoticeTag type="experimental" label="experimental" />
77

88
Sharding is the process of splitting an index containing many documents into multiple smaller indexes, often called shards. This horizontal scaling technique is useful when handling large databases. In Meilisearch, the best way to implement a sharding strategy is to use remote federated search.
99

@@ -36,14 +36,14 @@ Meilisearch should respond immediately, confirming the route is now accessible.
3636

3737
## Configuring the network object
3838

39-
The network object consists of the following fields:
39+
Next, you must configure the network object. It consists of the following fields:
4040

41-
- `remotes`: a list with the required information to access each remote instance
42-
- `self`: specifies which of configured remotes corresponds to the current instance
41+
- `remotes`: defines a list with the required information to access each remote instance
42+
- `self`: specifies which of the configured `remotes` corresponds to the current instance
4343

4444
### Setting up remote instances
4545

46-
Next, configure the `remotes` field of the network object:
46+
Use the `/network` route to configure the `remotes` field of the network object. `remotes` should be an object containing one or more objects. Each one of the nested objects should consist of the name of each instance, associated with its URL and an API key with search permission:
4747

4848
```sh
4949
curl \
@@ -68,8 +68,6 @@ curl \
6868
}'
6969
```
7070

71-
Each object should consist of the name of each instance, associated with its URL and an API key with search permission.
72-
7371
Configure the entire set of remote instances in your sharded database, making sure to send the same remotes to each instance.
7472

7573
### Specify the name of the current instance
@@ -112,7 +110,7 @@ If your disk space allows, you can reduce the downtime by applying the following
112110
113111
Create the same empty indexes with the same settings on all instances. Keeping the settings and indexes in sync is important to avoid errors and unexpected behavior, though not strictly required.
114112
115-
Distribute your documents across all instances. Do not send same document **to multiple instances**, as this may lead to duplicate search results. Similarly, you should ensure all future versions of a document are sent to the same instance. Meilisearch recommends you hash their primary key using [rendezvous hashing](https://en.wikipedia.org/wiki/Rendezvous_hashing).
113+
Distribute your documents across all instances. Do not send the same document to multiple instances as this may lead to duplicate search results. Similarly, you should ensure all future versions of a document are sent to the same instance. Meilisearch recommends you hash their primary key using [rendezvous hashing](https://en.wikipedia.org/wiki/Rendezvous_hashing).
116114
117115
### Updating index settings
118116

reference/api/network.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This feature is not available for Meilisearch Cloud users.
2626

2727
```json
2828
{
29-
"self": "ms-00",
29+
"self": "ms-00",
3030
"remotes": {
3131
"ms-00": {
3232
"url": "http://ms-1235.example.meilisearch.io",
@@ -50,7 +50,7 @@ This feature is not available for Meilisearch Cloud users.
5050

5151
**Type**: Object<br />
5252
**Default value**: `{}`<br />
53-
**Description**: An object containing `remote` objects. The key of each remote object indicates the name of the remote instance
53+
**Description**: An object containing [remote objects](#the-remote-object). The key of each remote object indicates the name of the remote instance
5454

5555
#### The remote object
5656

@@ -65,7 +65,7 @@ This feature is not available for Meilisearch Cloud users.
6565

6666
**Type**: String<br />
6767
**Default value**: `null`<br />
68-
**Description**: URL indicating the address of a Meilisearch instance. This URL does not need to be public, but must be accessible to all instances in the network. Required.
68+
**Description**: URL indicating the address of a Meilisearch instance. This URL does not need to be public, but must be accessible to all instances in the network. Required
6969

7070
##### `searchApiKey`
7171

@@ -87,7 +87,7 @@ Returns the current value of the instance's network object.
8787

8888
```json
8989
{
90-
"self": "ms-00",
90+
"self": "ms-00",
9191
"remotes": {
9292
"ms-00": {
9393
"url": "http://ms-1235.example.meilisearch.io",

0 commit comments

Comments
 (0)