API Reference / API Methods / Settings / Set settings

Set Settings

Required API Key: any key with the editSettings ACL
Method signature
$index->setSettings(array settings)

$index->setSettings(array settings, [
  // All the following parameters are optional
  'forwardToReplicas' => bool
])

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

Create or change an index’s settings.

Only specified settings are overridden; unspecified settings are left unchanged. Specifying null for a setting resets it to its default value.

The supported settings are listed in the Settings Parameters page.

Performance wise, it’s better to set settings before pushing the data.

Examples

Simple set settings

1
2
3
4
5
$index->setSettings(
  [
    'customRanking' => ['desc(followers)']
  ]
);

Set setting and forward to replicas

1
2
3
4
5
6
7
8
9
10
11
$forwardToReplicas = true;

$index->setSettings(
  [
    'searchableAttributes' => ['name', 'address'],
    'customRanking' => ['desc(followers)'],
  ],
  [
    'forwardToReplicas' => $forwardToReplicas
  ]
);

Parameters

settings
type: key/value mapping
Required

A mapping of settings parameters you can use on an index.

forwardToReplicas
type: boolean
default: false
Optional

Whether to forward the same settings to the replica indices.

Note: when forwarding settings, please make sure your replicas already exist. It’s impossible to forward settings and create your replicas at the same time.

requestOptions
type: key/value mapping
default: No request options
Optional

A mapping of request options to send along with the query.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

1
2
3
4
{
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}
updatedAt
string

Date at which the indexing job has been created.

taskID
integer

The taskID used with the waitTask method.

Did you find this page helpful?