diff --git a/src/sdk-reference/cpp/1/document/search/index.md b/src/sdk-reference/cpp/1/document/search/index.md index e69de29bb..2495f5ea0 100644 --- a/src/sdk-reference/cpp/1/document/search/index.md +++ b/src/sdk-reference/cpp/1/document/search/index.md @@ -0,0 +1,70 @@ +--- +layout: sdk.html.hbs +title: search +description: Search documents +order: 200 +--- + +# search + +Searches documents. + +There is a limit to how many documents can be returned by a single search query. +That limit is by default set at 10000 documents, and you can't get over it even with the from and size pagination options. + +
+

+ When processing a large number of documents (i.e. more than 1000), it is advised to paginate the results using SearchResult.next rather than increasing the size parameter. +

+
+ + +## Arguments + +```cpp +SearchResult* search( + const std::string& index, + const std::string& collection, + const std::string& body, + kuzzleio::query_options *options=nullptr) +``` + +| Argument | Type | Description | +| --- | --- | --- | +| `index` |
const std::string&
| Index name | +| `collection` |
const std::string&
| Collection name | +| `body` |
const std::string&
| A JSON string containing the search query | +| `options` |
kuzzleio::query_options*
| A pointer to a `kuzzleio::query_options` containing query options | + +### options + +Additional query options + +| Option | Type
(default) | Description | +| ------ | -------------- | ----------- | +| `queuable` |
bool

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

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

