Distinct attribute

Child route of the settings route.

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.

To learn more about distinct attributes, refer to our dedicated guide.

WARNING

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

Get distinct attribute

GET

/indexes/{index_uid}/settings/distinct-attribute

Get the distinct attribute field of an index. The index uid is required.

Example

curl \
  -X GET 'http://localhost:7700/indexes/shoes/settings/distinct-attribute'

client.index('shoes').getDistinctAttribute()

client.index('shoes').get_distinct_attribute()

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

client.index("shoes").getDistinctAttribute();

client.index('shoes').distinct_attribute

client.Index("shoes").GetDistinctAttribute()

string result = await client.Index("shoes").GetDistinctAttributeAsync();

let distinct_attribute: Option<String> = client
  .index("shoes")
  .get_distinct_attribute()
  .await
  .unwrap();

client.index("shoes").getDistinctAttribute { (result) in
    switch result {
    case .success(let distinctAttribute):
        print(distinctAttribute)
    case .failure(let error):
        print(error)
    }
}

await client.index('shoes').getDistinctAttribute();

Response: 200 Ok

"skuid"

Update distinct attribute

PUT

/indexes/{index_uid}/settings/distinct-attribute

Update the distinct attribute field of an index. This will re-index all documents in the index. The index uid is required.

If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting, e.g., "distinctAttribute": "product.skuid".

Body

A String: the field name.

More information about the body.

WARNING

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

Example

curl \
  -X PUT 'http://localhost:7700/indexes/shoes/settings/distinct-attribute' \
  -H 'Content-Type: application/json' \
  --data-binary '"skuid"'

client.index('shoes').updateDistinctAttribute('skuid')

client.index('shoes').update_distinct_attribute('skuid')

$client->index('shoes')->updateDistinctAttribute('skuid');

client.index("shoes").updateDistinctAttributeSettings("skuid");

client.index('shoes').update_distinct_attribute('skuid')

client.Index("shoes").UpdateDistinctAttribute("skuid")

TaskInfo result = await client.Index("shoes").UpdateDistinctAttributeAsync("skuid");

let task: TaskInfo = client
  .index("shoes")
  .set_distinct_attribute("skuid")
  .await
  .unwrap();

client.index("shoes").updateDistinctAttribute("skuid") { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('shoes').updateDistinctAttribute('skuid');

Response: 202 Accepted

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.

Reset distinct attribute

DELETE

/indexes/{index_uid}/settings/distinct-attribute

Reset the distinct attribute field of an index to its default value. The index uid is required.

Default value: null

Example

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

client.index('shoes').resetDistinctAttribute()

client.index('shoes').reset_distinct_attribute()

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

client.index("shoes").resetDistinctAttributeSettings();

client.index('shoes').reset_distinct_attribute

client.Index("shoes").ResetDistinctAttribute()

TaskInfo result = await client.Index("shoes").ResetDistinctAttributeAsync();

let task: TaskInfo = client
  .index("shoes")
  .reset_distinct_attribute()
  .await
  .unwrap();

client.index("shoes").resetDistinctAttribute { (result) in
    switch result {
    case .success(let task):
        print(task)
    case .failure(let error):
        print(error)
    }
}

await client.index('shoes').resetDistinctAttribute();

Response: 202 Accepted

{
    "taskUid": 1,
    "indexUid": "movies",
    "status": "enqueued",
    "type": "settingsUpdate",
    "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

You can use this taskUid to get more details on the status of the task.