diff --git a/doc/7/controllers/auth/check-rights/index.md b/doc/7/controllers/auth/check-rights/index.md index 12e90a6e1..78e62b4c4 100644 --- a/doc/7/controllers/auth/check-rights/index.md +++ b/doc/7/controllers/auth/check-rights/index.md @@ -15,13 +15,13 @@ Checks if the provided API request can be executed by the current logged user. --- ```js -checkRights(requestPayload) +checkRights(requestPayload, [options]) ``` | Property | Type | Description | | ---------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `requestPayload` | 
object
| Contains a [RequestPayload](/core/2/api/payloads/request) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `requestPayload` | 
object
| Contains a [RequestPayload](/core/2/api/payloads/request) +| `options` | 
object
| Query options | ## `requestPayload` @@ -31,7 +31,13 @@ The [RequestPayload](/core/2/api/payloads/request) must contains at least the fo - `action`: API action --- +### options +| Property | Type
(default) | Description | +| --- | --- | --- | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves A boolean telling whether the provided request would have been allowed or not. diff --git a/doc/7/controllers/auth/check-token/index.md b/doc/7/controllers/auth/check-token/index.md index 66d46550a..62bd151c2 100644 --- a/doc/7/controllers/auth/check-token/index.md +++ b/doc/7/controllers/auth/check-token/index.md @@ -22,14 +22,16 @@ checkToken([token]); | Property | Type | Description | | -------- | ----------------- | ----------- | | `token` | 
string
| Optional authentication token | - +| `options` | 
object
| Query options | ### options Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/create-api-key/index.md b/doc/7/controllers/auth/create-api-key/index.md index 1a747800a..ddc9398b9 100644 --- a/doc/7/controllers/auth/create-api-key/index.md +++ b/doc/7/controllers/auth/create-api-key/index.md @@ -35,7 +35,9 @@ Additional query options | `expiresIn` | 
string/number

(`-1`) | Expiration duration | | `_id` | 
string

