API client / Methods / Settings

Jun. 08, 2023

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
])

index.set_settings(Hash settings)

index.set_settings(Hash settings, Hash opts = {
  bool forwardToReplicas: false
  # any requestOptions
}

index.setSettings(object settings)
index.setSettings(object settings, {
  // All the following parameters are optional
  forwardToReplicas: boolean
  // any requestOptions
})

index.set_settings(dict settings)

index.set_settings(dict settings, {
    // All the following parameters are optional
    'forwardToReplicas': bool
})

index.setSettings(
  _ settings: Settings,
  resetToDefault: [Settings.Key] = [],
  forwardToReplicas: Bool? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<IndexRevision>> -> Void
)

suspend fun Index.setSettings(
    settings: Settings,
    resetToDefault: List<SettingsKey> = listOf(),
    forwardToReplicas: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

index.SetSettings(
  IndexSettings settings,

  // All the following parameters are optional
  forwardToReplicas: bool
)

index.setSettings(
  IndexSettings settings,
  Boolean forwardToReplicas
)

index.SetSettings(IndexSettings settings)
index.SetSettings(
  IndexSettings settings,
  opt.ForwardToReplicas(forwardToReplicas),
)

setSettings.of("myIndex").with(settings)
setSettings.of("myIndex").with(settings).and(forwardToReplicas)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

About this method

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 refererence.

Performance wise, it’s better to set settings before pushing the data. For best performance, change the settings before you add records to your index.

Examples

Read the Algolia CLI documentation for more information.

Set settings

Copy

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

1
2
3
4
5
6
7
8
9
let settings = Settings()
  .set(\.searchableAttributes, to: [.default(["name", "address"])])
  .set(\.customRanking, to: [.desc("followers")])

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

1
2
3
4
5
6
7
8
9
10
11
val settings = settings {
    searchableAttributes {
        +"name"
        +"address"
    }
    customRanking {
        +Desc("followers")
    }
}

index.setSettings(settings)

1
2
3
4
5
6
7
8
9
10
IndexSettings settings = new IndexSettings
{
  SearchableAttributes = new List<string> { "name", "address" },
  CustomRanking = new List<string> { "desc(followers)" }
};

index.SetSettings(settings);

// Asynchronous
await index.SetSettingsAsync(settings);

1
2
3
4
5
6
7
8
9
10
11
index.setSettings(
  new IndexSettings()
    .setSearchableAttributes(Arrays.asList("name", "address"))
    .setCustomRanking(Collections.singletonList("desc(followers)"))
);

// Asynchronous
index.setSettingsAsync(
  new IndexSettings()
    .setCustomRanking(Collections.singletonList("desc(followers)"))
);

1
2
3
4
5
settings := search.Settings{
	SearchableAttributes: opt.SearchableAttributes("name", "address"),
  CustomRanking: opt.CustomRanking("desc(followers)"),
}
res, err := index.SetSettings(settings)

1
2
3
4
5
6
7
8
9
10
11
client.execute {
  setSettings of "YourIndexName" `with` IndexSettings(
    searchableAttributes = Some(
      Seq(
        SearchableAttributes.attributes("name"),
        SearchableAttributes.attributes("address")
      )
    ),
    customRanking = Some(Seq(CustomRanking.desc("followers")))
  )
}

1
2
3
4
5
6
algolia settings set <INDEX> \
        --searchable-attributes "name,address" \
        --custom-ranking "desc(followers)"

# import settings from JSON file
algolia settings import <INDEX> --file settings.json

Set settings and forward to replicas

Copy

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

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

1
2
3
4
5
6
7
8
index.setSettings({
   'searchableAttributes': ['name', 'address'],
   'customRanking': ['desc(followers)']
 }, {
   forwardToReplicas: true
 }).then(() => {
   // done
 });

1
2
3
4
5
6
7
8
9
let settings = Settings()
  .set(\.searchableAttributes, to: [.default(["name", "address"])])
  .set(\.customRanking, to: [.desc("followers")])

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

1
2
3
4
5
6
7
8
9
10
11
val settings = settings {
    searchableAttributes {
        +"name"
        +"address"
    }
    customRanking {
        +Desc("followers")
    }
}

index.setSettings(settings, forwardToReplicas = true)

1
2
3
4
5
6
7
8
9
10
IndexSettings settings = new IndexSettings
{
  SearchableAttributes = new List<string> { "name", "adress" },
  CustomRanking = new List<string> { "desc(followers)" }
};

index.SetSettings(settings, forwardToReplicas: true);

// Asynchronous
await index.SetSettingsAsync(settings, forwardToReplicas: true);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
index.setSettings(
  new IndexSettings()
    .setSearchableAttributes(Arrays.asList("name", "address"))
    .setCustomRanking(Collections.singletonList("desc(followers)")),
    forwardToReplicas: true
);

// Asynchronous
index.setSettingsAsync(
  new IndexSettings()
    .setSearchableAttributes(Arrays.asList("name", "address"))
    .setCustomRanking(Collections.singletonList("desc(followers)")),
    forwardToReplicas: true
);

1
2
3
4
5
settings := search.Settings{
  SearchableAttributes: opt.SearchableAttributes("name", "address"),
  CustomRanking: opt.CustomRanking("desc(followers)"),
}
res, err := index.SetSettings(settings, opt.ForwardToReplicas(true))

1
2
3
4
5
6
7
8
9
10
11
12
client.execute {
  setSettings of "YourIndexName" `with` IndexSettings(
    searchableAttributes = Some(
      Seq(
        SearchableAttributes.attributes("name"),
        SearchableAttributes.attributes("address")
      )
    ),
    customRanking = Some(Seq(CustomRanking.desc("followers"))),
    forwardToReplicas = Some(forwardToReplicas.`true`)
  )
}

Parameters

Parameter	Description
`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 `requestOptions` to send along with the query.

Response

This section shows the JSON response returned by the API. Each API client encapsulates this response inside objects specific to the programming language, so that the actual response might be different. You can view the response by using the getLogs method. Don’t rely on the order of attributes in the response, as JSON doesn’t guarantee the ordering of keys in objects.

JSON format

Copy

          {
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

        

Field	Description
`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?

Set settings

About this method

Examples

Set settings

Set settings and forward to replicas

Parameters

Response

JSON format

On this page