Distinct attribute

is a field whose value will always be unique in the returned documents.

Distinct attribute can also be updated directly through the global settings route along with the other settings.

NOTE

Updating the settings means overwriting the default settings of MeiliSearch. You can reset to default values using the DELETE routes.

GET

Get the field of an index.

Path Variables

$ curl \

client.index('movies').getDistinctAttribute()

client.index('movies').get_distinct_attribute()

$client->index('movies')->getDistinctAttribute();

index.distinct_attribute

client.Settings("movies").GetDistinctAttribute()

let distinct_attribute: Option<String> = movies.get_distinct_attribute().await.unwrap();

Response: 200 Ok

"movie_id"

POST

Update the distinct attribute field of an index.

Path Variables

Body

.

Example

  -X POST 'http://localhost:7700/indexes/movies/settings/distinct-attribute' \
  --data '"movie_id"'

client.index('movies').updateDistinctAttribute('movie_id')

client.index('movies').update_distinct_attribute('movie_id')

$client->index('movies')->updateDistinctAttribute('movie_id');

index.update_distinct_attribute('movie_id')

let progress: Progress = movies.set_distinct_attribute("movie_id").await.unwrap();

Response: 202 Accepted

{
  "updateId": 1
}

This updateId allows you to track the current update.

DELETE

Reset the field of an index to its default value.

Path Variables

Example

$ curl \
  -X DELETE 'http://localhost:7700/indexes/movies/settings/distinct-attribute'

client.index('movies').resetDistinctAttribute()

client.index('movies').reset_distinct_attribute()

$client->index('movies')->resetDistinctAttribute();

index.reset_distinct_attribute

client.Settings("movies").ResetDistinctAttribute()

let progress: Progress = movies.reset_distinct_attribute().await.unwrap();

Response: 202 Accepted

{
  "updateId": 1

This updateId allows you to .