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 the distinct attribute field of an index.

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();

"movie_id"

POST

Update the field of an index.

A String: the field name.

If the field does not exist, no error will be thrown.


  -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();

{
  "updateId": 1
}

This updateId allows you to .

DELETE

Reset the distinct attribute field of an index to its default value.

Default value:

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();

{
  "updateId": 1