(`null`) | API key unique ID | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | **Notes**: - `expiresIn`: diff --git a/doc/7/controllers/auth/create-my-credentials/index.md b/doc/7/controllers/auth/create-my-credentials/index.md index f55097eac..1b19600ae 100644 --- a/doc/7/controllers/auth/create-my-credentials/index.md +++ b/doc/7/controllers/auth/create-my-credentials/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/credentials-exist/index.md b/doc/7/controllers/auth/credentials-exist/index.md index fcfcbfb40..05cd7b436 100644 --- a/doc/7/controllers/auth/credentials-exist/index.md +++ b/doc/7/controllers/auth/credentials-exist/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/delete-api-key/index.md b/doc/7/controllers/auth/delete-api-key/index.md index 570b7ba0f..6a108aa7d 100644 --- a/doc/7/controllers/auth/delete-api-key/index.md +++ b/doc/7/controllers/auth/delete-api-key/index.md @@ -33,7 +33,9 @@ Additional query options | Property | Type
(default) | Description | | --------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/delete-my-credentials/index.md b/doc/7/controllers/auth/delete-my-credentials/index.md index 2860ff00e..d2c6fe4a8 100644 --- a/doc/7/controllers/auth/delete-my-credentials/index.md +++ b/doc/7/controllers/auth/delete-my-credentials/index.md @@ -32,8 +32,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-current-user/index.md b/doc/7/controllers/auth/get-current-user/index.md index 6e822fe86..ce2ee35a9 100644 --- a/doc/7/controllers/auth/get-current-user/index.md +++ b/doc/7/controllers/auth/get-current-user/index.md @@ -27,8 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-my-credentials/index.md b/doc/7/controllers/auth/get-my-credentials/index.md index 3c3f768cf..77c582b29 100644 --- a/doc/7/controllers/auth/get-my-credentials/index.md +++ b/doc/7/controllers/auth/get-my-credentials/index.md @@ -32,8 +32,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-my-rights/index.md b/doc/7/controllers/auth/get-my-rights/index.md index 67fd097c2..592e0dfcb 100644 --- a/doc/7/controllers/auth/get-my-rights/index.md +++ b/doc/7/controllers/auth/get-my-rights/index.md @@ -28,7 +28,8 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/get-strategies/index.md b/doc/7/controllers/auth/get-strategies/index.md index d1ee9f2d5..ce9e727ba 100644 --- a/doc/7/controllers/auth/get-strategies/index.md +++ b/doc/7/controllers/auth/get-strategies/index.md @@ -28,7 +28,8 @@ Additional query options | Property | Type | Description | Default | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/refresh-token/index.md b/doc/7/controllers/auth/refresh-token/index.md index a74718431..6423ec02a 100644 --- a/doc/7/controllers/auth/refresh-token/index.md +++ b/doc/7/controllers/auth/refresh-token/index.md @@ -36,8 +36,9 @@ Additional query options | Property | Type
(default) | Description | | ----------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `expiresIn` | 
string
| Expiration time in [ms library](https://www.npmjs.com/package/ms) format. (e.g. `2h`) | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ### expiresIn diff --git a/doc/7/controllers/auth/search-api-keys/index.md b/doc/7/controllers/auth/search-api-keys/index.md index 6197e44fd..5f08984c9 100644 --- a/doc/7/controllers/auth/search-api-keys/index.md +++ b/doc/7/controllers/auth/search-api-keys/index.md @@ -50,7 +50,9 @@ Additional query options | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/update-my-credentials/index.md b/doc/7/controllers/auth/update-my-credentials/index.md index 4f2106384..135baff74 100644 --- a/doc/7/controllers/auth/update-my-credentials/index.md +++ b/doc/7/controllers/auth/update-my-credentials/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/update-self/index.md b/doc/7/controllers/auth/update-self/index.md index f18e6120b..cf353daf3 100644 --- a/doc/7/controllers/auth/update-self/index.md +++ b/doc/7/controllers/auth/update-self/index.md @@ -30,8 +30,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/auth/validate-my-credentials/index.md b/doc/7/controllers/auth/validate-my-credentials/index.md index 3f1f57521..ea463edb5 100644 --- a/doc/7/controllers/auth/validate-my-credentials/index.md +++ b/doc/7/controllers/auth/validate-my-credentials/index.md @@ -31,8 +31,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/bulk/delete-by-query/index.md b/doc/7/controllers/bulk/delete-by-query/index.md index b8ce33c50..c8054451b 100644 --- a/doc/7/controllers/bulk/delete-by-query/index.md +++ b/doc/7/controllers/bulk/delete-by-query/index.md @@ -31,9 +31,10 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/bulk/import/index.md b/doc/7/controllers/bulk/import/index.md index 211dd692d..a5c644d64 100644 --- a/doc/7/controllers/bulk/import/index.md +++ b/doc/7/controllers/bulk/import/index.md @@ -60,8 +60,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | --- diff --git a/doc/7/controllers/bulk/mWrite/index.md b/doc/7/controllers/bulk/mWrite/index.md index 8dc11820b..c5fb56746 100644 --- a/doc/7/controllers/bulk/mWrite/index.md +++ b/doc/7/controllers/bulk/mWrite/index.md @@ -45,10 +45,11 @@ Additional query options | Property | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `notify` | 
boolean

(`false`) | if set to true, Kuzzle will trigger realtime notifications | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `notify` | 
boolean

(`false`) | if set to `true`, Kuzzle will trigger realtime notifications | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | --- diff --git a/doc/7/controllers/bulk/update-by-query/index.md b/doc/7/controllers/bulk/update-by-query/index.md index 79c4fe43e..84adea0fb 100644 --- a/doc/7/controllers/bulk/update-by-query/index.md +++ b/doc/7/controllers/bulk/update-by-query/index.md @@ -39,7 +39,9 @@ Additional query options. | Options | Type
(default) | Description | |-----------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------| | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/bulk/write/index.md b/doc/7/controllers/bulk/write/index.md index 3b311bff9..4df7431a2 100644 --- a/doc/7/controllers/bulk/write/index.md +++ b/doc/7/controllers/bulk/write/index.md @@ -40,10 +40,11 @@ Additional query options | Property | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `notify` | 
boolean

(`false`) | if set to true, Kuzzle will trigger realtime notifications | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `notify` | 
boolean

(`false`) | if set to `true`, Kuzzle will trigger realtime notifications | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | --- diff --git a/doc/7/controllers/collection/create/index.md b/doc/7/controllers/collection/create/index.md index 1c6c32ba2..5da48a0cc 100644 --- a/doc/7/controllers/collection/create/index.md +++ b/doc/7/controllers/collection/create/index.md @@ -94,8 +94,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/delete-specifications/index.md b/doc/7/controllers/collection/delete-specifications/index.md index aa110bd2c..090b70159 100644 --- a/doc/7/controllers/collection/delete-specifications/index.md +++ b/doc/7/controllers/collection/delete-specifications/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/delete/index.md b/doc/7/controllers/collection/delete/index.md index dbc16ed11..eba74ee94 100644 --- a/doc/7/controllers/collection/delete/index.md +++ b/doc/7/controllers/collection/delete/index.md @@ -29,7 +29,10 @@ Additional query options | Options | Type
(default) | Description | | --------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolves Resolves if the collection is successfully deleted. diff --git a/doc/7/controllers/collection/exists/index.md b/doc/7/controllers/collection/exists/index.md index 4245f78a3..ca40394c3 100644 --- a/doc/7/controllers/collection/exists/index.md +++ b/doc/7/controllers/collection/exists/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/get-mapping/index.md b/doc/7/controllers/collection/get-mapping/index.md index e6addbd9d..e708c8723 100644 --- a/doc/7/controllers/collection/get-mapping/index.md +++ b/doc/7/controllers/collection/get-mapping/index.md @@ -29,9 +29,10 @@ Additional query options | Property | Type
(default) | Description | | ------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `includeKuzzleMeta` | 
boolean

(`true`) | If true, the returned mappings will contain [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `includeKuzzleMeta` | 
boolean

(`true`) | If `true`, the returned mappings will contain [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/get-specifications/index.md b/doc/7/controllers/collection/get-specifications/index.md index 036331e05..f54c9c1bd 100644 --- a/doc/7/controllers/collection/get-specifications/index.md +++ b/doc/7/controllers/collection/get-specifications/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/list/index.md b/doc/7/controllers/collection/list/index.md index 945095b56..754c201cb 100644 --- a/doc/7/controllers/collection/list/index.md +++ b/doc/7/controllers/collection/list/index.md @@ -29,10 +29,11 @@ Additional query options | Property | Type
(default) | Description | |------------|---------------------------------|------------------------------------------------------------------------------| -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first result | | `size` | 
number

(`10`) | Maximum number of returned results | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/refresh/index.md b/doc/7/controllers/collection/refresh/index.md index 306f68252..ffaf90ccc 100644 --- a/doc/7/controllers/collection/refresh/index.md +++ b/doc/7/controllers/collection/refresh/index.md @@ -35,8 +35,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/search-specifications/index.md b/doc/7/controllers/collection/search-specifications/index.md index b1dfbe297..eb2b765a6 100644 --- a/doc/7/controllers/collection/search-specifications/index.md +++ b/doc/7/controllers/collection/search-specifications/index.md @@ -56,11 +56,12 @@ const body = { | `from` | 
number

(`0`) | Offset of the first document | | `size` | 
number

(`10`) | Maximum number of documents returned | | `scroll` | 
string

| Maximum duration for scroll session | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | - `size` controls the maximum number of documents returned in the response - `from` is usually used with the `size` argument, and defines the offset from the first result you want to fetch - `scroll` is used to fetch large result sets, and it must be set with a [time duration](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units). If set, a forward-only cursor will be created (and automatically destroyed at the end of the set duration), and its identifier will be returned in the `scrollId` property, along with the first page of the results. +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/truncate/index.md b/doc/7/controllers/collection/truncate/index.md index f5bc2fabf..59ab722d0 100644 --- a/doc/7/controllers/collection/truncate/index.md +++ b/doc/7/controllers/collection/truncate/index.md @@ -29,8 +29,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/update-mapping/index.md b/doc/7/controllers/collection/update-mapping/index.md index f70b74dc7..3f164da33 100644 --- a/doc/7/controllers/collection/update-mapping/index.md +++ b/doc/7/controllers/collection/update-mapping/index.md @@ -58,8 +58,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/update-specifications/index.md b/doc/7/controllers/collection/update-specifications/index.md index 60e023dc4..fe10ada70 100644 --- a/doc/7/controllers/collection/update-specifications/index.md +++ b/doc/7/controllers/collection/update-specifications/index.md @@ -47,8 +47,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/collection/update/index.md b/doc/7/controllers/collection/update/index.md index d32c1f177..728f88e81 100644 --- a/doc/7/controllers/collection/update/index.md +++ b/doc/7/controllers/collection/update/index.md @@ -39,9 +39,10 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | diff --git a/doc/7/controllers/collection/validate-specifications/index.md b/doc/7/controllers/collection/validate-specifications/index.md index 8d5330fba..f3992c957 100644 --- a/doc/7/controllers/collection/validate-specifications/index.md +++ b/doc/7/controllers/collection/validate-specifications/index.md @@ -47,8 +47,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/count/index.md b/doc/7/controllers/document/count/index.md index 6009911f4..a354b220e 100644 --- a/doc/7/controllers/document/count/index.md +++ b/doc/7/controllers/document/count/index.md @@ -32,8 +32,9 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/create-or-replace/index.md b/doc/7/controllers/document/create-or-replace/index.md index a3993e601..644676059 100644 --- a/doc/7/controllers/document/create-or-replace/index.md +++ b/doc/7/controllers/document/create-or-replace/index.md @@ -31,10 +31,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/create/index.md b/doc/7/controllers/document/create/index.md index 12ab163b7..7cf6e09c4 100644 --- a/doc/7/controllers/document/create/index.md +++ b/doc/7/controllers/document/create/index.md @@ -33,10 +33,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/delete-by-query/index.md b/doc/7/controllers/document/delete-by-query/index.md index 33deb4c08..d498df11f 100644 --- a/doc/7/controllers/document/delete-by-query/index.md +++ b/doc/7/controllers/document/delete-by-query/index.md @@ -42,11 +42,12 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | `source` | 
boolean
| if set to `true` Kuzzle will return each deleted document body in the response | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/delete-fields/index.md b/doc/7/controllers/document/delete-fields/index.md index 3d513d3a8..2e9c12bdc 100644 --- a/doc/7/controllers/document/delete-fields/index.md +++ b/doc/7/controllers/document/delete-fields/index.md @@ -31,11 +31,12 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | `source` | 
boolean

(`false`) | If `true`, then the response will contain the updated document | | `timeout` | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/delete/index.md b/doc/7/controllers/document/delete/index.md index c568a8980..81a425615 100644 --- a/doc/7/controllers/document/delete/index.md +++ b/doc/7/controllers/document/delete/index.md @@ -30,10 +30,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/exists/index.md b/doc/7/controllers/document/exists/index.md index a14bd21b8..e22331363 100644 --- a/doc/7/controllers/document/exists/index.md +++ b/doc/7/controllers/document/exists/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/get/index.md b/doc/7/controllers/document/get/index.md index 4d852ef88..5f961bf0d 100644 --- a/doc/7/controllers/document/get/index.md +++ b/doc/7/controllers/document/get/index.md @@ -28,8 +28,9 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-create-or-replace/index.md b/doc/7/controllers/document/m-create-or-replace/index.md index ba2402e6f..802db10c2 100644 --- a/doc/7/controllers/document/m-create-or-replace/index.md +++ b/doc/7/controllers/document/m-create-or-replace/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-create/index.md b/doc/7/controllers/document/m-create/index.md index b9868ada8..5597ae0a8 100644 --- a/doc/7/controllers/document/m-create/index.md +++ b/doc/7/controllers/document/m-create/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-delete/index.md b/doc/7/controllers/document/m-delete/index.md index 198a7973b..f2a48e5a6 100644 --- a/doc/7/controllers/document/m-delete/index.md +++ b/doc/7/controllers/document/m-delete/index.md @@ -30,10 +30,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-get/index.md b/doc/7/controllers/document/m-get/index.md index 93ccc8334..5ada625a1 100644 --- a/doc/7/controllers/document/m-get/index.md +++ b/doc/7/controllers/document/m-get/index.md @@ -29,9 +29,10 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `verb` | 
string
| (HTTP only) Forces the verb of the route | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | #### verb diff --git a/doc/7/controllers/document/m-replace/index.md b/doc/7/controllers/document/m-replace/index.md index cd8448f01..24c7eec21 100644 --- a/doc/7/controllers/document/m-replace/index.md +++ b/doc/7/controllers/document/m-replace/index.md @@ -28,10 +28,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-update/index.md b/doc/7/controllers/document/m-update/index.md index 7b026a6d1..af5fe3179 100644 --- a/doc/7/controllers/document/m-update/index.md +++ b/doc/7/controllers/document/m-update/index.md @@ -32,11 +32,12 @@ Additional query options | Options | Type
(default) | Description | | ----------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`0`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/m-upsert/index.md b/doc/7/controllers/document/m-upsert/index.md index 3c5b36c6e..f8e2bbb19 100644 --- a/doc/7/controllers/document/m-upsert/index.md +++ b/doc/7/controllers/document/m-upsert/index.md @@ -60,10 +60,12 @@ Additional query options | Options | Type
(default) | Description | |-------------------|----------------------------------|------------------------------------------------------------------------------------------| -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`0`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/replace/index.md b/doc/7/controllers/document/replace/index.md index e8105ace2..16ce7afa9 100644 --- a/doc/7/controllers/document/replace/index.md +++ b/doc/7/controllers/document/replace/index.md @@ -29,10 +29,11 @@ Additional query options | Options | Type
(default) | Description | | ---------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/search/index.md b/doc/7/controllers/document/search/index.md index 6e2a0860c..27271947e 100644 --- a/doc/7/controllers/document/search/index.md +++ b/doc/7/controllers/document/search/index.md @@ -47,13 +47,14 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `scroll` | 
string

(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | | `verb` | 
string
| (HTTP only) Forces the verb of the route | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | #### verb diff --git a/doc/7/controllers/document/update-by-query/index.md b/doc/7/controllers/document/update-by-query/index.md index 4d8d5ccd1..b495bab37 100644 --- a/doc/7/controllers/document/update-by-query/index.md +++ b/doc/7/controllers/document/update-by-query/index.md @@ -47,8 +47,11 @@ Additional query options. | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | -| `source` | 
boolean

(`false`) | If true, returns the updated document inside the response | +| `source` | 
boolean

(`false`) | If `true`, returns the updated document inside the response | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolves Returns an object containing 2 arrays: `successes` and `errors` @@ -57,7 +60,7 @@ Each updated document is an object of the `successes` array with the following p | Property | Type | Description | | ---------- | --------------------------------- | ------------------------------------------------------ | -| `_source` | 
object
| Updated document (if `source` option set to true) | +| `_source` | 
object
| Updated document (if `source` option set to `true`) | | `_id` | 
string
| ID of the udated document | | `_version` | 
number
| Version of the document in the persistent data storage | | `status` | 
number
| HTTP status code | diff --git a/doc/7/controllers/document/update/index.md b/doc/7/controllers/document/update/index.md index 68aa416fe..450774a5d 100644 --- a/doc/7/controllers/document/update/index.md +++ b/doc/7/controllers/document/update/index.md @@ -32,12 +32,13 @@ Additional query options | Options | Type
(default) | Description | | ----------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`0`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | -| `source` | 
boolean

(`false`) | If true, returns the updated document inside the response | +| `source` | 
boolean

(`false`) | If `true`, returns the updated document inside the response | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/upsert/index.md b/doc/7/controllers/document/upsert/index.md index 468414465..50102e376 100644 --- a/doc/7/controllers/document/upsert/index.md +++ b/doc/7/controllers/document/upsert/index.md @@ -34,8 +34,10 @@ Additional query options | `refresh` | 
string

(`""`) | If set to `wait_for`, waits for the change to be reflected for `search` (up to 1s) | | `retryOnConflict` | 
int

(`10`) | The number of times the database layer should retry in case of version conflict | | `silent` | 
boolean

(`false`) | If `true`, then Kuzzle will not generate notifications | -| `source` | 
boolean

(`false`) | If true, returns the updated document inside the response | +| `source` | 
boolean

(`false`) | If `true`, returns the updated document inside the response | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/document/validate/index.md b/doc/7/controllers/document/validate/index.md index a6a8d4f9f..192e79ead 100644 --- a/doc/7/controllers/document/validate/index.md +++ b/doc/7/controllers/document/validate/index.md @@ -32,12 +32,13 @@ Additional query options | Options | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves -Resolves to a boolean value set to true if the document is valid and false otherwise. +Resolves to a boolean value set to `true` if the document is valid and false otherwise. ## Usage diff --git a/doc/7/controllers/index/create/index.md b/doc/7/controllers/index/create/index.md index c96860cf4..db31aabe4 100644 --- a/doc/7/controllers/index/create/index.md +++ b/doc/7/controllers/index/create/index.md @@ -34,8 +34,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/delete/index.md b/doc/7/controllers/index/delete/index.md index 0afc22970..bf6cd3baa 100644 --- a/doc/7/controllers/index/delete/index.md +++ b/doc/7/controllers/index/delete/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/exists/index.md b/doc/7/controllers/index/exists/index.md index 571177c78..89e34823d 100644 --- a/doc/7/controllers/index/exists/index.md +++ b/doc/7/controllers/index/exists/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/list/index.md b/doc/7/controllers/index/list/index.md index 8f41681bf..b19907a2c 100644 --- a/doc/7/controllers/index/list/index.md +++ b/doc/7/controllers/index/list/index.md @@ -27,8 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/m-delete/index.md b/doc/7/controllers/index/m-delete/index.md index ff7c4a1f3..464819224 100644 --- a/doc/7/controllers/index/m-delete/index.md +++ b/doc/7/controllers/index/m-delete/index.md @@ -28,8 +28,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/index/stats/index.md b/doc/7/controllers/index/stats/index.md index eef6c7b58..cc1892122 100644 --- a/doc/7/controllers/index/stats/index.md +++ b/doc/7/controllers/index/stats/index.md @@ -30,8 +30,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/ms/append/index.md b/doc/7/controllers/ms/append/index.md index bf8994f93..a0071a913 100644 --- a/doc/7/controllers/ms/append/index.md +++ b/doc/7/controllers/ms/append/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/bitcount/index.md b/doc/7/controllers/ms/bitcount/index.md index db719f134..96e26a903 100644 --- a/doc/7/controllers/ms/bitcount/index.md +++ b/doc/7/controllers/ms/bitcount/index.md @@ -30,8 +30,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `end` | 
integer
| Count ends at the provided offset | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `start` | 
integer
| Count starts at the provided offset | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/bitop/index.md b/doc/7/controllers/ms/bitop/index.md index 60a5eb03f..ea5df22f1 100644 --- a/doc/7/controllers/ms/bitop/index.md +++ b/doc/7/controllers/ms/bitop/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/bitpos/index.md b/doc/7/controllers/ms/bitpos/index.md index 1c3ba80db..be25bd4a7 100644 --- a/doc/7/controllers/ms/bitpos/index.md +++ b/doc/7/controllers/ms/bitpos/index.md @@ -31,8 +31,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `end` | 
integer
| Search ends at the provided offset | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `start` | 
integer
| Search starts at the provided offset | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/dbsize/index.md b/doc/7/controllers/ms/dbsize/index.md index 24d1c804d..ee8883699 100644 --- a/doc/7/controllers/ms/dbsize/index.md +++ b/doc/7/controllers/ms/dbsize/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/decr/index.md b/doc/7/controllers/ms/decr/index.md index 9492718e1..a6903b5c5 100644 --- a/doc/7/controllers/ms/decr/index.md +++ b/doc/7/controllers/ms/decr/index.md @@ -29,7 +29,8 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again || [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/decrby/index.md b/doc/7/controllers/ms/decrby/index.md index 1a5301d88..891d07049 100644 --- a/doc/7/controllers/ms/decrby/index.md +++ b/doc/7/controllers/ms/decrby/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/del/index.md b/doc/7/controllers/ms/del/index.md index ce4ad6873..cfeaa8c9b 100644 --- a/doc/7/controllers/ms/del/index.md +++ b/doc/7/controllers/ms/del/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/exists/index.md b/doc/7/controllers/ms/exists/index.md index ce8355dc8..e91266d6c 100644 --- a/doc/7/controllers/ms/exists/index.md +++ b/doc/7/controllers/ms/exists/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/expire/index.md b/doc/7/controllers/ms/expire/index.md index 0c34e8d80..168190a43 100644 --- a/doc/7/controllers/ms/expire/index.md +++ b/doc/7/controllers/ms/expire/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/expireat/index.md b/doc/7/controllers/ms/expireat/index.md index 0995e3b00..d0705eb7c 100644 --- a/doc/7/controllers/ms/expireat/index.md +++ b/doc/7/controllers/ms/expireat/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/flushdb/index.md b/doc/7/controllers/ms/flushdb/index.md index f0c7cd774..5e3ab3022 100644 --- a/doc/7/controllers/ms/flushdb/index.md +++ b/doc/7/controllers/ms/flushdb/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geoadd/index.md b/doc/7/controllers/ms/geoadd/index.md index 85899b4f0..dca6ec9a5 100644 --- a/doc/7/controllers/ms/geoadd/index.md +++ b/doc/7/controllers/ms/geoadd/index.md @@ -40,7 +40,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geodist/index.md b/doc/7/controllers/ms/geodist/index.md index 6b07a0ead..6fc1c8897 100644 --- a/doc/7/controllers/ms/geodist/index.md +++ b/doc/7/controllers/ms/geodist/index.md @@ -33,8 +33,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `unit` | 
string ('m')
| The unit used for the returned calculated distance.
Accepted values: `m`, `km`, `mi`, `ft` | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geohash/index.md b/doc/7/controllers/ms/geohash/index.md index 21db80a23..6c0dd9a67 100644 --- a/doc/7/controllers/ms/geohash/index.md +++ b/doc/7/controllers/ms/geohash/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/geopos/index.md b/doc/7/controllers/ms/geopos/index.md index b61345f58..1513f5274 100644 --- a/doc/7/controllers/ms/geopos/index.md +++ b/doc/7/controllers/ms/geopos/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/georadius/index.md b/doc/7/controllers/ms/georadius/index.md index 01b20afa7..676abfbcb 100644 --- a/doc/7/controllers/ms/georadius/index.md +++ b/doc/7/controllers/ms/georadius/index.md @@ -34,10 +34,12 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | -------------------------- | -------------------------------------------------------------------------------------- | | `count` | 
integer
| Limit the number of returned geopoints to the provided value | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
(`false`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `sort` | 
string
| Sort the result by distance, relative to the center.
Allowed values: `ASC`, `DESC` | -| `withcoord` | 
boolean (false)
| Include the position of the matched geopoint in the result | -| `withdist` | 
boolean (false)
| Include the calculated distance from the matched geopoint to center | +| `withcoord` | 
boolean (`false`)
| Include the position of the matched geopoint in the result | +| `withdist` | 
boolean (`false`)
| Include the calculated distance from the matched geopoint to center | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/georadiusbymember/index.md b/doc/7/controllers/ms/georadiusbymember/index.md index e93eb5d57..971eb4f78 100644 --- a/doc/7/controllers/ms/georadiusbymember/index.md +++ b/doc/7/controllers/ms/georadiusbymember/index.md @@ -33,11 +33,12 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | -------------------------- | -------------------------------------------------------------------------------------- | | `count` | 
integer
| Limit the number of returned geopoints to the provided value | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | | `sort` | 
string
| Sort the result by distance, relative to the center.
Allowed values: `ASC`, `DESC` | | `withcoord` | 
boolean (false)
| Include the position of the matched geopoint in the result | | `withdist` | 
boolean (false)
| Include the calculated distance from the matched geopoint to center | - +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to an array of matched geopoints. diff --git a/doc/7/controllers/ms/get/index.md b/doc/7/controllers/ms/get/index.md index c128a9317..c08aaedc2 100644 --- a/doc/7/controllers/ms/get/index.md +++ b/doc/7/controllers/ms/get/index.md @@ -29,8 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the key's value. diff --git a/doc/7/controllers/ms/getbit/index.md b/doc/7/controllers/ms/getbit/index.md index 7a2da9a1d..38ad51c1c 100644 --- a/doc/7/controllers/ms/getbit/index.md +++ b/doc/7/controllers/ms/getbit/index.md @@ -31,8 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the bit at the provided offset (`0` or `1`). diff --git a/doc/7/controllers/ms/getrange/index.md b/doc/7/controllers/ms/getrange/index.md index 735bbe6e3..54b395c44 100644 --- a/doc/7/controllers/ms/getrange/index.md +++ b/doc/7/controllers/ms/getrange/index.md @@ -33,8 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the extracted substring. diff --git a/doc/7/controllers/ms/getset/index.md b/doc/7/controllers/ms/getset/index.md index 2db4e8667..5857e3c26 100644 --- a/doc/7/controllers/ms/getset/index.md +++ b/doc/7/controllers/ms/getset/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the previously set value, or `null` if the key didn't exist prior to this operation. diff --git a/doc/7/controllers/ms/hdel/index.md b/doc/7/controllers/ms/hdel/index.md index 38c1f83ca..09fdb0695 100644 --- a/doc/7/controllers/ms/hdel/index.md +++ b/doc/7/controllers/ms/hdel/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to the number of deleted fields. diff --git a/doc/7/controllers/ms/hexists/index.md b/doc/7/controllers/ms/hexists/index.md index fd1473b39..869c7986f 100644 --- a/doc/7/controllers/ms/hexists/index.md +++ b/doc/7/controllers/ms/hexists/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Resolves to a boolean telling whether the checked field exists or not. diff --git a/doc/7/controllers/ms/hget/index.md b/doc/7/controllers/ms/hget/index.md index 141228e71..9782956db 100644 --- a/doc/7/controllers/ms/hget/index.md +++ b/doc/7/controllers/ms/hget/index.md @@ -30,8 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | - +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve Returns the field's value. diff --git a/doc/7/controllers/ms/hgetall/index.md b/doc/7/controllers/ms/hgetall/index.md index 99de3f6bd..0db03def0 100644 --- a/doc/7/controllers/ms/hgetall/index.md +++ b/doc/7/controllers/ms/hgetall/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hincrby/index.md b/doc/7/controllers/ms/hincrby/index.md index d280835d7..075305042 100644 --- a/doc/7/controllers/ms/hincrby/index.md +++ b/doc/7/controllers/ms/hincrby/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hincrbyfloat/index.md b/doc/7/controllers/ms/hincrbyfloat/index.md index f72b5f865..b3b3aaf15 100644 --- a/doc/7/controllers/ms/hincrbyfloat/index.md +++ b/doc/7/controllers/ms/hincrbyfloat/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hkeys/index.md b/doc/7/controllers/ms/hkeys/index.md index 11d1e5063..c12197dd6 100644 --- a/doc/7/controllers/ms/hkeys/index.md +++ b/doc/7/controllers/ms/hkeys/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hlen/index.md b/doc/7/controllers/ms/hlen/index.md index 06421b8f7..d80e602d0 100644 --- a/doc/7/controllers/ms/hlen/index.md +++ b/doc/7/controllers/ms/hlen/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hmget/index.md b/doc/7/controllers/ms/hmget/index.md index 756ad89bd..59e3e443d 100644 --- a/doc/7/controllers/ms/hmget/index.md +++ b/doc/7/controllers/ms/hmget/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hmset/index.md b/doc/7/controllers/ms/hmset/index.md index 757f061b1..5df53b656 100644 --- a/doc/7/controllers/ms/hmset/index.md +++ b/doc/7/controllers/ms/hmset/index.md @@ -39,7 +39,8 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`triggerEvents`](/sdk/7/core-classe| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |s/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hscan/index.md b/doc/7/controllers/ms/hscan/index.md index 5112e513e..e0e98f688 100644 --- a/doc/7/controllers/ms/hscan/index.md +++ b/doc/7/controllers/ms/hscan/index.md @@ -37,7 +37,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hset/index.md b/doc/7/controllers/ms/hset/index.md index d45888150..d5d96f4c6 100644 --- a/doc/7/controllers/ms/hset/index.md +++ b/doc/7/controllers/ms/hset/index.md @@ -35,7 +35,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hsetnx/index.md b/doc/7/controllers/ms/hsetnx/index.md index f49525e41..c8f47194d 100644 --- a/doc/7/controllers/ms/hsetnx/index.md +++ b/doc/7/controllers/ms/hsetnx/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hstrlen/index.md b/doc/7/controllers/ms/hstrlen/index.md index 23f2ce826..51e973ee9 100644 --- a/doc/7/controllers/ms/hstrlen/index.md +++ b/doc/7/controllers/ms/hstrlen/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/hvals/index.md b/doc/7/controllers/ms/hvals/index.md index 7efa03a56..5b9643f33 100644 --- a/doc/7/controllers/ms/hvals/index.md +++ b/doc/7/controllers/ms/hvals/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/incr/index.md b/doc/7/controllers/ms/incr/index.md index 81ac08daa..a9c47b61a 100644 --- a/doc/7/controllers/ms/incr/index.md +++ b/doc/7/controllers/ms/incr/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/incrby/index.md b/doc/7/controllers/ms/incrby/index.md index fc17f6264..20df8e38a 100644 --- a/doc/7/controllers/ms/incrby/index.md +++ b/doc/7/controllers/ms/incrby/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/incrbyfloat/index.md b/doc/7/controllers/ms/incrbyfloat/index.md index fca7286f8..456ffd853 100644 --- a/doc/7/controllers/ms/incrbyfloat/index.md +++ b/doc/7/controllers/ms/incrbyfloat/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/keys/index.md b/doc/7/controllers/ms/keys/index.md index 53433d409..ecfc35aa1 100644 --- a/doc/7/controllers/ms/keys/index.md +++ b/doc/7/controllers/ms/keys/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lindex/index.md b/doc/7/controllers/ms/lindex/index.md index 2841425a3..742279a05 100644 --- a/doc/7/controllers/ms/lindex/index.md +++ b/doc/7/controllers/ms/lindex/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/linsert/index.md b/doc/7/controllers/ms/linsert/index.md index 5bba89e36..fc638594b 100644 --- a/doc/7/controllers/ms/linsert/index.md +++ b/doc/7/controllers/ms/linsert/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/llen/index.md b/doc/7/controllers/ms/llen/index.md index be28549f7..aee94b8ca 100644 --- a/doc/7/controllers/ms/llen/index.md +++ b/doc/7/controllers/ms/llen/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lpop/index.md b/doc/7/controllers/ms/lpop/index.md index dc2533a33..447e164e7 100644 --- a/doc/7/controllers/ms/lpop/index.md +++ b/doc/7/controllers/ms/lpop/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lpush/index.md b/doc/7/controllers/ms/lpush/index.md index abe0e6fc1..d58e6d213 100644 --- a/doc/7/controllers/ms/lpush/index.md +++ b/doc/7/controllers/ms/lpush/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lpushx/index.md b/doc/7/controllers/ms/lpushx/index.md index 37606192d..390b3e3fd 100644 --- a/doc/7/controllers/ms/lpushx/index.md +++ b/doc/7/controllers/ms/lpushx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lrange/index.md b/doc/7/controllers/ms/lrange/index.md index 1997c0299..b56fc094f 100644 --- a/doc/7/controllers/ms/lrange/index.md +++ b/doc/7/controllers/ms/lrange/index.md @@ -35,7 +35,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lrem/index.md b/doc/7/controllers/ms/lrem/index.md index 87f7c3bc1..ed9bd65b6 100644 --- a/doc/7/controllers/ms/lrem/index.md +++ b/doc/7/controllers/ms/lrem/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/lset/index.md b/doc/7/controllers/ms/lset/index.md index 004a8281c..127f059bc 100644 --- a/doc/7/controllers/ms/lset/index.md +++ b/doc/7/controllers/ms/lset/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/ltrim/index.md b/doc/7/controllers/ms/ltrim/index.md index daee7ddb7..04edfa737 100644 --- a/doc/7/controllers/ms/ltrim/index.md +++ b/doc/7/controllers/ms/ltrim/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/mexecute/index.md b/doc/7/controllers/ms/mexecute/index.md index 06aa9afd6..b0c08603b 100644 --- a/doc/7/controllers/ms/mexecute/index.md +++ b/doc/7/controllers/ms/mexecute/index.md @@ -38,6 +38,16 @@ The `actions` argument is an array of objects. Each object describes an action t | `action` | 
string
| Action name | | `args` | 
object
| Arguments | +### options + +The `options` arguments can contain the following option properties: + +| Property | Type (default) | Description | +| ---------- | ------------------------- | ---------------------------------------------------------------------------- | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve Returns an array of error & result pairs for each executed action, in order. diff --git a/doc/7/controllers/ms/mget/index.md b/doc/7/controllers/ms/mget/index.md index 99488fafa..b9170cae6 100644 --- a/doc/7/controllers/ms/mget/index.md +++ b/doc/7/controllers/ms/mget/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/mset/index.md b/doc/7/controllers/ms/mset/index.md index ddd5cf64f..e00398fdb 100644 --- a/doc/7/controllers/ms/mset/index.md +++ b/doc/7/controllers/ms/mset/index.md @@ -38,7 +38,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/msetnx/index.md b/doc/7/controllers/ms/msetnx/index.md index 64cc99b2a..9eca0ce51 100644 --- a/doc/7/controllers/ms/msetnx/index.md +++ b/doc/7/controllers/ms/msetnx/index.md @@ -38,7 +38,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/object/index.md b/doc/7/controllers/ms/object/index.md index 9c87e3bcc..cca004105 100644 --- a/doc/7/controllers/ms/object/index.md +++ b/doc/7/controllers/ms/object/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/persist/index.md b/doc/7/controllers/ms/persist/index.md index 19963bcc9..6d9b5d4a3 100644 --- a/doc/7/controllers/ms/persist/index.md +++ b/doc/7/controllers/ms/persist/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pexpire/index.md b/doc/7/controllers/ms/pexpire/index.md index 92a540532..ee5408cee 100644 --- a/doc/7/controllers/ms/pexpire/index.md +++ b/doc/7/controllers/ms/pexpire/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pexpireat/index.md b/doc/7/controllers/ms/pexpireat/index.md index ff31c6941..b8b214337 100644 --- a/doc/7/controllers/ms/pexpireat/index.md +++ b/doc/7/controllers/ms/pexpireat/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pfadd/index.md b/doc/7/controllers/ms/pfadd/index.md index 32bc0b613..41fe1d89a 100644 --- a/doc/7/controllers/ms/pfadd/index.md +++ b/doc/7/controllers/ms/pfadd/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pfcount/index.md b/doc/7/controllers/ms/pfcount/index.md index 214dea781..64f1b8747 100644 --- a/doc/7/controllers/ms/pfcount/index.md +++ b/doc/7/controllers/ms/pfcount/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pfmerge/index.md b/doc/7/controllers/ms/pfmerge/index.md index ed883f3f0..2c2c8cc41 100644 --- a/doc/7/controllers/ms/pfmerge/index.md +++ b/doc/7/controllers/ms/pfmerge/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/ping/index.md b/doc/7/controllers/ms/ping/index.md index fb757401c..117a51f0b 100644 --- a/doc/7/controllers/ms/ping/index.md +++ b/doc/7/controllers/ms/ping/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/psetex/index.md b/doc/7/controllers/ms/psetex/index.md index 587999708..154fdfd1c 100644 --- a/doc/7/controllers/ms/psetex/index.md +++ b/doc/7/controllers/ms/psetex/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/pttl/index.md b/doc/7/controllers/ms/pttl/index.md index 477790477..28f19dd8b 100644 --- a/doc/7/controllers/ms/pttl/index.md +++ b/doc/7/controllers/ms/pttl/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/randomkey/index.md b/doc/7/controllers/ms/randomkey/index.md index b3eea2ef2..b5f016e0f 100644 --- a/doc/7/controllers/ms/randomkey/index.md +++ b/doc/7/controllers/ms/randomkey/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rename/index.md b/doc/7/controllers/ms/rename/index.md index abff9ad35..49dbdf253 100644 --- a/doc/7/controllers/ms/rename/index.md +++ b/doc/7/controllers/ms/rename/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/renamenx/index.md b/doc/7/controllers/ms/renamenx/index.md index 48edab3a6..aea448878 100644 --- a/doc/7/controllers/ms/renamenx/index.md +++ b/doc/7/controllers/ms/renamenx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpop/index.md b/doc/7/controllers/ms/rpop/index.md index fb8f554ad..bdd8f34aa 100644 --- a/doc/7/controllers/ms/rpop/index.md +++ b/doc/7/controllers/ms/rpop/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpoplpush/index.md b/doc/7/controllers/ms/rpoplpush/index.md index a46882b6e..172ec566d 100644 --- a/doc/7/controllers/ms/rpoplpush/index.md +++ b/doc/7/controllers/ms/rpoplpush/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpush/index.md b/doc/7/controllers/ms/rpush/index.md index becc1860e..c46c8f09e 100644 --- a/doc/7/controllers/ms/rpush/index.md +++ b/doc/7/controllers/ms/rpush/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/rpushx/index.md b/doc/7/controllers/ms/rpushx/index.md index f9604b8c1..cd937f916 100644 --- a/doc/7/controllers/ms/rpushx/index.md +++ b/doc/7/controllers/ms/rpushx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sadd/index.md b/doc/7/controllers/ms/sadd/index.md index cf3f528d0..86b248c8a 100644 --- a/doc/7/controllers/ms/sadd/index.md +++ b/doc/7/controllers/ms/sadd/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/scan/index.md b/doc/7/controllers/ms/scan/index.md index 9ba928872..c506c5e80 100644 --- a/doc/7/controllers/ms/scan/index.md +++ b/doc/7/controllers/ms/scan/index.md @@ -36,7 +36,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/scard/index.md b/doc/7/controllers/ms/scard/index.md index f7b7aca95..86db50546 100644 --- a/doc/7/controllers/ms/scard/index.md +++ b/doc/7/controllers/ms/scard/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sdiff/index.md b/doc/7/controllers/ms/sdiff/index.md index 06f361efe..03010a21b 100644 --- a/doc/7/controllers/ms/sdiff/index.md +++ b/doc/7/controllers/ms/sdiff/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sdiffstore/index.md b/doc/7/controllers/ms/sdiffstore/index.md index 5fb7807b3..1e722744f 100644 --- a/doc/7/controllers/ms/sdiffstore/index.md +++ b/doc/7/controllers/ms/sdiffstore/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/set/index.md b/doc/7/controllers/ms/set/index.md index 35300d86b..8365402eb 100644 --- a/doc/7/controllers/ms/set/index.md +++ b/doc/7/controllers/ms/set/index.md @@ -31,10 +31,12 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | -------------------------- | ---------------------------------------------------------------------------- | | `ex` | 
integer
| Adds an expiration delay to the key, in seconds | -| `nx` | 
boolean (false)
| If true, do not set the key if it already exists | +| `nx` | 
boolean (false)
| If `true`, do not set the key if it already exists | | `px` | 
integer
| Adds an expiration delay to the key, in milliseconds | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | -| `xx` | 
boolean (false)
| If true, sets the key only if it already exists | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| `xx` | 
boolean (false)
| If `true`, sets the key only if it already exists | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | Note: the `ex` and `px` options are mutually exclusive; setting both options ends up in a `BadRequestError` error. Same thing goes for `nx` and `xx`. diff --git a/doc/7/controllers/ms/setex/index.md b/doc/7/controllers/ms/setex/index.md index 239c83543..a8a35731b 100644 --- a/doc/7/controllers/ms/setex/index.md +++ b/doc/7/controllers/ms/setex/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/setnx/index.md b/doc/7/controllers/ms/setnx/index.md index d1babbb69..fade40776 100644 --- a/doc/7/controllers/ms/setnx/index.md +++ b/doc/7/controllers/ms/setnx/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sinter/index.md b/doc/7/controllers/ms/sinter/index.md index 5c439a2f1..6cebd0ded 100644 --- a/doc/7/controllers/ms/sinter/index.md +++ b/doc/7/controllers/ms/sinter/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sinterstore/index.md b/doc/7/controllers/ms/sinterstore/index.md index 1299b6d77..b4abdcf26 100644 --- a/doc/7/controllers/ms/sinterstore/index.md +++ b/doc/7/controllers/ms/sinterstore/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sismember/index.md b/doc/7/controllers/ms/sismember/index.md index dee827912..06909e8c6 100644 --- a/doc/7/controllers/ms/sismember/index.md +++ b/doc/7/controllers/ms/sismember/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/smembers/index.md b/doc/7/controllers/ms/smembers/index.md index d1273c0d0..de559c7c7 100644 --- a/doc/7/controllers/ms/smembers/index.md +++ b/doc/7/controllers/ms/smembers/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/smove/index.md b/doc/7/controllers/ms/smove/index.md index 942d77bd6..4ac8da5de 100644 --- a/doc/7/controllers/ms/smove/index.md +++ b/doc/7/controllers/ms/smove/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sort/index.md b/doc/7/controllers/ms/sort/index.md index e3641baa8..3f8373807 100644 --- a/doc/7/controllers/ms/sort/index.md +++ b/doc/7/controllers/ms/sort/index.md @@ -35,7 +35,9 @@ The `options` arguments can contain the following option properties: | `direction` | 
string ('ASC')
| Sorts in ascendant or descendant order.
Allowed values: `ASC`, `DESC` | | `get` | 
string[]
| Instead of returning the sorted values directly, returns the values contained in external keys, using patterns completed by the sorted values | | `limit` | 
integer[]
| Limits the result set to a range of matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[, ]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/spop/index.md b/doc/7/controllers/ms/spop/index.md index d54920635..70ca9c420 100644 --- a/doc/7/controllers/ms/spop/index.md +++ b/doc/7/controllers/ms/spop/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (1)
| The number of elements to pop | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/srandmember/index.md b/doc/7/controllers/ms/srandmember/index.md index 60bae2c1c..e4648e403 100644 --- a/doc/7/controllers/ms/srandmember/index.md +++ b/doc/7/controllers/ms/srandmember/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `count` | `integer (1)` | If positive, returns `count` elements at random from the set, without repetition.
If negative, returns `abs(count)` elements, and the same element can be chosen multiple times | -| `queuable` | `boolean (true)` | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | `boolean (true)` | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/srem/index.md b/doc/7/controllers/ms/srem/index.md index d88c22c69..497af9517 100644 --- a/doc/7/controllers/ms/srem/index.md +++ b/doc/7/controllers/ms/srem/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sscan/index.md b/doc/7/controllers/ms/sscan/index.md index a862588a9..127e56d30 100644 --- a/doc/7/controllers/ms/sscan/index.md +++ b/doc/7/controllers/ms/sscan/index.md @@ -37,7 +37,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/strlen/index.md b/doc/7/controllers/ms/strlen/index.md index f08e8a8aa..735660163 100644 --- a/doc/7/controllers/ms/strlen/index.md +++ b/doc/7/controllers/ms/strlen/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sunion/index.md b/doc/7/controllers/ms/sunion/index.md index d7e68457f..e13c53c62 100644 --- a/doc/7/controllers/ms/sunion/index.md +++ b/doc/7/controllers/ms/sunion/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/sunionstore/index.md b/doc/7/controllers/ms/sunionstore/index.md index 7557d9759..08accfab0 100644 --- a/doc/7/controllers/ms/sunionstore/index.md +++ b/doc/7/controllers/ms/sunionstore/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/time/index.md b/doc/7/controllers/ms/time/index.md index e3ec5552d..b7b691ec8 100644 --- a/doc/7/controllers/ms/time/index.md +++ b/doc/7/controllers/ms/time/index.md @@ -28,7 +28,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/touch/index.md b/doc/7/controllers/ms/touch/index.md index da004fb23..1b727e0bb 100644 --- a/doc/7/controllers/ms/touch/index.md +++ b/doc/7/controllers/ms/touch/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/ttl/index.md b/doc/7/controllers/ms/ttl/index.md index d9340adeb..24ae85d6c 100644 --- a/doc/7/controllers/ms/ttl/index.md +++ b/doc/7/controllers/ms/ttl/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/type/index.md b/doc/7/controllers/ms/type/index.md index c055f6eac..e3392bd55 100644 --- a/doc/7/controllers/ms/type/index.md +++ b/doc/7/controllers/ms/type/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zadd/index.md b/doc/7/controllers/ms/zadd/index.md index 58bad292e..a66947ab7 100644 --- a/doc/7/controllers/ms/zadd/index.md +++ b/doc/7/controllers/ms/zadd/index.md @@ -45,11 +45,13 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `ch` | 
boolean (false)
| If true, instead of returning the number of added elements, returns the number of changes performed | -| `incr` | 
boolean (false)
| If true, instead of adding elements, increments the existing member with the provided `score`. Only one element can be specified if this option is set | -| `nx` | 
boolean (false)
| If true, only adds new elements, without altering existing ones | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | -| `xx` | 
boolean (false)
| If true, ignores new elements, alters only existing ones | +| `ch` | 
boolean (false)
| If `true`, instead of returning the number of added elements, returns the number of changes performed | +| `incr` | 
boolean (false)
| If `true`, instead of adding elements, increments the existing member with the provided `score`. Only one element can be specified if this option is set | +| `nx` | 
boolean (false)
| If `true`, only adds new elements, without altering existing ones | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | +| `xx` | 
boolean (false)
| If `true`, ignores new elements, alters only existing ones | ## Resolve diff --git a/doc/7/controllers/ms/zcard/index.md b/doc/7/controllers/ms/zcard/index.md index ad9afa03d..96bfd374f 100644 --- a/doc/7/controllers/ms/zcard/index.md +++ b/doc/7/controllers/ms/zcard/index.md @@ -29,7 +29,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zcount/index.md b/doc/7/controllers/ms/zcount/index.md index 388156a2d..c450655f3 100644 --- a/doc/7/controllers/ms/zcount/index.md +++ b/doc/7/controllers/ms/zcount/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zincrby/index.md b/doc/7/controllers/ms/zincrby/index.md index 53e502d86..69c302c3b 100644 --- a/doc/7/controllers/ms/zincrby/index.md +++ b/doc/7/controllers/ms/zincrby/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zinterstore/index.md b/doc/7/controllers/ms/zinterstore/index.md index 800e26f73..98f8b87b7 100644 --- a/doc/7/controllers/ms/zinterstore/index.md +++ b/doc/7/controllers/ms/zinterstore/index.md @@ -31,7 +31,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | ------------------------- | ------------------------------------------------------------------------------------------------------------- | | `aggregate` | 
string ("sum")
| Specifies how members' scores are aggregated during the intersection.
Allowed values: `min`, `max`, `sum` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (`true`)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + | `weights` | 
integer[]
| List of multiplication factors to apply to sources sets, before aggregation. | ## Resolve diff --git a/doc/7/controllers/ms/zlexcount/index.md b/doc/7/controllers/ms/zlexcount/index.md index a3e3a8cf2..127d91be5 100644 --- a/doc/7/controllers/ms/zlexcount/index.md +++ b/doc/7/controllers/ms/zlexcount/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrange/index.md b/doc/7/controllers/ms/zrange/index.md index b0f3d3d75..f0419dbbb 100644 --- a/doc/7/controllers/ms/zrange/index.md +++ b/doc/7/controllers/ms/zrange/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrangebylex/index.md b/doc/7/controllers/ms/zrangebylex/index.md index d33aa47c7..cbc509204 100644 --- a/doc/7/controllers/ms/zrangebylex/index.md +++ b/doc/7/controllers/ms/zrangebylex/index.md @@ -34,7 +34,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve diff --git a/doc/7/controllers/ms/zrangebyscore/index.md b/doc/7/controllers/ms/zrangebyscore/index.md index 4a796e21b..6b5e16ac3 100644 --- a/doc/7/controllers/ms/zrangebyscore/index.md +++ b/doc/7/controllers/ms/zrangebyscore/index.md @@ -36,7 +36,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve diff --git a/doc/7/controllers/ms/zrank/index.md b/doc/7/controllers/ms/zrank/index.md index ae68b82de..1231fefb2 100644 --- a/doc/7/controllers/ms/zrank/index.md +++ b/doc/7/controllers/ms/zrank/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrem/index.md b/doc/7/controllers/ms/zrem/index.md index 1778ca68d..15df369ba 100644 --- a/doc/7/controllers/ms/zrem/index.md +++ b/doc/7/controllers/ms/zrem/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zremrangebylex/index.md b/doc/7/controllers/ms/zremrangebylex/index.md index e73a28459..14b9ec3e5 100644 --- a/doc/7/controllers/ms/zremrangebylex/index.md +++ b/doc/7/controllers/ms/zremrangebylex/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zremrangebyrank/index.md b/doc/7/controllers/ms/zremrangebyrank/index.md index c2b8b7dad..8e2cf1a18 100644 --- a/doc/7/controllers/ms/zremrangebyrank/index.md +++ b/doc/7/controllers/ms/zremrangebyrank/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zremrangebyscore/index.md b/doc/7/controllers/ms/zremrangebyscore/index.md index 51f0ef8fd..bb3a78113 100644 --- a/doc/7/controllers/ms/zremrangebyscore/index.md +++ b/doc/7/controllers/ms/zremrangebyscore/index.md @@ -33,7 +33,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrevrange/index.md b/doc/7/controllers/ms/zrevrange/index.md index 02a84c22a..ab1e58536 100644 --- a/doc/7/controllers/ms/zrevrange/index.md +++ b/doc/7/controllers/ms/zrevrange/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrevrangebylex/index.md b/doc/7/controllers/ms/zrevrangebylex/index.md index c8917508f..aa7a1f74b 100644 --- a/doc/7/controllers/ms/zrevrangebylex/index.md +++ b/doc/7/controllers/ms/zrevrangebylex/index.md @@ -34,7 +34,10 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | + ## Resolve diff --git a/doc/7/controllers/ms/zrevrangebyscore/index.md b/doc/7/controllers/ms/zrevrangebyscore/index.md index fbf095f38..5d5ecaa27 100644 --- a/doc/7/controllers/ms/zrevrangebyscore/index.md +++ b/doc/7/controllers/ms/zrevrangebyscore/index.md @@ -32,7 +32,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | 
integer[2]
| An array of 2 integers, used to limit the number of returned matching elements (similar to _SELECT LIMIT offset, count_ in SQL).
Format: `[,]` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zrevrank/index.md b/doc/7/controllers/ms/zrevrank/index.md index 312aa3a41..33903fdcf 100644 --- a/doc/7/controllers/ms/zrevrank/index.md +++ b/doc/7/controllers/ms/zrevrank/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zscan/index.md b/doc/7/controllers/ms/zscan/index.md index 78be305d6..b59d4a7fb 100644 --- a/doc/7/controllers/ms/zscan/index.md +++ b/doc/7/controllers/ms/zscan/index.md @@ -37,7 +37,9 @@ The `options` arguments can contain the following option properties: | ---------- | ------------------------- | ---------------------------------------------------------------------------- | | `count` | 
integer (10)
| Return an _approximate_ number of items per result set | | `match` | 
string (\*)
| Return only keys matching the provided pattern | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zscore/index.md b/doc/7/controllers/ms/zscore/index.md index 707d9535f..fa74f48a6 100644 --- a/doc/7/controllers/ms/zscore/index.md +++ b/doc/7/controllers/ms/zscore/index.md @@ -30,7 +30,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ---------- | ------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (true)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/ms/zunionstore/index.md b/doc/7/controllers/ms/zunionstore/index.md index fb5e5693c..0f8f83676 100644 --- a/doc/7/controllers/ms/zunionstore/index.md +++ b/doc/7/controllers/ms/zunionstore/index.md @@ -31,7 +31,9 @@ The `options` arguments can contain the following option properties: | Property | Type (default) | Description | | ----------- | ------------------------- | ------------------------------------------------------------------------------------------------------------- | | `aggregate` | 
string ("sum")
| Specifies how members' scores are aggregated during the intersection.
Allowed values: `min`, `max`, `sum` | -| `queuable` | 
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean (`true`)
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | | `weights` | 
integer[]
| List of multiplication factors to apply to sources sets, before aggregation. | ## Resolve diff --git a/doc/7/controllers/realtime/count/index.md b/doc/7/controllers/realtime/count/index.md index e86d81681..e9802ead6 100644 --- a/doc/7/controllers/realtime/count/index.md +++ b/doc/7/controllers/realtime/count/index.md @@ -29,7 +29,8 @@ Additional query options | Option | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/realtime/publish/index.md b/doc/7/controllers/realtime/publish/index.md index 68d864673..85d1f32ac 100644 --- a/doc/7/controllers/realtime/publish/index.md +++ b/doc/7/controllers/realtime/publish/index.md @@ -35,7 +35,8 @@ Additional query options | Option | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/realtime/subscribe/index.md b/doc/7/controllers/realtime/subscribe/index.md index 69ebdc5fb..c98997aae 100644 --- a/doc/7/controllers/realtime/subscribe/index.md +++ b/doc/7/controllers/realtime/subscribe/index.md @@ -40,7 +40,8 @@ Additional subscription options. | `users` | 
string

(`none`) | Subscribe to users entering or leaving the room
Possible values: `all`, `in`, `out`, `none` | | `subscribeToSelf` | 
boolean

(`true`) | Subscribe to notifications fired by our own queries | | `volatile` | 
object

(`null`) | subscription information, used in [user join/leave notifications](/core/2/guides/main-concepts/api#volatile-data) | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/realtime/unsubscribe/index.md b/doc/7/controllers/realtime/unsubscribe/index.md index b5bd12f57..3c2897838 100644 --- a/doc/7/controllers/realtime/unsubscribe/index.md +++ b/doc/7/controllers/realtime/unsubscribe/index.md @@ -29,7 +29,8 @@ Additional query options | Option | Type
(default) | Description | | ---------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
bool

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/check-rights/index.md b/doc/7/controllers/security/check-rights/index.md index 9aa6c0a2d..531c48646 100644 --- a/doc/7/controllers/security/check-rights/index.md +++ b/doc/7/controllers/security/check-rights/index.md @@ -14,7 +14,7 @@ Checks if the provided API request can be executed by a user. --- ```js -checkRights(kuid, requestPayload) +checkRights(kuid, requestPayload, [options]) ``` | Property | Type | Description | @@ -30,6 +30,15 @@ The [RequestPayload](/core/2/api/payloads/request) must contains at least the fo - `action`: API action --- +### options + +Additional query options + +| Option | Type
(default) | Description | +| ---------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `queuable` | 
bool

(`true`) | Make this request queuable or not | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-api-key/index.md b/doc/7/controllers/security/create-api-key/index.md index 75060c716..0bf23a65d 100644 --- a/doc/7/controllers/security/create-api-key/index.md +++ b/doc/7/controllers/security/create-api-key/index.md @@ -36,6 +36,9 @@ Additional query options | `expiresIn` | 
string/number

(`-1`) | Expiration duration | | `_id` | 
string

(`null`) | API key unique ID | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | +| `queuable` | 
bool

(`true`) | Make this request queuable or not | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | **Notes**: - `expiresIn`: diff --git a/doc/7/controllers/security/create-credentials/index.md b/doc/7/controllers/security/create-credentials/index.md index 05bcbf901..de79643a9 100644 --- a/doc/7/controllers/security/create-credentials/index.md +++ b/doc/7/controllers/security/create-credentials/index.md @@ -43,8 +43,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the credentials are indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-first-admin/index.md b/doc/7/controllers/security/create-first-admin/index.md index 9bca3637d..2274935f6 100644 --- a/doc/7/controllers/security/create-first-admin/index.md +++ b/doc/7/controllers/security/create-first-admin/index.md @@ -54,8 +54,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | -| `reset` | 
boolean

(`false`) | If true, restricted permissions are applied to `anonymous` and `default` roles | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| `reset` | 
boolean

(`false`) | If `true`, restricted permissions are applied to `anonymous` and `default` roles | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-or-replace-profile/index.md b/doc/7/controllers/security/create-or-replace-profile/index.md index 4fbcf1cd3..02c501c2a 100644 --- a/doc/7/controllers/security/create-or-replace-profile/index.md +++ b/doc/7/controllers/security/create-or-replace-profile/index.md @@ -33,8 +33,10 @@ createOrReplaceProfile(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created/replaced profile is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-or-replace-role/index.md b/doc/7/controllers/security/create-or-replace-role/index.md index 037a5709e..d458944a3 100644 --- a/doc/7/controllers/security/create-or-replace-role/index.md +++ b/doc/7/controllers/security/create-or-replace-role/index.md @@ -33,7 +33,9 @@ createOrReplaceRole(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created/replaced role is indexed | | `force` | 
boolean

(`false`) | If set to `true`, creates or replaces the role even if it gives access to non-existent plugins API routes. | diff --git a/doc/7/controllers/security/create-profile/index.md b/doc/7/controllers/security/create-profile/index.md index 2129ae5e2..96800ad55 100644 --- a/doc/7/controllers/security/create-profile/index.md +++ b/doc/7/controllers/security/create-profile/index.md @@ -27,8 +27,10 @@ createProfile(id, profile, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created profile is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-restricted-user/index.md b/doc/7/controllers/security/create-restricted-user/index.md index 05a500627..6c1ab018a 100644 --- a/doc/7/controllers/security/create-restricted-user/index.md +++ b/doc/7/controllers/security/create-restricted-user/index.md @@ -58,9 +58,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the user is indexed | - +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-role/index.md b/doc/7/controllers/security/create-role/index.md index 93c99c35a..9ea716314 100644 --- a/doc/7/controllers/security/create-role/index.md +++ b/doc/7/controllers/security/create-role/index.md @@ -33,10 +33,11 @@ createRole(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created role is indexed | | `force` | 
boolean

(`false`) | If set to `true`, creates the role even if it gives access to non-existent plugins API routes | - +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/create-user/index.md b/doc/7/controllers/security/create-user/index.md index 185d8548c..650c0a7d4 100644 --- a/doc/7/controllers/security/create-user/index.md +++ b/doc/7/controllers/security/create-user/index.md @@ -61,8 +61,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created user is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-api-key/index.md b/doc/7/controllers/security/delete-api-key/index.md index 9664e2b2e..eaa7f6b24 100644 --- a/doc/7/controllers/security/delete-api-key/index.md +++ b/doc/7/controllers/security/delete-api-key/index.md @@ -34,7 +34,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed | - +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves Resolves if the API key is successfully deleted. diff --git a/doc/7/controllers/security/delete-credentials/index.md b/doc/7/controllers/security/delete-credentials/index.md index ffac9f9d1..d2512c2ce 100644 --- a/doc/7/controllers/security/delete-credentials/index.md +++ b/doc/7/controllers/security/delete-credentials/index.md @@ -29,8 +29,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the credentials deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-profile/index.md b/doc/7/controllers/security/delete-profile/index.md index 6a1536d8e..db3574835 100644 --- a/doc/7/controllers/security/delete-profile/index.md +++ b/doc/7/controllers/security/delete-profile/index.md @@ -28,8 +28,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the profile deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-role/index.md b/doc/7/controllers/security/delete-role/index.md index 8e8ca35e9..f9e8d0a83 100644 --- a/doc/7/controllers/security/delete-role/index.md +++ b/doc/7/controllers/security/delete-role/index.md @@ -28,8 +28,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the role deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/delete-user/index.md b/doc/7/controllers/security/delete-user/index.md index a1bf0a4f1..f0f25511c 100644 --- a/doc/7/controllers/security/delete-user/index.md +++ b/doc/7/controllers/security/delete-user/index.md @@ -28,8 +28,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the user deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-all-credential-fields/index.md b/doc/7/controllers/security/get-all-credential-fields/index.md index cfcb427e2..3e84b3a0b 100644 --- a/doc/7/controllers/security/get-all-credential-fields/index.md +++ b/doc/7/controllers/security/get-all-credential-fields/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-credential-fields/index.md b/doc/7/controllers/security/get-credential-fields/index.md index a91223303..fae52852f 100644 --- a/doc/7/controllers/security/get-credential-fields/index.md +++ b/doc/7/controllers/security/get-credential-fields/index.md @@ -28,7 +28,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-credentials-by-id/index.md b/doc/7/controllers/security/get-credentials-by-id/index.md index cc10ce88a..4fd30afff 100644 --- a/doc/7/controllers/security/get-credentials-by-id/index.md +++ b/doc/7/controllers/security/get-credentials-by-id/index.md @@ -34,7 +34,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-credentials/index.md b/doc/7/controllers/security/get-credentials/index.md index 54c5b2fd4..73e056fea 100644 --- a/doc/7/controllers/security/get-credentials/index.md +++ b/doc/7/controllers/security/get-credentials/index.md @@ -29,7 +29,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-profile-mapping/index.md b/doc/7/controllers/security/get-profile-mapping/index.md index 41d88029e..20d1d3e4b 100644 --- a/doc/7/controllers/security/get-profile-mapping/index.md +++ b/doc/7/controllers/security/get-profile-mapping/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-profile-rights/index.md b/doc/7/controllers/security/get-profile-rights/index.md index e28c3c6e8..5170575c1 100644 --- a/doc/7/controllers/security/get-profile-rights/index.md +++ b/doc/7/controllers/security/get-profile-rights/index.md @@ -26,7 +26,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-profile/index.md b/doc/7/controllers/security/get-profile/index.md index 684967633..b9c383c0c 100644 --- a/doc/7/controllers/security/get-profile/index.md +++ b/doc/7/controllers/security/get-profile/index.md @@ -28,7 +28,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-role-mapping/index.md b/doc/7/controllers/security/get-role-mapping/index.md index a7153991b..8b77af997 100644 --- a/doc/7/controllers/security/get-role-mapping/index.md +++ b/doc/7/controllers/security/get-role-mapping/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-role/index.md b/doc/7/controllers/security/get-role/index.md index 1a83680cd..7ba64f541 100644 --- a/doc/7/controllers/security/get-role/index.md +++ b/doc/7/controllers/security/get-role/index.md @@ -28,7 +28,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user-mapping/index.md b/doc/7/controllers/security/get-user-mapping/index.md index 786ccdf90..d69ca2a89 100644 --- a/doc/7/controllers/security/get-user-mapping/index.md +++ b/doc/7/controllers/security/get-user-mapping/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user-rights/index.md b/doc/7/controllers/security/get-user-rights/index.md index 052f294b6..b58b32547 100644 --- a/doc/7/controllers/security/get-user-rights/index.md +++ b/doc/7/controllers/security/get-user-rights/index.md @@ -26,7 +26,9 @@ getUserRights(kui, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user-strategies/index.md b/doc/7/controllers/security/get-user-strategies/index.md index 7d26ff02e..b3bdf6596 100644 --- a/doc/7/controllers/security/get-user-strategies/index.md +++ b/doc/7/controllers/security/get-user-strategies/index.md @@ -29,7 +29,9 @@ getUserStrategies(kuid, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/get-user/index.md b/doc/7/controllers/security/get-user/index.md index 1c5a0988c..cf711d82c 100644 --- a/doc/7/controllers/security/get-user/index.md +++ b/doc/7/controllers/security/get-user/index.md @@ -26,7 +26,9 @@ getUser(kuid, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/has-credentials/index.md b/doc/7/controllers/security/has-credentials/index.md index 72cb74532..616f7ed48 100644 --- a/doc/7/controllers/security/has-credentials/index.md +++ b/doc/7/controllers/security/has-credentials/index.md @@ -27,7 +27,9 @@ hasCredentials(strategy, kuid, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-delete-profiles/index.md b/doc/7/controllers/security/m-delete-profiles/index.md index 1a91f61e1..70e9127f9 100644 --- a/doc/7/controllers/security/m-delete-profiles/index.md +++ b/doc/7/controllers/security/m-delete-profiles/index.md @@ -28,8 +28,10 @@ mDeleteProfiles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the profiles deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-delete-roles/index.md b/doc/7/controllers/security/m-delete-roles/index.md index 77dd59675..a61be11ed 100644 --- a/doc/7/controllers/security/m-delete-roles/index.md +++ b/doc/7/controllers/security/m-delete-roles/index.md @@ -28,8 +28,10 @@ mDeleteRoles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the roles deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-delete-users/index.md b/doc/7/controllers/security/m-delete-users/index.md index a584780e9..d781ee91c 100644 --- a/doc/7/controllers/security/m-delete-users/index.md +++ b/doc/7/controllers/security/m-delete-users/index.md @@ -28,8 +28,10 @@ mDeleteUsers(kuids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the users deletion is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-get-profiles/index.md b/doc/7/controllers/security/m-get-profiles/index.md index d67c76954..b1673ced2 100644 --- a/doc/7/controllers/security/m-get-profiles/index.md +++ b/doc/7/controllers/security/m-get-profiles/index.md @@ -26,7 +26,9 @@ mGetProfiles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-get-roles/index.md b/doc/7/controllers/security/m-get-roles/index.md index d29c19c94..b255ce6f7 100644 --- a/doc/7/controllers/security/m-get-roles/index.md +++ b/doc/7/controllers/security/m-get-roles/index.md @@ -26,7 +26,9 @@ mGetRoles(ids, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/m-get-users/index.md b/doc/7/controllers/security/m-get-users/index.md index 6a64c2989..f173b7b02 100644 --- a/doc/7/controllers/security/m-get-users/index.md +++ b/doc/7/controllers/security/m-get-users/index.md @@ -26,7 +26,9 @@ mGetUsers(kuids, [options]); | Property | Type | Description | | --- | --- | --- | -| `queuable` | 
boolean
| If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean
| If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | | `verb` | 
string
| (HTTP only) Forces the verb of the API route | #### verb diff --git a/doc/7/controllers/security/replace-user/index.md b/doc/7/controllers/security/replace-user/index.md index 67b138571..01e099d40 100644 --- a/doc/7/controllers/security/replace-user/index.md +++ b/doc/7/controllers/security/replace-user/index.md @@ -50,8 +50,10 @@ example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created user is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-api-keys/index.md b/doc/7/controllers/security/search-api-keys/index.md index 15e78e685..ee61129d4 100644 --- a/doc/7/controllers/security/search-api-keys/index.md +++ b/doc/7/controllers/security/search-api-keys/index.md @@ -51,6 +51,8 @@ Additional query options | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-profiles/index.md b/doc/7/controllers/security/search-profiles/index.md index 07c614c99..22459c038 100644 --- a/doc/7/controllers/security/search-profiles/index.md +++ b/doc/7/controllers/security/search-profiles/index.md @@ -42,11 +42,13 @@ If the body is left empty, the result will return all available profiles. | Property | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `scroll` | 
string

(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-roles/index.md b/doc/7/controllers/security/search-roles/index.md index a737bd203..6bba15109 100644 --- a/doc/7/controllers/security/search-roles/index.md +++ b/doc/7/controllers/security/search-roles/index.md @@ -32,9 +32,11 @@ searchRoles([body], [options]); | Property | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/search-users/index.md b/doc/7/controllers/security/search-users/index.md index 40ef7ae74..e89ee124a 100644 --- a/doc/7/controllers/security/search-users/index.md +++ b/doc/7/controllers/security/search-users/index.md @@ -41,11 +41,13 @@ If left empty, the result will return all available users. | Property | Type
(default) | Description | | ---------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `from` | 
number

(`0`) | Offset of the first document to fetch | | `size` | 
number

(`10`) | Maximum number of documents to retrieve per page | | `scroll` | 
string

(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `30s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) | | `lang` | 
string
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-credentials/index.md b/doc/7/controllers/security/update-credentials/index.md index ceb56cef7..10aa31fdf 100644 --- a/doc/7/controllers/security/update-credentials/index.md +++ b/doc/7/controllers/security/update-credentials/index.md @@ -43,8 +43,10 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the credentials are indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-profile-mapping/index.md b/doc/7/controllers/security/update-profile-mapping/index.md index 290080f0c..76a7a9caa 100644 --- a/doc/7/controllers/security/update-profile-mapping/index.md +++ b/doc/7/controllers/security/update-profile-mapping/index.md @@ -26,7 +26,9 @@ updateProfileMapping(mapping, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-profile/index.md b/doc/7/controllers/security/update-profile/index.md index a314cd334..bcd769ac5 100644 --- a/doc/7/controllers/security/update-profile/index.md +++ b/doc/7/controllers/security/update-profile/index.md @@ -27,8 +27,10 @@ updateProfile(id, profile, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the created profile is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-role-mapping/index.md b/doc/7/controllers/security/update-role-mapping/index.md index 1ba7e49e0..1b9068771 100644 --- a/doc/7/controllers/security/update-role-mapping/index.md +++ b/doc/7/controllers/security/update-role-mapping/index.md @@ -26,7 +26,9 @@ updateRoleMapping(mapping, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-role/index.md b/doc/7/controllers/security/update-role/index.md index d13ffcb2e..549fd7cf7 100644 --- a/doc/7/controllers/security/update-role/index.md +++ b/doc/7/controllers/security/update-role/index.md @@ -35,9 +35,11 @@ updateRole(id, body, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the updated role is indexed | | `force` | 
boolean

(`false`) | If set to `true`, updates the role even if it gives access to non-existent plugins API routes | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-user-mapping/index.md b/doc/7/controllers/security/update-user-mapping/index.md index 5504daff5..7199a2de2 100644 --- a/doc/7/controllers/security/update-user-mapping/index.md +++ b/doc/7/controllers/security/update-user-mapping/index.md @@ -26,7 +26,9 @@ updateUserMapping(mapping, [options]); | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/update-user/index.md b/doc/7/controllers/security/update-user/index.md index 1c5d3753b..83d0351b8 100644 --- a/doc/7/controllers/security/update-user/index.md +++ b/doc/7/controllers/security/update-user/index.md @@ -45,8 +45,10 @@ Example: | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | | `refresh` | 
boolean

(`false`) | If set to `wait_for`, Kuzzle will not respond until the updated user is indexed | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/security/validate-credentials/index.md b/doc/7/controllers/security/validate-credentials/index.md index d677e8a3b..4b93a772a 100644 --- a/doc/7/controllers/security/validate-credentials/index.md +++ b/doc/7/controllers/security/validate-credentials/index.md @@ -43,7 +43,9 @@ Additional query options | Property | Type
(default) | Description | | --- | --- | --- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolves diff --git a/doc/7/controllers/server/admin-exists/index.md b/doc/7/controllers/server/admin-exists/index.md index 4f3c814f9..8f046d400 100644 --- a/doc/7/controllers/server/admin-exists/index.md +++ b/doc/7/controllers/server/admin-exists/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-all-stats/index.md b/doc/7/controllers/server/get-all-stats/index.md index a808d44d5..b7998624d 100644 --- a/doc/7/controllers/server/get-all-stats/index.md +++ b/doc/7/controllers/server/get-all-stats/index.md @@ -35,7 +35,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-config/index.md b/doc/7/controllers/server/get-config/index.md index f1820d340..e3917ae8c 100644 --- a/doc/7/controllers/server/get-config/index.md +++ b/doc/7/controllers/server/get-config/index.md @@ -31,7 +31,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-last-stats/index.md b/doc/7/controllers/server/get-last-stats/index.md index 4b2343fc9..bbf7c68ca 100644 --- a/doc/7/controllers/server/get-last-stats/index.md +++ b/doc/7/controllers/server/get-last-stats/index.md @@ -36,7 +36,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/get-stats/index.md b/doc/7/controllers/server/get-stats/index.md index d30996d00..3ddb73c11 100644 --- a/doc/7/controllers/server/get-stats/index.md +++ b/doc/7/controllers/server/get-stats/index.md @@ -37,7 +37,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/info/index.md b/doc/7/controllers/server/info/index.md index 182f32649..9a204a648 100644 --- a/doc/7/controllers/server/info/index.md +++ b/doc/7/controllers/server/info/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/controllers/server/now/index.md b/doc/7/controllers/server/now/index.md index 9a2ad4777..1ee758b65 100644 --- a/doc/7/controllers/server/now/index.md +++ b/doc/7/controllers/server/now/index.md @@ -27,7 +27,9 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | ## Resolve diff --git a/doc/7/core-classes/base-controller/query/index.md b/doc/7/core-classes/base-controller/query/index.md index 97f2924fd..436664c27 100644 --- a/doc/7/core-classes/base-controller/query/index.md +++ b/doc/7/core-classes/base-controller/query/index.md @@ -50,7 +50,7 @@ Additional query options | Property | Type
(default) | Description | | -------------- | --------- | ------------- | -| `queuable` | 
boolean

(`true`) | If true, queues the request during downtime, until connected to Kuzzle again | +| `queuable` | 
boolean

(`true`) | If `true`, queues the request during downtime, until connected to Kuzzle again | ## Resolves diff --git a/doc/7/core-classes/kuzzle/query/index.md b/doc/7/core-classes/kuzzle/query/index.md index ca5830f55..708122ceb 100644 --- a/doc/7/core-classes/kuzzle/query/index.md +++ b/doc/7/core-classes/kuzzle/query/index.md @@ -48,13 +48,19 @@ Additional query options | Property | Type
(default) | Description | | ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `queuable` | 
boolean

(`true`) | Make this request queuable or not | -| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number
| Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | 
number

(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely | +| [`triggerEvents`](/sdk/7/core-classes/kuzzle/query#triggerEvents) | 
boolean

(`false`)| If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. | #### timeout ::: warn The **timeout** option can only be used to prevent the SDK from being frozen if Kuzzle take too long to resolve a request, this will not prevent the request from being executed and Kuzzle will still resolve it at some point. +#### triggerEvents + +::: warn + The **triggerEvents** option can only be used to prevent the EmbededSDK from escaping events such as a pipe or a hook. Use it can lead to infinite loop if used wrongly. (ex: a pipe on document creation that create a document that triggers same pipe again and again) + ## Resolves Resolve to the raw Kuzzle API response. See the [API Documentation](/core/2/api).