(`10`) | Maximum number of documents to retrieve per page | +| `scroll` |
const std::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/current/common-options.html#time-units)) | + +## Body properties + +### Optional: + +- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/query-dsl.html) syntax. +- `aggregations`: control how the search results should be [aggregated](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-aggregations.html) +- `sort`: contains a list of fields, used to [sort search results](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/search-request-sort.html), in order of importance. + +An empty body matches all documents in the queried collection. + +## Return + +Returns a [kuzzleio::SearchResult]({{ site_base_path }}src/sdk-reference/cpp/1/search-result). + +## Exceptions + +Throws a `KuzzleException` if there is an error. See how to [handle errors]({{ site_base_path }}sdk-reference/cpp/1/essentials/error-handling). + +## Usage + +[snippet=search] diff --git a/src/sdk-reference/java/1/index/delete/index.md b/src/sdk-reference/java/1/index/delete/index.md index 372118da3..f01344794 100644 --- a/src/sdk-reference/java/1/index/delete/index.md +++ b/src/sdk-reference/java/1/index/delete/index.md @@ -11,8 +11,8 @@ Deletes an entire data index from Kuzzle. ## Signature ```java -boolean exists(String index) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException; -boolean exists(String index, io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException; +void delete(String index) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException; +void delete(String index, io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException; ``` ## Arguments diff --git a/src/sdk-reference/js/6/auth/get-my-rights/index.md b/src/sdk-reference/js/6/auth/get-my-rights/index.md index b7514b9f3..ade945783 100644 --- a/src/sdk-reference/js/6/auth/get-my-rights/index.md +++ b/src/sdk-reference/js/6/auth/get-my-rights/index.md @@ -30,7 +30,7 @@ Additional query options ## Resolves -An `arraystring | Action on wich the rights are applied | | `index` |
string
| Index on wich the rights are applied | | `collection` |
string
| Collection on wich the rights are applied | -| `value` |
string
| Rights (`allowed|denied|conditional`) | +| `value` |
string
| Rights (`allowed`, `denied`, `conditional`) | ## Usage diff --git a/src/sdk-reference/js/6/auth/login/index.md b/src/sdk-reference/js/6/auth/login/index.md index c58e4bbc1..c8d91a7d9 100644 --- a/src/sdk-reference/js/6/auth/login/index.md +++ b/src/sdk-reference/js/6/auth/login/index.md @@ -11,7 +11,7 @@ Authenticates a user. ## Arguments ```javascript -login (strategy, credentials, expiresIn) +login (strategy, [credentials], [expiresIn]) ```
@@ -19,7 +19,7 @@ login (strategy, credentials, expiresIn) | Arguments | Type | Description | |--------------|---------|-------------| | ``strategy`` |
string
| Name of the strategy to use | -| ``credentials`` |
string
| Credentials for the strategy | +| ``credentials`` |
object
| Credentials for the strategy | | ``expiresIn`` |
string
| Expiration time in [ms library](https://www.npmjs.com/package/ms) format. (e.g. `2h`) | #### strategy diff --git a/src/sdk-reference/js/6/auth/validate-my-credentials/index.md b/src/sdk-reference/js/6/auth/validate-my-credentials/index.md index 671a8d844..8f7440424 100644 --- a/src/sdk-reference/js/6/auth/validate-my-credentials/index.md +++ b/src/sdk-reference/js/6/auth/validate-my-credentials/index.md @@ -13,7 +13,7 @@ This route neither creates nor modifies credentials. ## Arguments ```javascript -validateMyCredentials (strategy, credentials, [options]) +validateMyCredentials (strategy, [credentials], [options]) ```
@@ -21,7 +21,7 @@ validateMyCredentials (strategy, credentials, [options]) | Arguments | Type | Description |--------------|---------|------------- | `strategy` |
string
| Strategy to use -| `credentials` |
string
| New credentials + | `credentials` |
object
| Credentials | `options` |
object
| Query options @@ -36,7 +36,7 @@ Additional query options ## Resolves -Resolves to `true` if the credentials are valid, `false`otherwise. +Resolves to `true` if the credentials are valid, `false` otherwise. ## Usage diff --git a/src/sdk-reference/js/6/collection/create/index.md b/src/sdk-reference/js/6/collection/create/index.md index 9602e2ecd..37846fa30 100644 --- a/src/sdk-reference/js/6/collection/create/index.md +++ b/src/sdk-reference/js/6/collection/create/index.md @@ -16,7 +16,7 @@ This method will only update the mapping if the collection already exists. ## Arguments ```javascript -create (index, collection, mapping = null, [options]) +create (index, collection, [mapping], [options]) ```
diff --git a/src/sdk-reference/js/6/collection/get-specifications/index.md b/src/sdk-reference/js/6/collection/get-specifications/index.md index 995d68af4..88e1337e9 100644 --- a/src/sdk-reference/js/6/collection/get-specifications/index.md +++ b/src/sdk-reference/js/6/collection/get-specifications/index.md @@ -17,7 +17,7 @@ getSpecifications (index, collection, [options])
| Arguments | Type | Description | -|--------------|---------|-------------|---------- +|--------------|---------|-------------| | ``index`` |
string
| Index name | | ``collection`` |
string
| Collection name | | ``options`` |
object
| Query options | diff --git a/src/sdk-reference/js/6/collection/get-specifications/snippets/get-specifications.js b/src/sdk-reference/js/6/collection/get-specifications/snippets/get-specifications.js index 42656abf3..14d0f14c7 100644 --- a/src/sdk-reference/js/6/collection/get-specifications/snippets/get-specifications.js +++ b/src/sdk-reference/js/6/collection/get-specifications/snippets/get-specifications.js @@ -1,6 +1,22 @@ try { const specifications = await kuzzle.collection.getSpecifications('nyc-open-data', 'yellow-taxi'); - + console.log(specifications); + /* + { + "collection": "yellow-taxi", + "index": "nyc-open-data", + "validation": { + "fields": { + "age": { + "defaultValue": 42, + "mandatory": true, + "type": "integer" + } + }, + "strict": true + } + } + */ console.log('Success'); } catch (error) { console.error(error.message); diff --git a/src/sdk-reference/js/6/collection/search-specifications/index.md b/src/sdk-reference/js/6/collection/search-specifications/index.md index 29bf651e5..6d0545d72 100644 --- a/src/sdk-reference/js/6/collection/search-specifications/index.md +++ b/src/sdk-reference/js/6/collection/search-specifications/index.md @@ -55,7 +55,7 @@ const body = { | `queuable` |
boolean

(`true`) | Make this request queuable or not | | ``from`` |
number

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

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

| Maximum duration for scroll session | +| ``scroll`` |
string

| Maximum duration for scroll session | * `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 @@ -63,7 +63,7 @@ const body = { ## Resolves -Resolve to a [SpecificationsSearchResult]({{ site_base_path }}sdk-reference/js/6/essentials/search-result). +Resolve to a [SpecificationsSearchResult]({{ site_base_path }}sdk-reference/js/6/search-result). ## Usage diff --git a/src/sdk-reference/js/6/collection/update-specifications/index.md b/src/sdk-reference/js/6/collection/update-specifications/index.md index 076cd2e26..69e6bbbbb 100644 --- a/src/sdk-reference/js/6/collection/update-specifications/index.md +++ b/src/sdk-reference/js/6/collection/update-specifications/index.md @@ -19,7 +19,7 @@ updateSpecifications(index, collection, specifications, [options])
| Arguments | Type | Description | -|--------------|---------|-------------|---------- +|--------------|---------|-------------| | ``index`` |
string
| Index name | | ``collection`` |
string
| Collection name | | ``specifications`` |
object
| Specifications to update | @@ -29,7 +29,7 @@ updateSpecifications(index, collection, specifications, [options]) An object representing the specifications. -This object must follow the [Specification Structure]({{ site_base_path }}validation-reference/schema): +This object must follow the [Specification Structure]({{ site_base_path }}guide/1/essentials/data-validation/): ```js { diff --git a/src/sdk-reference/js/6/document/create/index.md b/src/sdk-reference/js/6/document/create/index.md index 48e258638..9784b0106 100644 --- a/src/sdk-reference/js/6/document/create/index.md +++ b/src/sdk-reference/js/6/document/create/index.md @@ -15,15 +15,15 @@ The optional parameter `refresh` can be used with the value `wait_for` in order ## Arguments ```javascript -create (index, collection, id, document, [options]) +create (index, collection, document, [id], [options]) ``` | Argument | Type | Description | | --- | --- | --- | | `index` |
string
| Index name | | `collection` |
string
| Collection name | -| `id` |
string
| Optional document ID | | `document` |
object
| Document content | +| `id` |
string
| Optional document ID | | `options` |
object
| Query options | ### Options diff --git a/src/sdk-reference/js/6/document/create/snippets/create.js b/src/sdk-reference/js/6/document/create/snippets/create.js index 01efad86c..b9dccf166 100644 --- a/src/sdk-reference/js/6/document/create/snippets/create.js +++ b/src/sdk-reference/js/6/document/create/snippets/create.js @@ -2,8 +2,8 @@ try { const response = await kuzzle.document.create( 'nyc-open-data', 'yellow-taxi', - 'some-id', - { lastName: 'Eggins' } + { lastName: 'Eggins' }, + 'some-id' ); if (response._id === 'some-id') { diff --git a/src/sdk-reference/js/6/document/createOrReplace/index.md b/src/sdk-reference/js/6/document/createOrReplace/index.md index 0dfcaa4cd..6cf5352c6 100644 --- a/src/sdk-reference/js/6/document/createOrReplace/index.md +++ b/src/sdk-reference/js/6/document/createOrReplace/index.md @@ -20,7 +20,7 @@ createOrReplace (index, collection, id, document, [options]) | --- | --- | --- | | `index` |
string
| Index name | | `collection` |
string
| Collection name | -| `id` |
string
| Optional document ID | +| `id` |
string
| Document ID | | `document` |
object
| Document content | | `options` |
object
| Query options | diff --git a/src/sdk-reference/js/6/document/createOrReplace/snippets/create-or-replace.js b/src/sdk-reference/js/6/document/createOrReplace/snippets/create-or-replace.js index ba10479d2..0aeac5744 100644 --- a/src/sdk-reference/js/6/document/createOrReplace/snippets/create-or-replace.js +++ b/src/sdk-reference/js/6/document/createOrReplace/snippets/create-or-replace.js @@ -1,5 +1,5 @@ try { - const response = await kuzzle.document.create( + const response = await kuzzle.document.createOrReplace( 'nyc-open-data', 'yellow-taxi', 'some-id', @@ -30,4 +30,4 @@ try { */ } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/delete/index.md b/src/sdk-reference/js/6/document/delete/index.md index 9bb98aedc..e2aaa0a63 100644 --- a/src/sdk-reference/js/6/document/delete/index.md +++ b/src/sdk-reference/js/6/document/delete/index.md @@ -20,7 +20,7 @@ delete (index, collection, id, [options]) | --- | --- | --- | | `index` |
string
| Index name | | `collection` |
string
| Collection name | -| `id` |
string
| Optional document ID | +| `id` |
string
| Document ID | | `options` |
object
| Query options | ### Options diff --git a/src/sdk-reference/js/6/document/deleteByQuery/index.md b/src/sdk-reference/js/6/document/deleteByQuery/index.md index a09d648cb..d9962e6a0 100644 --- a/src/sdk-reference/js/6/document/deleteByQuery/index.md +++ b/src/sdk-reference/js/6/document/deleteByQuery/index.md @@ -8,7 +8,9 @@ description: Delete documents matching query Deletes documents matching the provided search query. -Kuzzle uses the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/query-dsl.html) syntax. +Kuzzle uses the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/query-dsl.html) syntax. + +An empty or null query will match all documents in the collection. ## Arguments diff --git a/src/sdk-reference/js/6/document/get/snippets/get.js b/src/sdk-reference/js/6/document/get/snippets/get.js index 80aa8644e..e5e33c88e 100644 --- a/src/sdk-reference/js/6/document/get/snippets/get.js +++ b/src/sdk-reference/js/6/document/get/snippets/get.js @@ -2,8 +2,8 @@ try { await kuzzle.document.create( 'nyc-open-data', 'yellow-taxi', - 'some-id', - { capacity: 4 } + { capacity: 4 }, + 'some-id' ); const response = await kuzzle.document.get('nyc-open-data', 'yellow-taxi', 'some-id'); @@ -27,4 +27,4 @@ try { console.log('Success'); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/mDelete/index.md b/src/sdk-reference/js/6/document/mDelete/index.md index 79343942d..e626def81 100644 --- a/src/sdk-reference/js/6/document/mDelete/index.md +++ b/src/sdk-reference/js/6/document/mDelete/index.md @@ -36,6 +36,8 @@ Additional query options ## Resolves +Resolves to an array of objects representing the deleted documents. + ## Usage [snippet=m-delete] diff --git a/src/sdk-reference/js/6/document/mDelete/snippets/m-delete.js b/src/sdk-reference/js/6/document/mDelete/snippets/m-delete.js index f345c6f9d..5a865a222 100644 --- a/src/sdk-reference/js/6/document/mDelete/snippets/m-delete.js +++ b/src/sdk-reference/js/6/document/mDelete/snippets/m-delete.js @@ -1,6 +1,6 @@ try { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-id', {}); - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-other-id', {}); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', {}, 'some-id'); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', {}, 'some-other-id'); const deleted = await kuzzle.document.mDelete( 'nyc-open-data', @@ -11,4 +11,4 @@ try { console.log(`Successfully deleted ${deleted.length} documents`); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/mGet/index.md b/src/sdk-reference/js/6/document/mGet/index.md index f2c1365c0..0edc509ec 100644 --- a/src/sdk-reference/js/6/document/mGet/index.md +++ b/src/sdk-reference/js/6/document/mGet/index.md @@ -33,7 +33,13 @@ Additional query options ## Resolves -Resolves to an array of retrieved documents. +Resolves to an object containing the retrieved documents. + +| Property | Type | Description | +| --- | --- | --- | +| `hits` |
array | Retrieved documents |
+| `total` | 
number
| Total retrieved documents | + ## Usage diff --git a/src/sdk-reference/js/6/document/mGet/snippets/m-get.js b/src/sdk-reference/js/6/document/mGet/snippets/m-get.js index d59b0d82a..bca631dac 100644 --- a/src/sdk-reference/js/6/document/mGet/snippets/m-get.js +++ b/src/sdk-reference/js/6/document/mGet/snippets/m-get.js @@ -2,8 +2,8 @@ const doc1 = { capacity: 4 }; const doc2 = { capacity: 7 }; try { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-id', doc1); - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-other-id', doc2); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', doc1, 'some-id'); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', doc2, 'some-other-id'); const response = await kuzzle.document.mGet( 'nyc-open-data', @@ -58,4 +58,4 @@ try { console.log(`Successfully get ${response.total} documents`); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/mReplace/index.md b/src/sdk-reference/js/6/document/mReplace/index.md index 4d9abce3d..755f81e99 100644 --- a/src/sdk-reference/js/6/document/mReplace/index.md +++ b/src/sdk-reference/js/6/document/mReplace/index.md @@ -34,7 +34,13 @@ Additional query options ## Resolves -Resolves to an array of updated documents. +Resolves to an object containing the replaced documents. + +| Property | Type | Description | +| --- | --- | --- | +| `hits` |
array | Replaced documents |
+| `total` | 
number
| Total replaced documents | + ## Usage diff --git a/src/sdk-reference/js/6/document/mReplace/snippets/m-replace.js b/src/sdk-reference/js/6/document/mReplace/snippets/m-replace.js index 243740750..52a1821e3 100644 --- a/src/sdk-reference/js/6/document/mReplace/snippets/m-replace.js +++ b/src/sdk-reference/js/6/document/mReplace/snippets/m-replace.js @@ -1,6 +1,6 @@ try { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-id', {}); - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-other-id', {}); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', {}, 'some-id'); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', {}, 'some-other-id'); const documents = [ { @@ -61,4 +61,4 @@ try { console.log('Success'); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/mUpdate/index.md b/src/sdk-reference/js/6/document/mUpdate/index.md index 157d03807..e2da129b0 100644 --- a/src/sdk-reference/js/6/document/mUpdate/index.md +++ b/src/sdk-reference/js/6/document/mUpdate/index.md @@ -17,7 +17,7 @@ You can set the `retryOnConflict` optional argument (with a retry count), to tel ## Arguments ```javascript -mReplace (index, collection, documents, [options]) +mUpdate (index, collection, documents, [options]) ``` | Argument | Type | Description | @@ -39,9 +39,12 @@ Additional query options ## Resolves -Resolves to an array of updated documents. +Resolves to an object containing the updated documents. -## Usage +| Property | Type | Description | +| --- | --- | --- | +| `hits` |
array | Updated documents |
+| `total` | 
number
| Total updated documents | ## Usage diff --git a/src/sdk-reference/js/6/document/mUpdate/snippets/m-update.js b/src/sdk-reference/js/6/document/mUpdate/snippets/m-update.js index ff55e00cc..10a7910b9 100644 --- a/src/sdk-reference/js/6/document/mUpdate/snippets/m-update.js +++ b/src/sdk-reference/js/6/document/mUpdate/snippets/m-update.js @@ -2,8 +2,8 @@ const doc1 = { capacity: 4 }; const doc2 = { capacity: 7 }; try { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-id', doc1); - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-other-id', doc2); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', doc1, 'some-id'); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', doc2, 'some-other-id'); const documents = [ { @@ -48,4 +48,4 @@ try { console.log('Success'); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/replace/index.md b/src/sdk-reference/js/6/document/replace/index.md index 0f590f814..fe8625ea5 100644 --- a/src/sdk-reference/js/6/document/replace/index.md +++ b/src/sdk-reference/js/6/document/replace/index.md @@ -1,5 +1,5 @@ --- -layout: sdk.html +layout: sdk.html.hbs title: replace description: Replace a document --- @@ -39,7 +39,7 @@ Resolves to an object containing the the document update result. | --- | --- | --- | _id |
string
| ID of the newly created document | _version |
number
| Version of the document in the persistent data storage -| result |
string
| Set to `updated` in case of success +| _source |
object
| The updated document ## Usage diff --git a/src/sdk-reference/js/6/document/replace/snippets/replace.js b/src/sdk-reference/js/6/document/replace/snippets/replace.js index 8924196c8..be26e5ed2 100644 --- a/src/sdk-reference/js/6/document/replace/snippets/replace.js +++ b/src/sdk-reference/js/6/document/replace/snippets/replace.js @@ -1,7 +1,7 @@ const doc = { color: 'yellow' }; try { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', 'some-id', doc); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', doc, 'some-id'); const response = await kuzzle.document.replace( 'nyc-open-data', @@ -33,4 +33,4 @@ try { console.log('Success'); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/search/index.md b/src/sdk-reference/js/6/document/search/index.md index 7668236d5..303bebc25 100644 --- a/src/sdk-reference/js/6/document/search/index.md +++ b/src/sdk-reference/js/6/document/search/index.md @@ -53,7 +53,7 @@ An empty body matches all documents in the queried collection. ## Resolves -Resolves to a [SearchResult]({{ site_base_path }}src/sdk-reference/js/6/essentials/search-result) object. +Resolves to a [SearchResult]({{ site_base_path }}sdk-reference/js/6/search-result) object. ## Usage diff --git a/src/sdk-reference/js/6/document/search/snippets/search.js b/src/sdk-reference/js/6/document/search/snippets/search.js index 39e061361..2e2244643 100644 --- a/src/sdk-reference/js/6/document/search/snippets/search.js +++ b/src/sdk-reference/js/6/document/search/snippets/search.js @@ -5,10 +5,10 @@ try { const requests = []; for (let i = 0; i < 5; i++) { - requests.push(kuzzle.document.create('nyc-open-data', 'yellow-taxi', '', suv)); + requests.push(kuzzle.document.create('nyc-open-data', 'yellow-taxi', suv)); } for (let i = 5; i < 15; i++) { - requests.push(kuzzle.document.create('nyc-open-data', 'yellow-taxi', '', limousine)); + requests.push(kuzzle.document.create('nyc-open-data', 'yellow-taxi', limousine)); } await Promise.all(requests); @@ -30,4 +30,4 @@ try { console.log(`Successfully retrieved ${response.total} documents`); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/document/update/snippets/update.js b/src/sdk-reference/js/6/document/update/snippets/update.js index c4ca11fd4..76d587a5f 100644 --- a/src/sdk-reference/js/6/document/update/snippets/update.js +++ b/src/sdk-reference/js/6/document/update/snippets/update.js @@ -2,8 +2,8 @@ try { await kuzzle.document.create( 'nyc-open-data', 'yellow-taxi', - 'some-id', - { capacity: 4 } + { capacity: 4 }, + 'some-id' ); const response = await kuzzle.document.update( @@ -24,4 +24,4 @@ try { */ } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/essentials/index.md b/src/sdk-reference/js/6/essentials/index.md deleted file mode 100644 index f2db58dd8..000000000 --- a/src/sdk-reference/js/6/essentials/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: sdk.html.hbs -title: Essentials -description: Kuzzle SDKs basic concepts -order: 100 ---- diff --git a/src/sdk-reference/js/6/getting-started/node-js/index.md b/src/sdk-reference/js/6/getting-started/node-js/index.md index 4233f7d92..61f4397a8 100644 --- a/src/sdk-reference/js/6/getting-started/node-js/index.md +++ b/src/sdk-reference/js/6/getting-started/node-js/index.md @@ -1,6 +1,6 @@ --- layout: full.html.hbs -algolia: true + title: Node.js description: Getting started with Kuzzle and Node.js --- diff --git a/src/sdk-reference/js/6/getting-started/node-js/snippets/create.js b/src/sdk-reference/js/6/getting-started/node-js/snippets/create.js index 1527d7442..d843c4cec 100644 --- a/src/sdk-reference/js/6/getting-started/node-js/snippets/create.js +++ b/src/sdk-reference/js/6/getting-started/node-js/snippets/create.js @@ -27,7 +27,7 @@ const run = async () => { license: 'B' }; - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', null, driver); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', driver); console.log('New document successfully created!'); } catch (error) { console.error(error.message); diff --git a/src/sdk-reference/js/6/index/delete/index.md b/src/sdk-reference/js/6/index/delete/index.md index 73af41652..a779c2fbb 100644 --- a/src/sdk-reference/js/6/index/delete/index.md +++ b/src/sdk-reference/js/6/index/delete/index.md @@ -31,7 +31,7 @@ Additional query options ## Resolves -Resolves to a `boolean` indicating whether the index was successfully deleted in the Elasticsearch cluster. +Resolves if the index was successfully deleted in the Elasticsearch cluster. ## Usage diff --git a/src/sdk-reference/js/6/index/delete/snippets/delete.js b/src/sdk-reference/js/6/index/delete/snippets/delete.js index 7aecfa4ab..ee0771bf9 100644 --- a/src/sdk-reference/js/6/index/delete/snippets/delete.js +++ b/src/sdk-reference/js/6/index/delete/snippets/delete.js @@ -1,9 +1,5 @@ try { - const response = kuzzle.index.delete('nyc-open-data'); - console.log(response); - /* - { acknowledged: 1 } - */ + kuzzle.index.delete('nyc-open-data'); console.log('Index deleted'); } catch (error) { diff --git a/src/sdk-reference/js/6/index/refresh/index.md b/src/sdk-reference/js/6/index/refresh/index.md index 3a57f80ba..5a301abb2 100644 --- a/src/sdk-reference/js/6/index/refresh/index.md +++ b/src/sdk-reference/js/6/index/refresh/index.md @@ -44,7 +44,7 @@ Resolves to an `object` containing the refresh status on shards. | -------- | ------ | ---------------------------------------------- | | `total` |
number
| Total number of shards | | `successful` |
number
| Successfully refreshed shards | -| `fail` |
number
| Shards that failed to refresh | +| `failed` |
number
| Shards that failed to refresh | ## Usage diff --git a/src/sdk-reference/js/6/ms/append/index.md b/src/sdk-reference/js/6/ms/append/index.md index e69de29bb..e405d16ed 100644 --- a/src/sdk-reference/js/6/ms/append/index.md +++ b/src/sdk-reference/js/6/ms/append/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: append +--- + +# append + + +Appends a value to a key. If the key does not exist, it is created. + +[[_Redis documentation_]](https://redis.io/commands/append) + +## Arguments + +```js +append(key, value, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| ``key`` |
string
| Key | +| ``value`` |
string
| Value to append | +| ``options`` |
object
| Optional query 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 | + + +## Resolve + +Returns the updated value length. + +## Usage + +[snippet=append] diff --git a/src/sdk-reference/js/6/ms/bitcount/index.md b/src/sdk-reference/js/6/ms/bitcount/index.md index ad935069c..a56100ec9 100644 --- a/src/sdk-reference/js/6/ms/bitcount/index.md +++ b/src/sdk-reference/js/6/ms/bitcount/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: bitcount --- diff --git a/src/sdk-reference/js/6/ms/bitop/index.md b/src/sdk-reference/js/6/ms/bitop/index.md index fb6f36c3d..a71a32c58 100644 --- a/src/sdk-reference/js/6/ms/bitop/index.md +++ b/src/sdk-reference/js/6/ms/bitop/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: bitop --- diff --git a/src/sdk-reference/js/6/ms/bitpos/index.md b/src/sdk-reference/js/6/ms/bitpos/index.md index e69de29bb..1eef94ac6 100644 --- a/src/sdk-reference/js/6/ms/bitpos/index.md +++ b/src/sdk-reference/js/6/ms/bitpos/index.md @@ -0,0 +1,43 @@ +--- +layout: sdk.html.hbs +title: bitpos +--- + +# bitpos + +Returns the position of the first bit set to 1 or 0 in a string, or in a substring. + +[[_Redis documentation_]](https://redis.io/commands/bitpos) + +## Arguments + +```js +bitpos(key, bit, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| `bit` |
integer
| Bit to look for.
Accepted values: `0`, `1` | +| ``options`` |
object
| Optional query arguments | + +### options + +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 | +| `start` |
integer
| Search starts at the provided offset | + +## Resolve + +Resolves to the position of the first bit found matching the searched value. + +## Usage + +[snippet=bitpos] diff --git a/src/sdk-reference/js/6/ms/dbsize/index.md b/src/sdk-reference/js/6/ms/dbsize/index.md index db2a52753..75f01717f 100644 --- a/src/sdk-reference/js/6/ms/dbsize/index.md +++ b/src/sdk-reference/js/6/ms/dbsize/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: dbsize --- diff --git a/src/sdk-reference/js/6/ms/decr/index.md b/src/sdk-reference/js/6/ms/decr/index.md index 80c7354d2..d250b24e0 100644 --- a/src/sdk-reference/js/6/ms/decr/index.md +++ b/src/sdk-reference/js/6/ms/decr/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: decr --- diff --git a/src/sdk-reference/js/6/ms/decrby/index.md b/src/sdk-reference/js/6/ms/decrby/index.md index e69de29bb..dde15b9e5 100644 --- a/src/sdk-reference/js/6/ms/decrby/index.md +++ b/src/sdk-reference/js/6/ms/decrby/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: decrby +--- + +# decrby + + +Decrements the number stored at `key` by a provided integer value. If the key does not exist, it is set to 0 before performing the operation. + +[[_Redis documentation_]](https://redis.io/commands/decrby) + +## Arguments + +```js +decrby(key, decrement, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| `decrement` |
integer
| Decrement value | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the updated key value. + +## Usage + +[snippet=decrby] diff --git a/src/sdk-reference/js/6/ms/del/index.md b/src/sdk-reference/js/6/ms/del/index.md index e69de29bb..a63ac03ea 100644 --- a/src/sdk-reference/js/6/ms/del/index.md +++ b/src/sdk-reference/js/6/ms/del/index.md @@ -0,0 +1,40 @@ +--- +layout: sdk.html.hbs +title: del +--- + +# del + + +Deletes a list of keys. + +[[_Redis documentation_]](https://redis.io/commands/del) + +## Arguments + +```js +del(keys, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `keys` |
string[]
| Keys to delete | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the number of deleted keys. + +## Usage + +[snippet=del] diff --git a/src/sdk-reference/js/6/ms/exists/index.md b/src/sdk-reference/js/6/ms/exists/index.md index db25b4605..85ea914fb 100644 --- a/src/sdk-reference/js/6/ms/exists/index.md +++ b/src/sdk-reference/js/6/ms/exists/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: exists --- diff --git a/src/sdk-reference/js/6/ms/expire/index.md b/src/sdk-reference/js/6/ms/expire/index.md index e69de29bb..54c6a2ee1 100644 --- a/src/sdk-reference/js/6/ms/expire/index.md +++ b/src/sdk-reference/js/6/ms/expire/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: expire +--- + +# expire + + +Sets a timeout (in seconds) on a key. After the timeout has expired, the key is automatically deleted. + +[[_Redis documentation_]](https://redis.io/commands/expire) + +## Arguments + +```js +expire(key, seconds, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| `seconds` |
integer
| Number of seconds before the key expires | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to a boolean telling whether the operation was successful or not. + +## Usage + +[snippet=expire] diff --git a/src/sdk-reference/js/6/ms/expireat/index.md b/src/sdk-reference/js/6/ms/expireat/index.md index 9e2c023a2..7c0a3d563 100644 --- a/src/sdk-reference/js/6/ms/expireat/index.md +++ b/src/sdk-reference/js/6/ms/expireat/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: expireat --- diff --git a/src/sdk-reference/js/6/ms/flushdb/index.md b/src/sdk-reference/js/6/ms/flushdb/index.md index 20b635e55..55e84a837 100644 --- a/src/sdk-reference/js/6/ms/flushdb/index.md +++ b/src/sdk-reference/js/6/ms/flushdb/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: flushdb --- diff --git a/src/sdk-reference/js/6/ms/geoadd/index.md b/src/sdk-reference/js/6/ms/geoadd/index.md index aac6f781f..ab8526a53 100644 --- a/src/sdk-reference/js/6/ms/geoadd/index.md +++ b/src/sdk-reference/js/6/ms/geoadd/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: geoadd --- diff --git a/src/sdk-reference/js/6/ms/geodist/index.md b/src/sdk-reference/js/6/ms/geodist/index.md index e69de29bb..16a040d49 100644 --- a/src/sdk-reference/js/6/ms/geodist/index.md +++ b/src/sdk-reference/js/6/ms/geodist/index.md @@ -0,0 +1,44 @@ +--- +layout: sdk.html.hbs +title: geodist +--- + +# geodist + +Returns the distance between two geospatial members of a key (see [geoadd]({{ site_base_path }}sdk-reference/js/6/ms/geoadd/)). + +The returned distance is expressed in meters by default. + +[[_Redis documentation_]](https://redis.io/commands/geodist) + +## Arguments + +```js +geodist(key, geopoint1, geopoint2, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| `geopoint1` |
string
| First geopoint identifier | +| `geopoint2` |
string
| Second geopoint identifier | +| ``options`` |
object
| Optional query 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 | +| `unit` |
string ('m')
| The unit used for the returned calculated distance.
Accepted values: `m`, `km`, `mi`, `ft` | + +## Resolve + +Resolves to the calculated distance. + +## Usage + +[snippet=geodist] diff --git a/src/sdk-reference/js/6/ms/geohash/index.md b/src/sdk-reference/js/6/ms/geohash/index.md index 4dd31b11b..2d0de97f0 100644 --- a/src/sdk-reference/js/6/ms/geohash/index.md +++ b/src/sdk-reference/js/6/ms/geohash/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: geohash --- diff --git a/src/sdk-reference/js/6/ms/geopos/index.md b/src/sdk-reference/js/6/ms/geopos/index.md index eec7a9ba5..a6955362d 100644 --- a/src/sdk-reference/js/6/ms/geopos/index.md +++ b/src/sdk-reference/js/6/ms/geopos/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: geopos --- diff --git a/src/sdk-reference/js/6/ms/georadius/index.md b/src/sdk-reference/js/6/ms/georadius/index.md index e69de29bb..44a23c327 100644 --- a/src/sdk-reference/js/6/ms/georadius/index.md +++ b/src/sdk-reference/js/6/ms/georadius/index.md @@ -0,0 +1,57 @@ +--- +layout: sdk.html.hbs +title: georadius +--- + +# georadius + + +Returns the members (added with [geoadd]({{ site_base_path }}sdk-reference/js/6/ms/geoadd/)) of a given key inside the provided geospatial radius. + +[[_Redis documentation_]](https://redis.io/commands/georadius) + +## Arguments + +```js +georadius(key, lon, lat, dist, unit, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| `lon` |
number
| Longitude of the center | +| `lat` |
number
| Latitude of the center | +| `dist` |
number
| Distance from the center | +| `unit` |
string
| Unit of the distance parameter value.Allowed values: `m`, `km`, `mi`, `ft` | +| ``options`` |
object
| Optional query arguments | + +### options + +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 | +| `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 | + +## Resolve + +Resolves to an array of matched geopoints. + +Each returned geopoint is an object with the following properties: + +| Property | Type | Description | +| ---------- | ------- | --------------------------------- | +| `name` |
string
| Geopoint identifier | +| `coordinates` |
number[]
| Geopoint coordinates in the following format: `[lon, lat]`. Only available if the option `withcoord` is set | +| `distance` |
number
| Distance from the center. Only available if the option `withdist` is set | + +## Usage + +[snippet=georadius] diff --git a/src/sdk-reference/js/6/ms/georadiusbymember/index.md b/src/sdk-reference/js/6/ms/georadiusbymember/index.md index c6ef33336..079e1d004 100644 --- a/src/sdk-reference/js/6/ms/georadiusbymember/index.md +++ b/src/sdk-reference/js/6/ms/georadiusbymember/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: georadiusbymember --- diff --git a/src/sdk-reference/js/6/ms/get/index.md b/src/sdk-reference/js/6/ms/get/index.md index e69de29bb..d54be4de5 100644 --- a/src/sdk-reference/js/6/ms/get/index.md +++ b/src/sdk-reference/js/6/ms/get/index.md @@ -0,0 +1,39 @@ +--- +layout: sdk.html.hbs +title: get +--- + +# get + +Gets the value of a key. + +[[_Redis documentation_]](https://redis.io/commands/get) + +## Arguments + +```js +get(key, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the key's value. + +## Usage + +[snippet=get] diff --git a/src/sdk-reference/js/6/ms/getbit/index.md b/src/sdk-reference/js/6/ms/getbit/index.md index d3a80f183..14b88861c 100644 --- a/src/sdk-reference/js/6/ms/getbit/index.md +++ b/src/sdk-reference/js/6/ms/getbit/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: getbit --- diff --git a/src/sdk-reference/js/6/ms/getrange/index.md b/src/sdk-reference/js/6/ms/getrange/index.md index 954228c73..551d6635a 100644 --- a/src/sdk-reference/js/6/ms/getrange/index.md +++ b/src/sdk-reference/js/6/ms/getrange/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: getrange --- diff --git a/src/sdk-reference/js/6/ms/getset/index.md b/src/sdk-reference/js/6/ms/getset/index.md index 1273c213e..4b0f50b71 100644 --- a/src/sdk-reference/js/6/ms/getset/index.md +++ b/src/sdk-reference/js/6/ms/getset/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: getset --- diff --git a/src/sdk-reference/js/6/ms/hdel/index.md b/src/sdk-reference/js/6/ms/hdel/index.md index 6be2e3db5..6e4a8530a 100644 --- a/src/sdk-reference/js/6/ms/hdel/index.md +++ b/src/sdk-reference/js/6/ms/hdel/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hdel --- diff --git a/src/sdk-reference/js/6/ms/hexists/index.md b/src/sdk-reference/js/6/ms/hexists/index.md index 99852f2f3..25d566fef 100644 --- a/src/sdk-reference/js/6/ms/hexists/index.md +++ b/src/sdk-reference/js/6/ms/hexists/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hexists --- diff --git a/src/sdk-reference/js/6/ms/hget/index.md b/src/sdk-reference/js/6/ms/hget/index.md index e69de29bb..e87a75838 100644 --- a/src/sdk-reference/js/6/ms/hget/index.md +++ b/src/sdk-reference/js/6/ms/hget/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: hget +--- + +# hget + + +Returns the field's value of a hash. + +[[_Redis documentation_]](https://redis.io/commands/hget) + +## Arguments + +```js +hget(key, field, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Hash key | +| `field` |
string
| Field name | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Returns the field's value. + +## Usage + +[snippet=hget] diff --git a/src/sdk-reference/js/6/ms/hgetall/index.md b/src/sdk-reference/js/6/ms/hgetall/index.md index e69de29bb..f3639f8e4 100644 --- a/src/sdk-reference/js/6/ms/hgetall/index.md +++ b/src/sdk-reference/js/6/ms/hgetall/index.md @@ -0,0 +1,40 @@ +--- +layout: sdk.html.hbs +title: hgetall +--- + +# hgetall + + +Returns all fields and values of a hash. + +[[_Redis documentation_]](https://redis.io/commands/hgetall) + +## Arguments + +```js +hgetall(key, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Hash key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to an object representation of the hash. + +## Usage + +[snippet=hgetall] diff --git a/src/sdk-reference/js/6/ms/hincrby/index.md b/src/sdk-reference/js/6/ms/hincrby/index.md index e54017cc7..cde8199a3 100644 --- a/src/sdk-reference/js/6/ms/hincrby/index.md +++ b/src/sdk-reference/js/6/ms/hincrby/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hincrby --- diff --git a/src/sdk-reference/js/6/ms/hincrbyfloat/index.md b/src/sdk-reference/js/6/ms/hincrbyfloat/index.md index e69de29bb..eccc21d9a 100644 --- a/src/sdk-reference/js/6/ms/hincrbyfloat/index.md +++ b/src/sdk-reference/js/6/ms/hincrbyfloat/index.md @@ -0,0 +1,43 @@ +--- +layout: sdk.html.hbs +title: hincrbyfloat +--- + +# hincrbyfloat + + +Increments the number stored in a hash field by the provided float value. + +[[_Redis documentation_]](https://redis.io/commands/hincrbyfloat) + +## Arguments + +```js +hincrbyfloat(key, field, increment, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Hash key | +| `field` |
string
| Field name | +| `increment` |
number
| Increment value | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the updated value of the hash's field. + +## Usage + +[snippet=hincrbyfloat] diff --git a/src/sdk-reference/js/6/ms/hkeys/index.md b/src/sdk-reference/js/6/ms/hkeys/index.md index e69de29bb..0518c4a48 100644 --- a/src/sdk-reference/js/6/ms/hkeys/index.md +++ b/src/sdk-reference/js/6/ms/hkeys/index.md @@ -0,0 +1,39 @@ +--- +layout: sdk.html.hbs +title: hkeys +--- + +# hkeys + +Returns all field names contained in a hash. + +[[_Redis documentation_]](https://redis.io/commands/hkeys) + +## Arguments + +```js +hkeys(key, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Hash key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to an array of hash field names. + +## Usage + +[snippet=hkeys] diff --git a/src/sdk-reference/js/6/ms/hlen/index.md b/src/sdk-reference/js/6/ms/hlen/index.md index 382f8e4e1..9883709e7 100644 --- a/src/sdk-reference/js/6/ms/hlen/index.md +++ b/src/sdk-reference/js/6/ms/hlen/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hlen --- diff --git a/src/sdk-reference/js/6/ms/hmget/index.md b/src/sdk-reference/js/6/ms/hmget/index.md index e69de29bb..f17cb5b45 100644 --- a/src/sdk-reference/js/6/ms/hmget/index.md +++ b/src/sdk-reference/js/6/ms/hmget/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: hmget +--- + +# hmget + +Returns the values of the specified hash's fields. + +[[_Redis documentation_]](https://redis.io/commands/hmget) + +## Arguments + +```js +hmget(key, fields, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Hash key | +| `fields` |
string[]
| Field names | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the list of requested field values, in the same order than in the query. + +## Usage + +[snippet=hmget] diff --git a/src/sdk-reference/js/6/ms/hmset/index.md b/src/sdk-reference/js/6/ms/hmset/index.md index f4bb26233..bcc277b7b 100644 --- a/src/sdk-reference/js/6/ms/hmset/index.md +++ b/src/sdk-reference/js/6/ms/hmset/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hmset --- diff --git a/src/sdk-reference/js/6/ms/hscan/index.md b/src/sdk-reference/js/6/ms/hscan/index.md index 02c85d995..a8bdf3e55 100644 --- a/src/sdk-reference/js/6/ms/hscan/index.md +++ b/src/sdk-reference/js/6/ms/hscan/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hscan --- diff --git a/src/sdk-reference/js/6/ms/hset/index.md b/src/sdk-reference/js/6/ms/hset/index.md index e69de29bb..1c2784616 100644 --- a/src/sdk-reference/js/6/ms/hset/index.md +++ b/src/sdk-reference/js/6/ms/hset/index.md @@ -0,0 +1,45 @@ +--- +layout: sdk.html.hbs +title: hset +--- + +# hset + +Sets a field and its value in a hash. + +If the key does not exist, a new key holding a hash is created. + +If the field already exists, its value is overwritten. + +[[_Redis documentation_]](https://redis.io/commands/hset) + +## Arguments + +```js +hset(key, field, value, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Hash key | +| `field` |
string
| Field name | +| `value` |
string
| Field value | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves once the field has been set. + +## Usage + +[snippet=hset] diff --git a/src/sdk-reference/js/6/ms/hsetnx/index.md b/src/sdk-reference/js/6/ms/hsetnx/index.md index 209621a90..9e4c74333 100644 --- a/src/sdk-reference/js/6/ms/hsetnx/index.md +++ b/src/sdk-reference/js/6/ms/hsetnx/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hsetnx --- diff --git a/src/sdk-reference/js/6/ms/hstrlen/index.md b/src/sdk-reference/js/6/ms/hstrlen/index.md index e69de29bb..aaf4027e1 100644 --- a/src/sdk-reference/js/6/ms/hstrlen/index.md +++ b/src/sdk-reference/js/6/ms/hstrlen/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: hstrlen +--- + +# hstrlen + +Returns the string length of a field's value in a hash. + +[[_Redis documentation_]](https://redis.io/commands/hstrlen) + +## Arguments + +```js +hstrlen(key, field, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| `field` |
string
| Field name | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the field value length. + +## Usage + +[snippet=hstrlen] diff --git a/src/sdk-reference/js/6/ms/hvals/index.md b/src/sdk-reference/js/6/ms/hvals/index.md index e4b550e26..af19e09cd 100644 --- a/src/sdk-reference/js/6/ms/hvals/index.md +++ b/src/sdk-reference/js/6/ms/hvals/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: hvals --- diff --git a/src/sdk-reference/js/6/ms/incr/index.md b/src/sdk-reference/js/6/ms/incr/index.md index 41b7ab379..5e168ac0c 100644 --- a/src/sdk-reference/js/6/ms/incr/index.md +++ b/src/sdk-reference/js/6/ms/incr/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: incr --- diff --git a/src/sdk-reference/js/6/ms/incrby/index.md b/src/sdk-reference/js/6/ms/incrby/index.md index b4bf89e83..0534850ba 100644 --- a/src/sdk-reference/js/6/ms/incrby/index.md +++ b/src/sdk-reference/js/6/ms/incrby/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: incrby --- diff --git a/src/sdk-reference/js/6/ms/incrbyfloat/index.md b/src/sdk-reference/js/6/ms/incrbyfloat/index.md index 7f02d19fb..89426c1e7 100644 --- a/src/sdk-reference/js/6/ms/incrbyfloat/index.md +++ b/src/sdk-reference/js/6/ms/incrbyfloat/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: incrbyfloat --- diff --git a/src/sdk-reference/js/6/ms/keys/index.md b/src/sdk-reference/js/6/ms/keys/index.md index 5bf079e96..f67d10b08 100644 --- a/src/sdk-reference/js/6/ms/keys/index.md +++ b/src/sdk-reference/js/6/ms/keys/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: keys --- diff --git a/src/sdk-reference/js/6/ms/lindex/index.md b/src/sdk-reference/js/6/ms/lindex/index.md index ff6ad5cdd..de055a5ba 100644 --- a/src/sdk-reference/js/6/ms/lindex/index.md +++ b/src/sdk-reference/js/6/ms/lindex/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: lindex --- diff --git a/src/sdk-reference/js/6/ms/linsert/index.md b/src/sdk-reference/js/6/ms/linsert/index.md index e69de29bb..62ca0b02f 100644 --- a/src/sdk-reference/js/6/ms/linsert/index.md +++ b/src/sdk-reference/js/6/ms/linsert/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: linsert +--- + +# linsert + +Inserts a value in a list, either before or after a pivot value. + +[[_Redis documentation_]](https://redis.io/commands/linsert) + +## Arguments + +```js +linsert(key, position, pivot, value, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| List key | +| `position` |
string
| Position relative to the pivot.
Allowed values: `before`, `after` | +| `pivot` |
string
| Existing list value to use as a pivot | +| `value` |
string
| Value to insert | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the updated length of the list. + +## Usage + +[snippet=linsert] diff --git a/src/sdk-reference/js/6/ms/llen/index.md b/src/sdk-reference/js/6/ms/llen/index.md index 71a6e9fba..4d439a809 100644 --- a/src/sdk-reference/js/6/ms/llen/index.md +++ b/src/sdk-reference/js/6/ms/llen/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: llen --- diff --git a/src/sdk-reference/js/6/ms/lpop/index.md b/src/sdk-reference/js/6/ms/lpop/index.md index 84cb0e2e3..ebfe356bb 100644 --- a/src/sdk-reference/js/6/ms/lpop/index.md +++ b/src/sdk-reference/js/6/ms/lpop/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: lpop --- diff --git a/src/sdk-reference/js/6/ms/lpush/index.md b/src/sdk-reference/js/6/ms/lpush/index.md index e69de29bb..46e5e9092 100644 --- a/src/sdk-reference/js/6/ms/lpush/index.md +++ b/src/sdk-reference/js/6/ms/lpush/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: lpush +--- + +# lpush + +Prepends the specified values to a list. + +If the key does not exist, it is created holding an empty list before performing the operation. + +[[_Redis documentation_]](https://redis.io/commands/lpush) + +## Arguments + +```js +lpush(key, values, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| List key | +| `values` |
string[]
| Values to append | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the updated length of the list. + +## Usage + +[snippet=lpush] diff --git a/src/sdk-reference/js/6/ms/lpushx/index.md b/src/sdk-reference/js/6/ms/lpushx/index.md index e69de29bb..81536a459 100644 --- a/src/sdk-reference/js/6/ms/lpushx/index.md +++ b/src/sdk-reference/js/6/ms/lpushx/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: lpushx +--- + +# lpushx + +Prepends the specified value to a list, only if the key already exists and if it holds a list. + +[[_Redis documentation_]](https://redis.io/commands/lpushx) + +## Arguments + +```js +lpushx(key, value, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Existing list key | +| `value` |
string
| Value to append | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the updated list length. + +## Usage + +[snippet=lpushx] diff --git a/src/sdk-reference/js/6/ms/lrange/index.md b/src/sdk-reference/js/6/ms/lrange/index.md index 98a2a7962..5832ffc56 100644 --- a/src/sdk-reference/js/6/ms/lrange/index.md +++ b/src/sdk-reference/js/6/ms/lrange/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: lrange --- diff --git a/src/sdk-reference/js/6/ms/lrem/index.md b/src/sdk-reference/js/6/ms/lrem/index.md index 51cf98b8e..6c7c98e8d 100644 --- a/src/sdk-reference/js/6/ms/lrem/index.md +++ b/src/sdk-reference/js/6/ms/lrem/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: lrem --- diff --git a/src/sdk-reference/js/6/ms/lset/index.md b/src/sdk-reference/js/6/ms/lset/index.md index a4126c548..b8f847895 100644 --- a/src/sdk-reference/js/6/ms/lset/index.md +++ b/src/sdk-reference/js/6/ms/lset/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: lset --- diff --git a/src/sdk-reference/js/6/ms/ltrim/index.md b/src/sdk-reference/js/6/ms/ltrim/index.md index e69de29bb..5f0916c27 100644 --- a/src/sdk-reference/js/6/ms/ltrim/index.md +++ b/src/sdk-reference/js/6/ms/ltrim/index.md @@ -0,0 +1,43 @@ +--- +layout: sdk.html.hbs +title: ltrim +--- + +# ltrim + +Trims an existing list so that it will contain only the specified range of elements specified. + +[[_Redis documentation_]](https://redis.io/commands/ltrim) + +## Arguments + +```js +ltrim(key, start, stop, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| List key | +| `start` |
integer
| Starting index (inclusive) | +| `stop` |
integer
| Ending index (inclusive) | +| ``options`` |
object
| Optional query arguments | + +The `start` and `stop` arguments can be negative. In that case, the offset is calculated from the end of the list, going backward. For instance, -3 is the third element from the end of the list. + +### 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 | + +## Resolve + +Resolves once the operation is finished. + +## Usage + +[snippet=ltrim] diff --git a/src/sdk-reference/js/6/ms/mget/index.md b/src/sdk-reference/js/6/ms/mget/index.md index 9507cc3d8..4a8b84a38 100644 --- a/src/sdk-reference/js/6/ms/mget/index.md +++ b/src/sdk-reference/js/6/ms/mget/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: mget --- diff --git a/src/sdk-reference/js/6/ms/mset/index.md b/src/sdk-reference/js/6/ms/mset/index.md index e69de29bb..60f6769b7 100644 --- a/src/sdk-reference/js/6/ms/mset/index.md +++ b/src/sdk-reference/js/6/ms/mset/index.md @@ -0,0 +1,48 @@ +--- +layout: sdk.html.hbs +title: mset +--- + +# mset + +Sets the provided keys to their respective values. If a key does not exist, it is created. Otherwise, the key's value is overwritten. + +[[_Redis documentation_]](https://redis.io/commands/mset) + +## Arguments + +```js +mset(entries, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `entries` |
object[]
| List of key-value pairs to set | +| ``options`` |
object
| Optional query arguments | + +### entries + +The `entries` argument is an array of objects. Each object is a key-value pair, defined with the following properties: + +| Property | Type | Description | +|---|---|---| +| `key` |
string
| Key | +| `value` |
*
| Value | + +### 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 | + +## Resolve + +Resolves successfully once the keys are set. + +## Usage + +[snippet=mset] diff --git a/src/sdk-reference/js/6/ms/msetnx/index.md b/src/sdk-reference/js/6/ms/msetnx/index.md index 37accf706..a5fadfa18 100644 --- a/src/sdk-reference/js/6/ms/msetnx/index.md +++ b/src/sdk-reference/js/6/ms/msetnx/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: msetnx --- diff --git a/src/sdk-reference/js/6/ms/object/index.md b/src/sdk-reference/js/6/ms/object/index.md index 30d178b07..8b571bd2c 100644 --- a/src/sdk-reference/js/6/ms/object/index.md +++ b/src/sdk-reference/js/6/ms/object/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: object --- diff --git a/src/sdk-reference/js/6/ms/persist/index.md b/src/sdk-reference/js/6/ms/persist/index.md index 839b9a16f..1b8a46344 100644 --- a/src/sdk-reference/js/6/ms/persist/index.md +++ b/src/sdk-reference/js/6/ms/persist/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: persist --- diff --git a/src/sdk-reference/js/6/ms/pexpire/index.md b/src/sdk-reference/js/6/ms/pexpire/index.md index a3fdbfac1..3b69ed122 100644 --- a/src/sdk-reference/js/6/ms/pexpire/index.md +++ b/src/sdk-reference/js/6/ms/pexpire/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: pexpire --- diff --git a/src/sdk-reference/js/6/ms/pexpireat/index.md b/src/sdk-reference/js/6/ms/pexpireat/index.md index 38b7b54c5..61f6285fe 100644 --- a/src/sdk-reference/js/6/ms/pexpireat/index.md +++ b/src/sdk-reference/js/6/ms/pexpireat/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: pexpireat --- diff --git a/src/sdk-reference/js/6/ms/pfadd/index.md b/src/sdk-reference/js/6/ms/pfadd/index.md index 32908eee0..d148ad0a7 100644 --- a/src/sdk-reference/js/6/ms/pfadd/index.md +++ b/src/sdk-reference/js/6/ms/pfadd/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: pfadd --- diff --git a/src/sdk-reference/js/6/ms/pfcount/index.md b/src/sdk-reference/js/6/ms/pfcount/index.md index 793fc464f..aa27cd75d 100644 --- a/src/sdk-reference/js/6/ms/pfcount/index.md +++ b/src/sdk-reference/js/6/ms/pfcount/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: pfcount --- diff --git a/src/sdk-reference/js/6/ms/pfmerge/index.md b/src/sdk-reference/js/6/ms/pfmerge/index.md index 74a89850b..319605200 100644 --- a/src/sdk-reference/js/6/ms/pfmerge/index.md +++ b/src/sdk-reference/js/6/ms/pfmerge/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: pfmerge --- diff --git a/src/sdk-reference/js/6/ms/ping/index.md b/src/sdk-reference/js/6/ms/ping/index.md index e69de29bb..ee2c31ffe 100644 --- a/src/sdk-reference/js/6/ms/ping/index.md +++ b/src/sdk-reference/js/6/ms/ping/index.md @@ -0,0 +1,38 @@ +--- +layout: sdk.html.hbs +title: ping +--- + +# ping + +Pings the memory storage database. + +[[_Redis documentation_]](https://redis.io/commands/ping) + +## Arguments + +```js +ping([options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the string `PONG`. + +## Usage + +[snippet=ping] diff --git a/src/sdk-reference/js/6/ms/psetex/index.md b/src/sdk-reference/js/6/ms/psetex/index.md index 3fb0b069b..e580a63a5 100644 --- a/src/sdk-reference/js/6/ms/psetex/index.md +++ b/src/sdk-reference/js/6/ms/psetex/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: psetex --- diff --git a/src/sdk-reference/js/6/ms/pttl/index.md b/src/sdk-reference/js/6/ms/pttl/index.md index 6cbb2f31e..032b9594e 100644 --- a/src/sdk-reference/js/6/ms/pttl/index.md +++ b/src/sdk-reference/js/6/ms/pttl/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: pttl --- diff --git a/src/sdk-reference/js/6/ms/randomkey/index.md b/src/sdk-reference/js/6/ms/randomkey/index.md index 942220521..6c699fa47 100644 --- a/src/sdk-reference/js/6/ms/randomkey/index.md +++ b/src/sdk-reference/js/6/ms/randomkey/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: randomkey --- diff --git a/src/sdk-reference/js/6/ms/rename/index.md b/src/sdk-reference/js/6/ms/rename/index.md index 110c4abf1..ae12baaf4 100644 --- a/src/sdk-reference/js/6/ms/rename/index.md +++ b/src/sdk-reference/js/6/ms/rename/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: rename --- diff --git a/src/sdk-reference/js/6/ms/renamenx/index.md b/src/sdk-reference/js/6/ms/renamenx/index.md index e69de29bb..4f53992ec 100644 --- a/src/sdk-reference/js/6/ms/renamenx/index.md +++ b/src/sdk-reference/js/6/ms/renamenx/index.md @@ -0,0 +1,40 @@ +--- +layout: sdk.html.hbs +title: renamenx +--- + +# renamenx + +Renames a key, only if the new name is not already used. + +[[_Redis documentation_]](https://redis.io/commands/renamenx) + +## Arguments + +```js +renamenx(src, dest, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `src` |
string
| Key to rename | +| `dest` |
string
| New key name | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to a boolean telling whether the operation succeeded or not. + +## Usage + +[snippet=renamenx] diff --git a/src/sdk-reference/js/6/ms/rpop/index.md b/src/sdk-reference/js/6/ms/rpop/index.md index e83d3eb17..9817b2fea 100644 --- a/src/sdk-reference/js/6/ms/rpop/index.md +++ b/src/sdk-reference/js/6/ms/rpop/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: rpop --- diff --git a/src/sdk-reference/js/6/ms/rpoplpush/index.md b/src/sdk-reference/js/6/ms/rpoplpush/index.md index b247a4fcd..282000e17 100644 --- a/src/sdk-reference/js/6/ms/rpoplpush/index.md +++ b/src/sdk-reference/js/6/ms/rpoplpush/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: rpoplpush --- diff --git a/src/sdk-reference/js/6/ms/rpush/index.md b/src/sdk-reference/js/6/ms/rpush/index.md index 2d547b7af..2d7a55715 100644 --- a/src/sdk-reference/js/6/ms/rpush/index.md +++ b/src/sdk-reference/js/6/ms/rpush/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: rpush --- diff --git a/src/sdk-reference/js/6/ms/rpushx/index.md b/src/sdk-reference/js/6/ms/rpushx/index.md index aad81cfa6..e3ae9ea7e 100644 --- a/src/sdk-reference/js/6/ms/rpushx/index.md +++ b/src/sdk-reference/js/6/ms/rpushx/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: rpushx --- diff --git a/src/sdk-reference/js/6/ms/sadd/index.md b/src/sdk-reference/js/6/ms/sadd/index.md index 0394c4f90..add1a8004 100644 --- a/src/sdk-reference/js/6/ms/sadd/index.md +++ b/src/sdk-reference/js/6/ms/sadd/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: sadd --- diff --git a/src/sdk-reference/js/6/ms/scan/index.md b/src/sdk-reference/js/6/ms/scan/index.md index f99e177de..2aa040ef0 100644 --- a/src/sdk-reference/js/6/ms/scan/index.md +++ b/src/sdk-reference/js/6/ms/scan/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: scan --- diff --git a/src/sdk-reference/js/6/ms/scard/index.md b/src/sdk-reference/js/6/ms/scard/index.md index ff39ad599..2848e4d23 100644 --- a/src/sdk-reference/js/6/ms/scard/index.md +++ b/src/sdk-reference/js/6/ms/scard/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: scard --- diff --git a/src/sdk-reference/js/6/ms/sdiff/index.md b/src/sdk-reference/js/6/ms/sdiff/index.md index e69de29bb..e4b047874 100644 --- a/src/sdk-reference/js/6/ms/sdiff/index.md +++ b/src/sdk-reference/js/6/ms/sdiff/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: sdiff +--- + +# sdiff + +Returns the difference between a reference set and a list of other sets. + +[[_Redis documentation_]](https://redis.io/commands/sdiff) + +## Arguments + +```js +sdiff(ref, sets, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `ref` |
string
| Set key of reference | +| `sets` |
string[]
| List of sets to compare to the reference | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to an array of differences. + +## Usage + +[snippet=sdiff] diff --git a/src/sdk-reference/js/6/ms/sdiffstore/index.md b/src/sdk-reference/js/6/ms/sdiffstore/index.md index e69de29bb..0d7b0eabb 100644 --- a/src/sdk-reference/js/6/ms/sdiffstore/index.md +++ b/src/sdk-reference/js/6/ms/sdiffstore/index.md @@ -0,0 +1,44 @@ +--- +layout: sdk.html.hbs +title: sdiffstore +--- + +# sdiffstore + +Computes the difference between a reference set of unique values, and other sets. The differences are then stored in the provided destination key. + +If the destination key already exists, it is overwritten. + +[[_Redis documentation_]](https://redis.io/commands/sdiffstore) + +## Arguments + +```js +sdiffstore(ref, sets, dest, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `ref` |
string
| Set key of reference | +| `sets` |
string[]
| List of sets to compare to the reference | +| `dest` |
string
| Destination key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the number of values stored at the new key. + +## Usage + +[snippet=sdiffstore] diff --git a/src/sdk-reference/js/6/ms/set/index.md b/src/sdk-reference/js/6/ms/set/index.md index 162fde1a2..4589ffacf 100644 --- a/src/sdk-reference/js/6/ms/set/index.md +++ b/src/sdk-reference/js/6/ms/set/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: set --- diff --git a/src/sdk-reference/js/6/ms/setex/index.md b/src/sdk-reference/js/6/ms/setex/index.md index 8d85383c7..c49cbbd8a 100644 --- a/src/sdk-reference/js/6/ms/setex/index.md +++ b/src/sdk-reference/js/6/ms/setex/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: setex --- diff --git a/src/sdk-reference/js/6/ms/setnx/index.md b/src/sdk-reference/js/6/ms/setnx/index.md index 4592106b9..a31709ebf 100644 --- a/src/sdk-reference/js/6/ms/setnx/index.md +++ b/src/sdk-reference/js/6/ms/setnx/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: setnx --- diff --git a/src/sdk-reference/js/6/ms/sinter/index.md b/src/sdk-reference/js/6/ms/sinter/index.md index e69de29bb..078592ea5 100644 --- a/src/sdk-reference/js/6/ms/sinter/index.md +++ b/src/sdk-reference/js/6/ms/sinter/index.md @@ -0,0 +1,39 @@ +--- +layout: sdk.html.hbs +title: sinter +--- + +# sinter + +Returns the intersection of the provided sets of unique values. + +[[_Redis documentation_]](https://redis.io/commands/sinter) + +## Arguments + +```js +sinter(keys, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `keys` |
string[]
| List of set keys to intersect | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to an array of intersected values. + +## Usage + +[snippet=sinter] diff --git a/src/sdk-reference/js/6/ms/sinterstore/index.md b/src/sdk-reference/js/6/ms/sinterstore/index.md index 2948d24f5..f14f6c75e 100644 --- a/src/sdk-reference/js/6/ms/sinterstore/index.md +++ b/src/sdk-reference/js/6/ms/sinterstore/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: sinterstore --- diff --git a/src/sdk-reference/js/6/ms/sismember/index.md b/src/sdk-reference/js/6/ms/sismember/index.md index e69de29bb..242cad897 100644 --- a/src/sdk-reference/js/6/ms/sismember/index.md +++ b/src/sdk-reference/js/6/ms/sismember/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: sismember +--- + +# sismember + +Checks if a value is a member of a set of unique values. + +[[_Redis documentation_]](https://redis.io/commands/sismember) + +## Arguments + +```js +sismember(key, value, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Set key | +| `value` |
string
| Value to check | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to a boolean telling if the value is in the set or not. + +## Usage + +[snippet=sismember] diff --git a/src/sdk-reference/js/6/ms/smembers/index.md b/src/sdk-reference/js/6/ms/smembers/index.md index 4e0f6357a..ed95df149 100644 --- a/src/sdk-reference/js/6/ms/smembers/index.md +++ b/src/sdk-reference/js/6/ms/smembers/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: smembers --- diff --git a/src/sdk-reference/js/6/ms/smove/index.md b/src/sdk-reference/js/6/ms/smove/index.md index d51f2864f..9bac6cd62 100644 --- a/src/sdk-reference/js/6/ms/smove/index.md +++ b/src/sdk-reference/js/6/ms/smove/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: smove --- diff --git a/src/sdk-reference/js/6/ms/sort/index.md b/src/sdk-reference/js/6/ms/sort/index.md index 6ae195580..72a1ac55c 100644 --- a/src/sdk-reference/js/6/ms/sort/index.md +++ b/src/sdk-reference/js/6/ms/sort/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: sort --- diff --git a/src/sdk-reference/js/6/ms/spop/index.md b/src/sdk-reference/js/6/ms/spop/index.md index faef63324..d20b4057f 100644 --- a/src/sdk-reference/js/6/ms/spop/index.md +++ b/src/sdk-reference/js/6/ms/spop/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: spop --- diff --git a/src/sdk-reference/js/6/ms/srandmember/index.md b/src/sdk-reference/js/6/ms/srandmember/index.md index e69de29bb..1c87c7729 100644 --- a/src/sdk-reference/js/6/ms/srandmember/index.md +++ b/src/sdk-reference/js/6/ms/srandmember/index.md @@ -0,0 +1,38 @@ +--- +layout: sdk.html.hbs +title: srandmember +--- + +# srandmember + +Returns one or more members of a set of unique values, at random. + +[[_Redis documentation_]](https://redis.io/commands/srandmember) + +## Arguments + +```js +srandmember(key, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Set key | +| ``options`` |
object
| Optional query arguments | + +### options + +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 | + +## Resolve + +## Usage + +[snippet=srandmember] diff --git a/src/sdk-reference/js/6/ms/srem/index.md b/src/sdk-reference/js/6/ms/srem/index.md index 4f51668ff..8c4b947ad 100644 --- a/src/sdk-reference/js/6/ms/srem/index.md +++ b/src/sdk-reference/js/6/ms/srem/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: srem --- diff --git a/src/sdk-reference/js/6/ms/sscan/index.md b/src/sdk-reference/js/6/ms/sscan/index.md index 1677084e5..4748ef6c4 100644 --- a/src/sdk-reference/js/6/ms/sscan/index.md +++ b/src/sdk-reference/js/6/ms/sscan/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: sscan --- diff --git a/src/sdk-reference/js/6/ms/strlen/index.md b/src/sdk-reference/js/6/ms/strlen/index.md index e69de29bb..ae3994dd1 100644 --- a/src/sdk-reference/js/6/ms/strlen/index.md +++ b/src/sdk-reference/js/6/ms/strlen/index.md @@ -0,0 +1,39 @@ +--- +layout: sdk.html.hbs +title: strlen +--- + +# strlen + +Returns the length of a value. + +[[_Redis documentation_]](https://redis.io/commands/strlen) + +## Arguments + +```js +strlen(key, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the value's length. + +## Usage + +[snippet=strlen] diff --git a/src/sdk-reference/js/6/ms/sunion/index.md b/src/sdk-reference/js/6/ms/sunion/index.md index e69de29bb..4cd787b41 100644 --- a/src/sdk-reference/js/6/ms/sunion/index.md +++ b/src/sdk-reference/js/6/ms/sunion/index.md @@ -0,0 +1,39 @@ +--- +layout: sdk.html.hbs +title: sunion +--- + +# sunion + +Returns the union of sets of unique values. + +[[_Redis documentation_]](https://redis.io/commands/sunion) + +## Arguments + +```js +sunion(keys, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `keys` |
string[]
| List of set keys | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the result of the union between the provided sets. + +## Usage + +[snippet=sunion] diff --git a/src/sdk-reference/js/6/ms/sunionstore/index.md b/src/sdk-reference/js/6/ms/sunionstore/index.md index bcdf3494e..2ba323c40 100644 --- a/src/sdk-reference/js/6/ms/sunionstore/index.md +++ b/src/sdk-reference/js/6/ms/sunionstore/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: sunionstore --- diff --git a/src/sdk-reference/js/6/ms/time/index.md b/src/sdk-reference/js/6/ms/time/index.md index 518754fc8..5ef63759a 100644 --- a/src/sdk-reference/js/6/ms/time/index.md +++ b/src/sdk-reference/js/6/ms/time/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: time --- diff --git a/src/sdk-reference/js/6/ms/touch/index.md b/src/sdk-reference/js/6/ms/touch/index.md index e69de29bb..20eb69120 100644 --- a/src/sdk-reference/js/6/ms/touch/index.md +++ b/src/sdk-reference/js/6/ms/touch/index.md @@ -0,0 +1,39 @@ +--- +layout: sdk.html.hbs +title: touch +--- + +# touch + +Alters the last access time of the provided keys. A key is ignored if it does not exist. + +[[_Redis documentation_]](https://redis.io/commands/touch) + +## Arguments + +```js +touch(keys, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `keys` |
string[]
| List of keys to alter | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the number of altered keys. + +## Usage + +[snippet=touch] diff --git a/src/sdk-reference/js/6/ms/ttl/index.md b/src/sdk-reference/js/6/ms/ttl/index.md index e69de29bb..6e4c62762 100644 --- a/src/sdk-reference/js/6/ms/ttl/index.md +++ b/src/sdk-reference/js/6/ms/ttl/index.md @@ -0,0 +1,40 @@ +--- +layout: sdk.html.hbs +title: ttl +--- + +# ttl + +Returns the remaining time to live of a key, in seconds. + +[[_Redis documentation_]](https://redis.io/commands/ttl) + + +## Arguments + +```js +ttl(key, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the remaining key TTL, in seconds, or to a negative value if the key does not exist or if it is persistent. + +## Usage + +[snippet=ttl] diff --git a/src/sdk-reference/js/6/ms/type/index.md b/src/sdk-reference/js/6/ms/type/index.md index 33333906c..2a6ae1d24 100644 --- a/src/sdk-reference/js/6/ms/type/index.md +++ b/src/sdk-reference/js/6/ms/type/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: type --- diff --git a/src/sdk-reference/js/6/ms/zadd/index.md b/src/sdk-reference/js/6/ms/zadd/index.md index 1663b8dab..818db2ccb 100644 --- a/src/sdk-reference/js/6/ms/zadd/index.md +++ b/src/sdk-reference/js/6/ms/zadd/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zadd --- diff --git a/src/sdk-reference/js/6/ms/zcard/index.md b/src/sdk-reference/js/6/ms/zcard/index.md index e69de29bb..52ea02e2a 100644 --- a/src/sdk-reference/js/6/ms/zcard/index.md +++ b/src/sdk-reference/js/6/ms/zcard/index.md @@ -0,0 +1,40 @@ +--- +layout: sdk.html.hbs +title: zcard +--- + +# zcard + +Returns the number of elements held by a sorted set. + +[[_Redis documentation_]](https://redis.io/commands/zcard) + +## Arguments + +```js +zcard(key, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Sorted set key | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the number of elements in the sorted set. + +## Usage + +[snippet=zcard] diff --git a/src/sdk-reference/js/6/ms/zcount/index.md b/src/sdk-reference/js/6/ms/zcount/index.md index e69de29bb..1896619c8 100644 --- a/src/sdk-reference/js/6/ms/zcount/index.md +++ b/src/sdk-reference/js/6/ms/zcount/index.md @@ -0,0 +1,41 @@ +--- +layout: sdk.html.hbs +title: zcount +--- + +# zcount + +Returns the number of elements held by a sorted set with a score within the provided range. + +[[_Redis documentation_]](https://redis.io/commands/zcount) + +## Arguments + +```js +zcount(key, min, max, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Sorted set key | +| `min` |
string
| Minimum range value | +| `max` |
string
| Maximum range value | +| ``options`` |
object
| Optional query arguments | + +By default, the provided min and max values are inclusive. This behavior can be changed using the syntax described in the Redis [ZRANGEBYSCORE](https://redis.io/commands/zrangebyscore#exclusive-intervals-and-infinity) documentation. + +### 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 | + +## Resolve + +## Usage + +[snippet=zcount] diff --git a/src/sdk-reference/js/6/ms/zincrby/index.md b/src/sdk-reference/js/6/ms/zincrby/index.md index 76564c3ad..3189e24f6 100644 --- a/src/sdk-reference/js/6/ms/zincrby/index.md +++ b/src/sdk-reference/js/6/ms/zincrby/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zincrby --- diff --git a/src/sdk-reference/js/6/ms/zinterstore/index.md b/src/sdk-reference/js/6/ms/zinterstore/index.md index e69de29bb..3378b15e3 100644 --- a/src/sdk-reference/js/6/ms/zinterstore/index.md +++ b/src/sdk-reference/js/6/ms/zinterstore/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: zinterstore +--- + +# zinterstore + +Computes the intersection of the provided sorted sets, and stores the result in a new sorted set. + +[[_Redis documentation_]](https://redis.io/commands/zinterstore) + +## Arguments + +```js +zinterstore(dest, sources, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `dest` |
string
| Target sorted set key | +| `sources` |
string[]
| List of sorted set keys to intersect | +| ``options`` |
object
| Optional query arguments | + +### options + +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 | +| `weights` |
integer[]
| List of multiplication factors to apply to sources sets, before aggregation. | + +## Resolve + +Resolves to the number of members added to the destination sorted set. + +## Usage + +[snippet=zinterstore] diff --git a/src/sdk-reference/js/6/ms/zlexcount/index.md b/src/sdk-reference/js/6/ms/zlexcount/index.md index c674b078d..8fa5496c5 100644 --- a/src/sdk-reference/js/6/ms/zlexcount/index.md +++ b/src/sdk-reference/js/6/ms/zlexcount/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zlexcount --- diff --git a/src/sdk-reference/js/6/ms/zrange/index.md b/src/sdk-reference/js/6/ms/zrange/index.md index 61d83c71c..e7102d1e4 100644 --- a/src/sdk-reference/js/6/ms/zrange/index.md +++ b/src/sdk-reference/js/6/ms/zrange/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrange --- diff --git a/src/sdk-reference/js/6/ms/zrangebylex/index.md b/src/sdk-reference/js/6/ms/zrangebylex/index.md index b7283c12b..9c7243d95 100644 --- a/src/sdk-reference/js/6/ms/zrangebylex/index.md +++ b/src/sdk-reference/js/6/ms/zrangebylex/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrangebylex --- diff --git a/src/sdk-reference/js/6/ms/zrangebyscore/index.md b/src/sdk-reference/js/6/ms/zrangebyscore/index.md index cdac8b297..a7f791ee7 100644 --- a/src/sdk-reference/js/6/ms/zrangebyscore/index.md +++ b/src/sdk-reference/js/6/ms/zrangebyscore/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrangebyscore --- diff --git a/src/sdk-reference/js/6/ms/zrank/index.md b/src/sdk-reference/js/6/ms/zrank/index.md index f83550bb4..5b198cc8f 100644 --- a/src/sdk-reference/js/6/ms/zrank/index.md +++ b/src/sdk-reference/js/6/ms/zrank/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrank --- diff --git a/src/sdk-reference/js/6/ms/zrem/index.md b/src/sdk-reference/js/6/ms/zrem/index.md index c3b43a319..e47171008 100644 --- a/src/sdk-reference/js/6/ms/zrem/index.md +++ b/src/sdk-reference/js/6/ms/zrem/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrem --- diff --git a/src/sdk-reference/js/6/ms/zremrangebylex/index.md b/src/sdk-reference/js/6/ms/zremrangebylex/index.md index 657b4dcca..a6fac07c7 100644 --- a/src/sdk-reference/js/6/ms/zremrangebylex/index.md +++ b/src/sdk-reference/js/6/ms/zremrangebylex/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zremrangebylex --- diff --git a/src/sdk-reference/js/6/ms/zremrangebyrank/index.md b/src/sdk-reference/js/6/ms/zremrangebyrank/index.md index 71f67bfce..8b9444137 100644 --- a/src/sdk-reference/js/6/ms/zremrangebyrank/index.md +++ b/src/sdk-reference/js/6/ms/zremrangebyrank/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zremrangebyrank --- diff --git a/src/sdk-reference/js/6/ms/zremrangebyscore/index.md b/src/sdk-reference/js/6/ms/zremrangebyscore/index.md index e69de29bb..1a4ccdd71 100644 --- a/src/sdk-reference/js/6/ms/zremrangebyscore/index.md +++ b/src/sdk-reference/js/6/ms/zremrangebyscore/index.md @@ -0,0 +1,44 @@ +--- +layout: sdk.html.hbs +title: zremrangebyscore +--- + +# zremrangebyscore + +Removes members from a sorted set, with a score between the provided interval. + +[[_Redis documentation_]](https://redis.io/commands/zremrangebylex) + +## Arguments + +```js +zremrangebyscore(key, min, max, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Sorted set key | +| `min` |
string
| Minimum score value | +| `max` |
string
| Maximum score value | +| ``options`` |
object
| Optional query arguments | + +By default, `min` and `max` are inclusive. Check the full Redis documentation for other options. + +### 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 | + +## Resolve + +Resolves to the number of removed elements. + +## Usage + +[snippet=zremrangebyscore] diff --git a/src/sdk-reference/js/6/ms/zrevrange/index.md b/src/sdk-reference/js/6/ms/zrevrange/index.md index ecaac5beb..8e313f999 100644 --- a/src/sdk-reference/js/6/ms/zrevrange/index.md +++ b/src/sdk-reference/js/6/ms/zrevrange/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrevrange --- diff --git a/src/sdk-reference/js/6/ms/zrevrangebylex/index.md b/src/sdk-reference/js/6/ms/zrevrangebylex/index.md index 27dc59cd3..28d92048b 100644 --- a/src/sdk-reference/js/6/ms/zrevrangebylex/index.md +++ b/src/sdk-reference/js/6/ms/zrevrangebylex/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zrevrangebylex --- diff --git a/src/sdk-reference/js/6/ms/zrevrangebyscore/index.md b/src/sdk-reference/js/6/ms/zrevrangebyscore/index.md index e69de29bb..878aab1ee 100644 --- a/src/sdk-reference/js/6/ms/zrevrangebyscore/index.md +++ b/src/sdk-reference/js/6/ms/zrevrangebyscore/index.md @@ -0,0 +1,43 @@ +--- +layout: sdk.html.hbs +title: zrevrangebyscore +--- + +# zrevrangebyscore + +Identical to [zrangebyscore]({{ site_base_path }}api/1/controller-memory-storage/zrangebyscore), except that the sorted set is traversed in descending order. + +[[_Redis documentation_]](https://redis.io/commands/zrevrangebyscore) + +## Arguments + +```js +zrevrangebyscore(key, min, max, [options]) + +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Sorted set key | +| `min` |
string
| Minimum score value | +| `max` |
string
| Maximum score value | +| ``options`` |
object
| Optional query arguments | + +### options + +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 | + +## Resolve + +Resolves to the list of elements in the provided score range, in descending order. + +## Usage + +[snippet=zrevrangebyscore] diff --git a/src/sdk-reference/js/6/ms/zrevrank/index.md b/src/sdk-reference/js/6/ms/zrevrank/index.md index e69de29bb..4f7b843eb 100644 --- a/src/sdk-reference/js/6/ms/zrevrank/index.md +++ b/src/sdk-reference/js/6/ms/zrevrank/index.md @@ -0,0 +1,40 @@ +--- +layout: sdk.html.hbs +title: zrevrank +--- + +# zrevrank + +Returns the position of an element in a sorted set, with scores in descending order. The index returned is 0-based (the lowest score member has an index of 0). + +[[_Redis documentation_]](https://redis.io/commands/zrevrank) + +## Arguments + +```js +zrevrank(key, member, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Sorted set key | +| `member` |
string
| Member value | +| ``options`` |
object
| Optional query 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 | + +## Resolve + +Resolves to the index of the found member in the sorted set, or to `null` if the member is not found. + +## Usage + +[snippet=zrevrank] diff --git a/src/sdk-reference/js/6/ms/zscan/index.md b/src/sdk-reference/js/6/ms/zscan/index.md index e69de29bb..32f524be4 100644 --- a/src/sdk-reference/js/6/ms/zscan/index.md +++ b/src/sdk-reference/js/6/ms/zscan/index.md @@ -0,0 +1,52 @@ +--- +layout: sdk.html.hbs +title: zscan +--- + +# zscan + +Iterates incrementally over members contained in a sorted set, using a cursor. + +An iteration starts when the cursor is set to 0. +To get the next page of results, simply re-send the request with the updated cursor position provided in the result set. + +The scan ends when the cursor returned by the server is 0. + +[[_Redis documentation_]](https://redis.io/commands/sscan) + +## Arguments + +```js +zscan(key, cursor, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `key` |
string
| Sorted set key | +| `cursor` |
integer
| Cursor offset | +| ``options`` |
object
| Optional query arguments | + +### options + +The `options` arguments can contain the following option properties: + +| Property | Type (default) | Description | +| ---------- | ------- | --------------------------------- | +| `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 | + +## Resolve + +Resolves to an object representing a result page, with the following properties: + +| Property | Type | Description | +| ---------- | ------- | --------------------------------- | +| `cursor` |
integer
| Cursor offset for the next page, or `0` if at the end of the scan | +| `values` |
string[]
| List of member-score pairs. The array entries alternate between member values and their associated scores | + +## Usage + +[snippet=zscan] diff --git a/src/sdk-reference/js/6/ms/zscore/index.md b/src/sdk-reference/js/6/ms/zscore/index.md index 5cc27a0a8..b47cb802f 100644 --- a/src/sdk-reference/js/6/ms/zscore/index.md +++ b/src/sdk-reference/js/6/ms/zscore/index.md @@ -1,6 +1,5 @@ --- layout: sdk.html.hbs - title: zscore --- diff --git a/src/sdk-reference/js/6/ms/zunionstore/index.md b/src/sdk-reference/js/6/ms/zunionstore/index.md index e69de29bb..b1b7058aa 100644 --- a/src/sdk-reference/js/6/ms/zunionstore/index.md +++ b/src/sdk-reference/js/6/ms/zunionstore/index.md @@ -0,0 +1,42 @@ +--- +layout: sdk.html.hbs +title: zunionstore +--- + +# zunionstore + +Computes the union of the provided sorted sets, and stores the result in a new sorted set. + +[[_Redis documentation_]](https://redis.io/commands/zunionstore) + +## Arguments + +```js +zunionstore(dest, sources, [options]) +``` + +
+ +| Arguments | Type | Description | +|--------------|---------|-------------| +| `dest` |
string
| Target sorted set key | +| `sources` |
string[]
| List of sorted set keys to join | +| ``options`` |
object
| Optional query arguments | + +### options + +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 | +| `weights` |
integer[]
| List of multiplication factors to apply to sources sets, before aggregation. | + +## Resolve + +Resolves to the number of members added to the destination sorted set. + +## Usage + +[snippet=zunionstore] diff --git a/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications-leave-scope.js b/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications-leave-scope.js index b7ce93320..f0eecc0f1 100644 --- a/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications-leave-scope.js +++ b/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications-leave-scope.js @@ -38,7 +38,6 @@ try { const { _id } = await kuzzle.document.create( 'nyc-open-data', 'yellow-taxi', - null, document ); diff --git a/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications.js b/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications.js index 4323ebeac..10e4c4231 100644 --- a/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications.js +++ b/src/sdk-reference/js/6/realtime/subscribe/snippets/document-notifications.js @@ -40,7 +40,7 @@ try { await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', filters, callback); const document = { name: 'nina vkote', age: 19 }; - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', null, document); + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', document); } catch (error) { console.log(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/realtime/unsubscribe/index.md b/src/sdk-reference/js/6/realtime/unsubscribe/index.md index c51723e2c..f887be2cd 100644 --- a/src/sdk-reference/js/6/realtime/unsubscribe/index.md +++ b/src/sdk-reference/js/6/realtime/unsubscribe/index.md @@ -29,6 +29,10 @@ Additional query options | ---------- | ------- | --------------------------------- | | `queuable` |
bool

(`true`) | Make this request queuable or not | +## Resolves + +Resolves if successfuly unsubscribed. + ## Usage [snippet=unsubscribe] diff --git a/src/sdk-reference/js/6/search-result/index.md b/src/sdk-reference/js/6/search-result/index.md index 58819879c..1b715cad1 100644 --- a/src/sdk-reference/js/6/search-result/index.md +++ b/src/sdk-reference/js/6/search-result/index.md @@ -12,11 +12,11 @@ When performing a [search]({{ site_base_path }}sdk-reference/js/6/document/searc | Property | Type | Description | |--- |--- |--- | -| `aggregations` |
string
| The search` aggregations if any | +| `aggregations` |
object
| Search aggregations if any | | `hits` |
string
| A JSON string containing the retrieved items for the current page | -| `total` |
int
| The total number of items matching the given query in Kuzzle database | -| `fetched` |
int
| The number of retrieved items so far | -| `scroll_id` |
string
| A scroll identifier if the search was given a `scroll` parameter | +| `total` |
int
| Total number of items matching the given query in Kuzzle database | +| `fetched` |
int
| Number of retrieved items so far | +| `scroll_id` |
string
| Scroll identifier if the search was given a `scroll` parameter | ## Methods @@ -75,4 +75,4 @@ Because this method does not freeze the research between two calls, if some upda ## Usage -[snippet=search-result] \ No newline at end of file +[snippet=search-result] diff --git a/src/sdk-reference/js/6/search-result/snippets/search-result.js b/src/sdk-reference/js/6/search-result/snippets/search-result.js index dbb8535e5..a10fa7e37 100644 --- a/src/sdk-reference/js/6/search-result/snippets/search-result.js +++ b/src/sdk-reference/js/6/search-result/snippets/search-result.js @@ -1,11 +1,11 @@ try { for (let i = 0; i < 5; i++) { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', '', { + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', { category: 'suv' }); } for (let i = 5; i < 15; i++) { - await kuzzle.document.create('nyc-open-data', 'yellow-taxi', '', { + await kuzzle.document.create('nyc-open-data', 'yellow-taxi', { category: 'limousine' }); } @@ -28,4 +28,4 @@ try { console.log(nextResponse); } catch (error) { console.error(error.message); -} \ No newline at end of file +} diff --git a/src/sdk-reference/js/6/server/now/index.md b/src/sdk-reference/js/6/server/now/index.md index 8a2898b6b..e0a24c495 100644 --- a/src/sdk-reference/js/6/server/now/index.md +++ b/src/sdk-reference/js/6/server/now/index.md @@ -30,7 +30,7 @@ Additional query options ## Resolve -Resolves to the current server timestamp in Epoch-millis format. +Resolves to a number representing the current server timestamp in Epoch-millis format. ## Usage