Skip to content

Commit de20885

Browse files
simon-dewsarahlwelton
authored andcommitted
DOC-13306: Add documentation for indexer level scan timeout (#399)
* Replace Defer Index Builds example with link * Replace Indexer Scan Timeout example with link
1 parent e0049db commit de20885

File tree

2 files changed

+6
-34
lines changed

2 files changed

+6
-34
lines changed

modules/n1ql/pages/n1ql-language-reference/createindex.adoc

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -429,25 +429,8 @@ In Couchbase Server 7.6.2 and later, you can change the default setting for the
429429

430430
If you change the default setting for `defer_build` to `true`, index creation operates in deferred build mode by default.
431431

432-
To change the default setting for deferred builds, use the REST API to set the `indexer.settings.defer_build` property.
433-
For example,
434-
435-
[source,sh]
436-
----
437-
curl http://$BASEURL:9102/settings -u $USER:$PASSWORD \
438-
-d '{"indexer.settings.defer_build": true}'
439-
----
440-
441-
Use the following command to retrieve the indexer settings:
442-
443-
[source,sh]
444-
----
445-
curl -X GET http://$BASEURL:9102/settings -u $USER:$PASSWORD
446-
----
447-
448-
* `$BASEURL` is the base URL for the API call, for example: `localhost`.
449-
* `$USER` is the username, for example: `Administrator`.
450-
* `$PASSWORD` is the password.
432+
To change the default setting for deferred builds, use the Index Settings REST API to set the `indexer.settings.defer_build` property.
433+
For an example, see xref:index-rest-settings:index.adoc#ex-defer-build[Defer Index Builds by Default].
451434
endif::flag-devex-rest-api[]
452435

453436
== Examples

modules/n1ql/pages/n1ql-language-reference/insert.adoc

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -379,22 +379,11 @@ The INSERT statement returns an error if the keyspace does not exist.
379379
If you are inserting multiple documents, the statement aborts at the first error encountered.
380380
* Timeouts can affect the completion of an INSERT statement, especially when performing bulk inserts.
381381
Ensure that the timeout is set to a reasonable value that allows the bulk insert operation to complete.
382+
ifdef::flag-devex-rest-api[]
382383
+
383-
To set the indexer timeout, use the REST API to set the `indexer.settings.scan_timeout` property.
384-
For example,
385-
+
386-
[source,sh]
387-
----
388-
curl http://localhost:9102/settings -u Administrator:password \
389-
-d '{"indexer.settings.scan_timeout": 1200}'
390-
----
391-
+
392-
Use the following command to retrieve the indexer settings:
393-
+
394-
[source,sh]
395-
----
396-
curl -X GET http://localhost:9102/settings -u Administrator:password
397-
----
384+
To set the indexer timeout, use the Index Settings REST API to set the `indexer.settings.scan_timeout` property.
385+
For an example, see xref:index-rest-settings:index.adoc#ex-scan-timeout[Set the Indexer Scan Timeout].
386+
endif::flag-devex-rest-api[]
398387

399388
* When inserting multiple documents, no cleanup or rollback is done for the already inserted documents if the INSERT operations hits an error.
400389
This means, when you are inserting 10 documents, if the INSERT operation fails when inserting the 6th document, the operator quits and exits.

0 commit comments

Comments
 (0)