Set GSI Settings
To set the global secondary index settings use POST /settings/indexes
.
Description
This endpoint is used to update the global secondary index settings for the cluster. The request is handled and validated by the cluster manager and then delegated to all relevant index nodes automatically. All changes to the index settings via this method apply to all index nodes in the cluster. Parameters which are not specified are left unchanged, it is not necessary to specify all parameters in the body.
Body Parameters
All of the following parameters are passed in the request body as application/x-www-form-urlencoded
data.
The parameters are specified as key-value pairs (e.g key=value
).
Optional
Name | Description | Type |
---|---|---|
|
Number of threads for the |
integer |
|
Indexer logging level. |
Possible values are:
|
|
Maximum number of committed rollback points. |
integer |
|
InMemory snapshotting interval in milliseconds. |
integer |
|
Persisted snapshotting interval in milliseconds. |
integer |
|
The storage mode to be used for all global secondary indexes in the cluster.* A value of |
Possible values are:
|
-
Plasma
andmemory_optimized
are options in the Enterprise Edition of Couchbase Server 5.5. If you are using the Community Edition, the default (and only) value isforestdb
.
Response Codes
Response Code | Description |
---|---|
200 |
Success. Settings are updated and the new settings are returned in the response. |
401 |
Unauthorized. |
Sample Curl Command
The following example sets the global secondary index settings.
curl -X POST -u 'Administrator:password' 'http://localhost:8091/settings/indexes' -d 'indexerThreads=0' -d 'logLevel=info' -d 'maxRollbackPoints=5' -d 'memorySnapshotInterval=200' -d 'stableSnapshotInterval=5000' -d 'storageMode=forestdb'