You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -963,11 +963,12 @@ The instant search query string, used to set the string you want to search in yo
963
963
964
964
### Attributes
965
965
966
-
#### attributesToIndex
966
+
#### searchableAttributes
967
967
968
968
- scope: `settings`
969
969
- type: `array of strings`
970
970
- default: `*`
971
+
- formerly known as: `attributesToIndex`
971
972
972
973
973
974
The list of attributes you want index (i.e. to make searchable).
@@ -979,7 +980,7 @@ This parameter has two important uses:
979
980
980
981
1.**Limit the attributes to index.** For example, if you store the URL of a picture, you want to store it and be able to retrieve it, but you probably don't want to search in the URL.
981
982
982
-
2.**Control part of the ranking.** The contents of the `attributesToIndex` parameter impacts ranking in two complementary ways:
983
+
2.**Control part of the ranking.** The contents of the `searchableAttributes` parameter impacts ranking in two complementary ways:
983
984
984
985
First, the order in which attributes are listed defines their ranking priority: matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. To assign the same priority to several attributes, pass them within the same string, separated by commas. For example, by specifying `["title,"alternative_title", "text"]`, `title` and `alternative_title` will have the same priority, but a higher priority than `text`.
985
986
@@ -1034,13 +1035,13 @@ You can also use `*` to retrieve all values when an **attributesToRetrieve** set
1034
1035
1035
1036
- scope: `search`
1036
1037
- type: `array of strings`
1037
-
- default: `attributesToIndex`
1038
+
- default: `searchableAttributes`
1038
1039
1039
1040
1040
-
List of attributes you want to use for textual search (must be a subset of the `attributesToIndex` index setting).
1041
+
List of attributes you want to use for textual search (must be a subset of the `searchableAttributes` index setting).
1041
1042
Attributes are separated with a comma such as `"name,address"`.
1042
1043
You can also use JSON string array encoding such as `encodeURIComponent("[\"name\",\"address\"]")`.
1043
-
By default, all attributes specified in the `attributesToIndex` settings are used to search.
1044
+
By default, all attributes specified in the `searchableAttributes` settings are used to search.
1044
1045
1045
1046
1046
1047
### Ranking
@@ -1060,7 +1061,7 @@ We have nine available criterion:
1060
1061
*`geo`: Sort according to decreasing distance when performing a geo location based search.
1061
1062
*`words`: Sort according to the number of query words matched by decreasing order. This parameter is useful when you use the `optionalWords` query parameter to have results with the most matched words first.
1062
1063
*`proximity`: Sort according to the proximity of the query words in hits.
1063
-
*`attribute`: Sort according to the order of attributes defined by attributesToIndex.
1064
+
*`attribute`: Sort according to the order of attributes defined by searchableAttributes.
1064
1065
*`exact`:
1065
1066
* If the user query contains one word: sort objects having an attribute that is exactly the query word before others. For example, if you search for the TV show "V", you want to find it with the "V" query and avoid getting all popular TV shows starting by the letter V before it.
1066
1067
* If the user query contains multiple words: sort according to the number of words that matched exactly (not as a prefix).
@@ -1088,11 +1089,12 @@ For example, `"customRanking" => ["desc(population)", "asc(name)"]`.
1088
1089
To get a full description of how the Custom Ranking works,
1089
1090
you can have a look at our [Ranking guide](https://www.algolia.com/doc/guides/relevance/ranking).
1090
1091
1091
-
#### slaves
1092
+
#### replicas
1092
1093
1093
1094
- scope: `settings`
1094
1095
- type: `array of strings`
1095
1096
- default: `[]`
1097
+
- formerly known as: `slaves`
1096
1098
1097
1099
1098
1100
The list of indices on which you want to replicate all write operations.
@@ -1103,7 +1105,7 @@ If you want to use different ranking configurations depending of the use case,
1103
1105
you need to create one index per ranking configuration.
1104
1106
1105
1107
This option enables you to perform write operations only on this index and automatically
1106
-
update slave indices with the same operations.
1108
+
update replica indices with the same operations.
1107
1109
1108
1110
### Filtering / Faceting
1109
1111
@@ -1375,7 +1377,7 @@ If set to true, plural won't be considered as a typo. For example, car and cars,
1375
1377
1376
1378
1377
1379
List of attributes on which you want to disable typo tolerance
1378
-
(must be a subset of the `attributesToIndex` index setting).
1380
+
(must be a subset of the `searchableAttributes` index setting).
1379
1381
1380
1382
Attributes are separated with a comma such as `"name,address"`.
1381
1383
You can also use JSON string array encoding such as `encodeURIComponent("[\"name\",\"address\"]")`.
@@ -1633,7 +1635,7 @@ For most use cases, it is better to not use this feature as people search by key
1633
1635
1634
1636
1635
1637
List of attributes on which you want to disable prefix matching
1636
-
(must be a subset of the `attributesToIndex` index setting).
1638
+
(must be a subset of the `searchableAttributes` index setting).
1637
1639
1638
1640
This setting is useful on attributes that contain string that should not be matched as a prefix
1639
1641
(for example a product SKU).
@@ -1647,7 +1649,7 @@ This setting is useful on attributes that contain string that should not be matc
1647
1649
1648
1650
1649
1651
List of attributes on which you want to disable the computation of `exact` criteria
1650
-
(must be a subset of the `attributesToIndex` index setting).
1652
+
(must be a subset of the `searchableAttributes` index setting).
1651
1653
1652
1654
#### exactOnSingleWordQuery
1653
1655
@@ -1727,11 +1729,12 @@ you can have a look at our [guide on distinct](https://www.algolia.com/doc/searc
1727
1729
If set to true,
1728
1730
the result hits will contain ranking information in the **_rankingInfo** attribute.
1729
1731
1730
-
#### numericAttributesToIndex
1732
+
#### numericAttributesForFiltering
1731
1733
1732
1734
- scope: `settings`
1733
1735
- type: `array of strings`
1734
1736
- default: ``
1737
+
- formerly known as: `numericAttributesToIndex`
1735
1738
1736
1739
1737
1740
All numerical attributes are automatically indexed as numerical filters
@@ -1994,21 +1997,21 @@ The move_index method will overwrite the destination index, and delete the tempo
1994
1997
**Warning**
1995
1998
1996
1999
The move_index operation will override all settings of the destination,
1997
-
There is one exception for the [slaves](#slaves) parameter which is not impacted.
2000
+
There is one exception for the [replicas](#replicas) parameter which is not impacted.
1998
2001
1999
2002
For example, if you want to fully update your index `MyIndex` every night, we recommend the following process:
2000
2003
2001
2004
1. Get settings and synonyms from the old index using [Get settings](#get-settings---get_settings)
2002
2005
and [Get synonym](#get-synonym---get_synonym).
2003
2006
1. Apply settings and synonyms to the temporary index `MyTmpIndex`, (this will create the `MyTmpIndex` index)
2004
2007
using [Set settings](#set-settings) and [Batch synonyms](#batch-synonyms---batch_synonyms)
2005
-
(make sure to remove the [slaves](#slaves) parameter from the settings if it exists).
2008
+
(make sure to remove the [replicas](#replicas) parameter from the settings if it exists).
2006
2009
1. Import your records into a new index using [Add objects](#add-objects---add_objects).
2007
2010
1. Atomically replace the index `MyIndex` with the content and settings of the index `MyTmpIndex`
2008
2011
using the [Move index](#move-index---move_index) method.
2009
2012
This will automatically override the old index without any downtime on the search.
2010
2013
1. You'll end up with only one index called `MyIndex`, that contains the records and settings pushed to `MyTmpIndex`
2011
-
and the slave-indices that were initially attached to `MyIndex` will be in sync with the new data.
2014
+
and the replica-indices that were initially attached to `MyIndex` will be in sync with the new data.
0 commit comments