distinct

Type: integer | boolean

Engine default: 0 (no distinct)

Parameter syntax

'distinct' => 0|1|2|3

distinct: 0|1|2|3

distinct: 0|1|2|3

'distinct': 0|1|2|3

distinct = 0|1|2|3

distinct: Distinct = Distinct(0|1|2|3)

IndexSettings settings = new IndexSettings();
settings.Distinct = 0|1|2|3;

.setDistinct(Distinct.of(0|1|2|3))

opt.DistinctOf(0|1|2|3)

distinct = Some(Distinct.int(0|1|2|3))

Can be used in these methods:
search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Enables de-duplication or grouping of results.

Distinct is a computationally expensive operation on large data sets, especially if distinct > 1

Distinct functionality is based on one attribute, as defined in attributeForDistinct. Using this attribute, you can limit the number of returned records that contain the same value in that attribute.

For example, on a TV series site, if the distinct attribute is show_name and several hits (episodes) have the same value for show_name (for example, “game of thrones”):

If distinct is 1 (de-duplication), only the most relevant episode is shown. The others aren’t displayed.
If distinct is set to N > 1 (grouping), the N most relevant episodes for every show are displayed.

Usage notes

For distinct to work, configure the distinct attribute in attributeForDistinct. If it isn’t configured, distinct will be accepted at query time but silently ignored.
A 0 value disables de-duplication and grouping.
When using grouping (distinct > 1):
- The hitsPerPage parameter controls the number of returned groups. For example, on a job search site, if hitsPerPage=10 and distinct=3, up to 30 records will be returned—10 companies and up to 3 jobs per company. This behavior allows you to implement pagination with grouping.
- The nbHits attribute in the response contains the number of groups.
Don’t use grouping (distinct > 1) with promoted records. If you do, the value for nbHits will be wrong and faceting won’t work correctly.
distinct(true) is the same as distinct(1)
distinct(false) is the same as distinct(0), which is the same as not specifying distinct at all
Don’t set facetingAfterDistinct to true if you don’t have the same facet values in all records sharing the same distinct key (you would get inconsistent results).

Examples

Set default distinct mode

Copy

1
2
3
4
5
$index->setSettings([
  'distinct' => 0
  // 'distinct' => 1
  // 'distinct' => 2
]);

1
2
3
4
5
6
7
8
9
10
let settings = Settings()
  .set(\.distinct, to: 0)
//.set(\.distinct, to: 1)
//.set(\.distinct, to: 2)

index.setSettings(settings) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
IndexSettings settings = new IndexSettings();
settings.Distinct = 0;
// settings.Distinct = 1;
// settings.Distinct = 2;
// settings.distinct = 3;

index.SetSettings(settings);

1
2
3
4
5
6
7
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    distinct = Some(Distinct.int(0))
    // distinct = Some(Distinct.int(1))
    // distinct = Some(Distinct.int(2))
  )
}

Override default distinct mode for the current search