query
+ Integer from
+ Integer size,
+ Lang lang) throws NotConnectedException, InternalException
+```
+
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `query` | Map
| Search query |
+| `from` | Integer
(`0`) | (optional) Offset of the first document to fetch |
+| `size` | Integer
| (optional) Maximum number of documents to retrieve per page |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
+
+### query
+
+The search query to apply to API keys content, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
+
+If left empty, the result will return all available API keys for the currently logged user.
+
+## Return
+
+Returns a [SearchResult](/sdk/jvm/1/core-classes/search-result) object.
+
+
+## Usage
+
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/search-api-keys-es-java.java
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/search-api-keys-koncorde-java.java
+
+:::
+::: tab Kotlin
+
+## Arguments
+
+```kotlin
+fun searchApiKeys(
+ query: Map,
+ from: Int = 0,
+ size: Int? = null,
+ lang: Lang = Lang.ELASTICSEARCH): CompletableFuture
+```
+
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `query` | Map
| Search query |
+| `from` | Int
(`0`) | (optional) Offset of the first document to fetch |
+| `size` | Int
| (optional) Maximum number of documents to retrieve per page |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
+
+### query
+
+The search query to apply to API keys content, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
+
+If left empty, the result will return all available API keys of the currently logged user.
+
+## Return
+
+Returns a [SearchResult](/sdk/jvm/1/core-classes/search-result) object.
+
+
+## Usage
+
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/search-api-keys-es-kotlin.kt
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/search-api-keys-koncorde-kotlin.kt
+
+:::
+::::
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-java.java b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-java.java
new file mode 100644
index 00000000..09cd5ac2
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-java.java
@@ -0,0 +1,69 @@
+
+Map description = new HashMap<>();
+description.put("description", "LoRa permanent API Key");
+
+Map query = new HashMap<>();
+query.put("controller", "security");
+query.put("action", "createApiKey");
+query.put("userId", "jared.doe");
+query.put("refresh", "wait_for");
+query.put("body", description);
+
+kuzzle.query(query).get();
+
+description.put("description", "Sigfox API key");
+query.put("body", description);
+kuzzle.query(query).get();
+
+description.put("description", "LoRa 6 month API key");
+query.put("body", description);
+query.put("expiresIn", 36000);
+kuzzle.query(query).get();
+
+Map credentials = new HashMap<>();
+credentials.put("username", "jared.doe");
+credentials.put("password", "password");
+
+kuzzle.getAuthController().login("local", credentials).get();
+
+Map match = new HashMap<>();
+match.put("description", "LoRa");
+
+Map squery = new HashMap<>();
+squery.put("match", match);
+
+SearchResult results = kuzzle
+ .getAuthController()
+ .searchApiKeys(squery).get();
+
+String output = String.format("Found %d API keys matching 'LoRa'", results.total);
+
+System.out.println(output);
+
+/*
+{
+ "total"=2,
+ "hits"=[
+ {
+ "_id"="znEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa permanent API key",
+ "userId"="jared.doe",
+ "expiresAt"=-1,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=-1
+ }
+ },
+ {
+ "_id"="zXEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa 6 month API key",
+ "userId"="jared.doe",
+ "expiresAt"=31557600000,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=360000
+ }
+ }
+ ]
+}
+*/
\ No newline at end of file
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-java.test.yml b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-java.test.yml
new file mode 100644
index 00000000..89ef873c
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-java.test.yml
@@ -0,0 +1,20 @@
+name: java-auth#searchApiKeys-es
+description: Searches API keys for the currently logged user.
+hooks:
+ before: >
+ curl --fail -H "Content-type: application/json" -d '{
+ "content": {
+ "profileIds": ["default"]
+ },
+ "credentials": {
+ "local": {
+ "username": "jared.doe",
+ "password": "password"
+ }
+ }
+ }' "kuzzle:7512/users/jared.doe/_create?refresh=wait_for"
+ after:
+ curl -XDELETE kuzzle:7512/users/jared.doe
+template: default
+expected:
+ - Found 2 API keys matching 'LoRa'
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-kotlin.kt b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-kotlin.kt
new file mode 100644
index 00000000..6d1b2106
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-kotlin.kt
@@ -0,0 +1,72 @@
+
+val description: HashMap = HashMap().apply {
+ put("description", "LoRa permanent API Key")
+}
+
+val query: HashMap = HashMap().apply {
+ put("controller", "security")
+ put("action", "createApiKey")
+ put("userId", "jared.doe")
+ put("refresh", "wait_for")
+ put("body", description)
+}
+
+kuzzle.query(query).get()
+
+description.put("description", "Sigfox API key")
+query.put("body", description);
+kuzzle.query(query).get()
+
+description.put("description", "LoRa 6 month API key")
+query.put("body", description);
+query.put("expiresIn", 36000);
+kuzzle.query(query).get()
+
+kuzzle.authController.login("local", HashMap().apply {
+ put("username", "jared.doe")
+ put("password", "password")
+ }).get()
+
+val match: HashMap =
+ HashMap().apply {
+ put("description", "LoRa")
+ }
+
+val squery: HashMap =
+ HashMap().apply {
+ put("match", match)
+ }
+
+val results = kuzzle
+ .authController
+ .searchApiKeys(squery).get();
+
+print("Found ${results.total} API keys matching 'LoRa'");
+
+/*
+{
+ "total"=2,
+ "hits"=[
+ {
+ "_id"="znEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa permanent API key",
+ "userId"="jared.doe",
+ "expiresAt"=-1,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=-1
+ }
+ },
+ {
+ "_id"="zXEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa 6 month API key",
+ "userId"="jared.doe",
+ "expiresAt"=31557600000,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=360000
+ }
+ }
+ ]
+}
+*/
\ No newline at end of file
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-kotlin.test.yml b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-kotlin.test.yml
new file mode 100644
index 00000000..ceb857f1
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-es-kotlin.test.yml
@@ -0,0 +1,20 @@
+name: kotlin-auth#searchApiKeys-es
+description: Searches API keys for the currently logged user.
+hooks:
+ before: >
+ curl --fail -H "Content-type: application/json" -d '{
+ "content": {
+ "profileIds": ["default"]
+ },
+ "credentials": {
+ "local": {
+ "username": "jared.doe",
+ "password": "password"
+ }
+ }
+ }' "kuzzle:7512/users/jared.doe/_create?refresh=wait_for"
+ after:
+ curl -XDELETE kuzzle:7512/users/jared.doe
+template: default
+expected:
+ - Found 2 API keys matching 'LoRa'
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-java.java b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-java.java
new file mode 100644
index 00000000..def28c28
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-java.java
@@ -0,0 +1,59 @@
+
+Map description = new HashMap<>();
+description.put("description", "LoRa permanent API Key");
+
+Map query = new HashMap<>();
+query.put("controller", "security");
+query.put("action", "createApiKey");
+query.put("userId", "jared.doe");
+query.put("refresh", "wait_for");
+query.put("body", description);
+
+kuzzle.query(query).get();
+
+description.put("description", "Sigfox API key");
+query.put("body", description);
+kuzzle.query(query).get();
+
+description.put("description", "LoRa 6 month API key");
+query.put("body", description);
+query.put("expiresIn", 36000);
+kuzzle.query(query).get();
+
+Map credentials = new HashMap<>();
+credentials.put("username", "jared.doe");
+credentials.put("password", "password");
+
+kuzzle.getAuthController().login("local", credentials).get();
+
+Map equals = new HashMap<>();
+equals.put("ttl", "36000");
+
+Map squery = new HashMap<>();
+squery.put("equals", equals);
+
+SearchResult results = kuzzle
+ .getAuthController()
+ .searchApiKeys(squery, Lang.KONCORDE).get();
+
+String output = String.format("Found %d API key", results.total);
+
+System.out.println(output);
+
+/*
+{
+ "total"=2,
+ "hits"=[
+ {
+ "_id"="zXEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa 6 month API key",
+ "userId"="jared.doe",
+ "expiresAt"=31557600000,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=360000
+ }
+ }
+ ]
+}
+*/
\ No newline at end of file
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-java.test.yml b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-java.test.yml
new file mode 100644
index 00000000..82be47f3
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-java.test.yml
@@ -0,0 +1,20 @@
+name: java-auth#searchApiKeys-koncorde
+description: Searches API keys for the currently logged user.
+hooks:
+ before: >
+ curl --fail -H "Content-type: application/json" -d '{
+ "content": {
+ "profileIds": ["default"]
+ },
+ "credentials": {
+ "local": {
+ "username": "jared.doe",
+ "password": "password"
+ }
+ }
+ }' "kuzzle:7512/users/jared.doe/_create?refresh=wait_for"
+ after:
+ curl -XDELETE kuzzle:7512/users/jared.doe
+template: default
+expected:
+ - Found 1 API key
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-kotlin.kt b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-kotlin.kt
new file mode 100644
index 00000000..5f5814b9
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-kotlin.kt
@@ -0,0 +1,72 @@
+
+val description: HashMap = HashMap().apply {
+ put("description", "LoRa permanent API Key")
+}
+
+val query: HashMap = HashMap().apply {
+ put("controller", "security")
+ put("action", "createApiKey")
+ put("userId", "jared.doe")
+ put("refresh", "wait_for")
+ put("body", description)
+}
+
+kuzzle.query(query).get()
+
+description.put("description", "Sigfox API key")
+query.put("body", description);
+kuzzle.query(query).get()
+
+description.put("description", "LoRa 6 month API key")
+query.put("body", description);
+query.put("expiresIn", 36000);
+kuzzle.query(query).get()
+
+kuzzle.authController.login("local", HashMap().apply {
+ put("username", "jared.doe")
+ put("password", "password")
+ }).get()
+
+val equals: HashMap =
+ HashMap().apply {
+ put("ttl", "36000")
+ }
+
+val squery: HashMap =
+ HashMap().apply {
+ put("equals", equals)
+ }
+
+val results = kuzzle
+ .authController
+ .searchApiKeys(squery, lang = Lang.KONCORDE).get();
+
+print("Found ${results.total} API key");
+
+/*
+{
+ "total"=2,
+ "hits"=[
+ {
+ "_id"="znEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa permanent API key",
+ "userId"="jared.doe",
+ "expiresAt"=-1,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=-1
+ }
+ },
+ {
+ "_id"="zXEwbG8BJASM_0-bWU-q",
+ "_source"={
+ "description"="LoRa 6 month API key",
+ "userId"="jared.doe",
+ "expiresAt"=31557600000,
+ "fingerprint": "4ee98cb8c614e99213e7695f822e42325d86c93cfaf39cb40e860939e784c8e6",
+ "ttl"=360000
+ }
+ }
+ ]
+}
+*/
diff --git a/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-kotlin.test.yml b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-kotlin.test.yml
new file mode 100644
index 00000000..f43a1584
--- /dev/null
+++ b/doc/1/controllers/auth/search-api-keys/snippets/search-api-keys-koncorde-kotlin.test.yml
@@ -0,0 +1,20 @@
+name: kotlin-auth#searchApiKeys-koncorde
+description: Searches API keys for the currently logged user.
+hooks:
+ before: >
+ curl --fail -H "Content-type: application/json" -d '{
+ "content": {
+ "profileIds": ["default"]
+ },
+ "credentials": {
+ "local": {
+ "username": "jared.doe",
+ "password": "password"
+ }
+ }
+ }' "kuzzle:7512/users/jared.doe/_create?refresh=wait_for"
+ after:
+ curl -XDELETE kuzzle:7512/users/jared.doe
+template: default
+expected:
+ - Found 1 API key
diff --git a/doc/1/controllers/bulk/import-data/snippets/import-data-kotlin.kt b/doc/1/controllers/bulk/import-data/snippets/import-data-kotlin.kt
index 536cb97d..ea671d9b 100644
--- a/doc/1/controllers/bulk/import-data/snippets/import-data-kotlin.kt
+++ b/doc/1/controllers/bulk/import-data/snippets/import-data-kotlin.kt
@@ -39,4 +39,4 @@ val result: Map =
"yellow-taxi",
bulkData
)
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/bulk/m-write/snippets/mwrite-kotlin.kt b/doc/1/controllers/bulk/m-write/snippets/mwrite-kotlin.kt
index 430a3663..1fa4a0fd 100644
--- a/doc/1/controllers/bulk/m-write/snippets/mwrite-kotlin.kt
+++ b/doc/1/controllers/bulk/m-write/snippets/mwrite-kotlin.kt
@@ -6,4 +6,4 @@ val documents: ArrayList> = ArrayList>().app
};
val result: Map =
-kuzzle.bulkController.mWrite("nyc-open-data", "yellow-taxi", documents).get();
\ No newline at end of file
+kuzzle.bulkController.mWrite("nyc-open-data", "yellow-taxi", documents).get();
diff --git a/doc/1/controllers/bulk/write/snippets/write-kotlin.kt b/doc/1/controllers/bulk/write/snippets/write-kotlin.kt
index a1de1d27..3429da4b 100644
--- a/doc/1/controllers/bulk/write/snippets/write-kotlin.kt
+++ b/doc/1/controllers/bulk/write/snippets/write-kotlin.kt
@@ -6,4 +6,4 @@ val content: Map = HashMap().apply {
}
val result: Map =
-kuzzle.bulkController.write("nyc-open-data", "yellow-taxi", content).get();
\ No newline at end of file
+kuzzle.bulkController.write("nyc-open-data", "yellow-taxi", content).get();
diff --git a/doc/1/controllers/collection/exists/snippets/exists-kotlin.kt b/doc/1/controllers/collection/exists/snippets/exists-kotlin.kt
index 76bd38e1..89ba15b9 100644
--- a/doc/1/controllers/collection/exists/snippets/exists-kotlin.kt
+++ b/doc/1/controllers/collection/exists/snippets/exists-kotlin.kt
@@ -1,4 +1,4 @@
val result = kuzzle
.collectionController
.exists("nyc-open-data", "yellow-taxi")
- .get();
+ .get()
diff --git a/doc/1/controllers/collection/get-mapping/snippets/get-mapping-kotlin.kt b/doc/1/controllers/collection/get-mapping/snippets/get-mapping-kotlin.kt
index c8c36c5d..6cf8be7d 100644
--- a/doc/1/controllers/collection/get-mapping/snippets/get-mapping-kotlin.kt
+++ b/doc/1/controllers/collection/get-mapping/snippets/get-mapping-kotlin.kt
@@ -1,7 +1,7 @@
val result = kuzzle
.collectionController
.getMapping("nyc-open-data", "yellow-taxi")
- .get();
+ .get()
/*
{
@@ -16,4 +16,4 @@ val result = kuzzle
}
}
}
-*/
\ No newline at end of file
+*/
diff --git a/doc/1/controllers/collection/get-specifications/snippets/get-specifications-kotlin.kt b/doc/1/controllers/collection/get-specifications/snippets/get-specifications-kotlin.kt
index a4776800..5b0ce36e 100644
--- a/doc/1/controllers/collection/get-specifications/snippets/get-specifications-kotlin.kt
+++ b/doc/1/controllers/collection/get-specifications/snippets/get-specifications-kotlin.kt
@@ -1,7 +1,7 @@
val result = kuzzle
.collectionController
.getSpecifications("nyc-open-data", "yellow-taxi")
- .get();
+ .get()
/*
{
@@ -18,4 +18,4 @@ val result = kuzzle
strict=true
}
}
-*/
\ No newline at end of file
+*/
diff --git a/doc/1/controllers/collection/list/snippets/list-kotlin.kt b/doc/1/controllers/collection/list/snippets/list-kotlin.kt
index 6b4f60ac..b1c46524 100644
--- a/doc/1/controllers/collection/list/snippets/list-kotlin.kt
+++ b/doc/1/controllers/collection/list/snippets/list-kotlin.kt
@@ -1,7 +1,7 @@
val result = kuzzle
.collectionController
.list("nyc-open-data")
- .get();
+ .get()
/*
{
@@ -19,4 +19,4 @@ val result = kuzzle
from=0,
type=all
}
- */
\ No newline at end of file
+ */
diff --git a/doc/1/controllers/collection/update-specifications/snippets/update-specifications-kotlin.kt b/doc/1/controllers/collection/update-specifications/snippets/update-specifications-kotlin.kt
index d01a9471..85c4d361 100644
--- a/doc/1/controllers/collection/update-specifications/snippets/update-specifications-kotlin.kt
+++ b/doc/1/controllers/collection/update-specifications/snippets/update-specifications-kotlin.kt
@@ -16,7 +16,7 @@ HashMap().apply{
val result: Map = kuzzle
.collectionController
.updateSpecifications("nyc-open-data", "yellow-taxi", specifications)
- .get();
+ .get()
/*
{
diff --git a/doc/1/controllers/collection/validate-specifications/snippets/validate-specifications-kotlin.kt b/doc/1/controllers/collection/validate-specifications/snippets/validate-specifications-kotlin.kt
index 8d55b1ee..35f21f39 100644
--- a/doc/1/controllers/collection/validate-specifications/snippets/validate-specifications-kotlin.kt
+++ b/doc/1/controllers/collection/validate-specifications/snippets/validate-specifications-kotlin.kt
@@ -13,4 +13,4 @@ val specifications: Map = HashMap().apply {
val result = kuzzle
.collectionController
.validateSpecifications("nyc-open-data", "yellow-taxi", specifications)
- .get();
+ .get()
diff --git a/doc/1/controllers/document/count/snippets/count-kotlin.kt b/doc/1/controllers/document/count/snippets/count-kotlin.kt
index 1901f0e4..d877cda5 100644
--- a/doc/1/controllers/document/count/snippets/count-kotlin.kt
+++ b/doc/1/controllers/document/count/snippets/count-kotlin.kt
@@ -6,6 +6,6 @@ val searchQuery : Map =
}
val result: Int = kuzzle
- .documentController
- .count("nyc-open-data", "yellow-taxi", searchQuery)
- .get();
\ No newline at end of file
+ .documentController
+ .count("nyc-open-data", "yellow-taxi", searchQuery)
+ .get()
diff --git a/doc/1/controllers/document/create-or-replace/snippets/create-or-replace-kotlin.kt b/doc/1/controllers/document/create-or-replace/snippets/create-or-replace-kotlin.kt
index 9a62d847..9a2be66d 100644
--- a/doc/1/controllers/document/create-or-replace/snippets/create-or-replace-kotlin.kt
+++ b/doc/1/controllers/document/create-or-replace/snippets/create-or-replace-kotlin.kt
@@ -6,4 +6,4 @@ val result: Map =
kuzzle
.documentController
.createOrReplace("nyc-open-data", "yellow-taxi", "some-id", document)
- .get();
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/document/create/snippets/create-kotlin.kt b/doc/1/controllers/document/create/snippets/create-kotlin.kt
index de6bb50a..9bd6418c 100644
--- a/doc/1/controllers/document/create/snippets/create-kotlin.kt
+++ b/doc/1/controllers/document/create/snippets/create-kotlin.kt
@@ -4,6 +4,6 @@ val document: Map = HashMap().apply {
val result: Map =
kuzzle
- .documentController
- .create("nyc-open-data", "yellow-taxi", document)
- .get();
\ No newline at end of file
+ .documentController
+ .create("nyc-open-data", "yellow-taxi", document)
+ .get()
diff --git a/doc/1/controllers/document/delete-by-query/index.md b/doc/1/controllers/document/delete-by-query/index.md
index f6a118af..53a1552d 100644
--- a/doc/1/controllers/document/delete-by-query/index.md
+++ b/doc/1/controllers/document/delete-by-query/index.md
@@ -11,6 +11,15 @@ Deletes documents matching the provided search query.
Kuzzle uses the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+
+This method also supports the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) to match documents by passing the `lang` argument with the value `koncorde`.
+Koncorde filters will be translated into an Elasticsearch query.
+
+::: warning
+Koncorde `bool` operator and `regexp` clauses are not supported for search queries.
+:::
+
An empty or null query will match all documents in the collection.
:::: tabs
@@ -24,11 +33,24 @@ An empty or null query will match all documents in the collection.
String collection,
Map searchQuery) throws NotConnectedException, InternalException
+ public CompletableFuture> deleteByQuery(
+ String index,
+ String collection,
+ Map searchQuery,
+ Lang lang) throws NotConnectedException, InternalException
+
public CompletableFuture> deleteByQuery(
String index,
String collection,
Map searchQuery,
Boolean waitForRefresh) throws NotConnectedException, InternalException
+
+ public CompletableFuture> deleteByQuery(
+ String index,
+ String collection,
+ Map searchQuery,
+ Boolean waitForRefresh,
+ Lang lang) throws NotConnectedException, InternalException
```
| Argument | Type | Description |
@@ -36,7 +58,8 @@ An empty or null query will match all documents in the collection.
| `index` | String
| Index name |
| `collection` | String
| Collection name |
| `searchQuery` | Map
| Query to match |
-| `waitForRefresh` | Boolean
(optional) | If set to `true`, Kuzzle will wait for the persistence layer to finish indexing|
+| `waitForRefresh` | Boolean
(optional) | If set to `true`, Kuzzle will wait for the persistence layer to finish indexing |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
---
@@ -46,7 +69,14 @@ Returns an `ArrayList` containing the deleted document ids.
## Usage
-<<< ./snippets/delete-by-query-java.java
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/delete-by-query-es-java.java
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/delete-by-query-koncorde-java.java
:::
::: tab Kotlin
@@ -58,7 +88,8 @@ fun deleteByQuery(
index: String,
collection: String,
searchQuery: Map,
- waitForRefresh: Boolean? = null): CompletableFuture>
+ waitForRefresh: Boolean? = null,
+ lang: Lang = Lang.ELASTICSEARCH): CompletableFuture>
```
| Argument | Type | Description |
@@ -66,7 +97,8 @@ fun deleteByQuery(
| `index` | String
| Index name |
| `collection` | String
| Collection name |
| `searchQuery` | Map
| Query to match |
-| `waitForRefresh` | Boolean
(optional) | If set to `true`, Kuzzle will wait for the persistence layer to finish indexing|
+| `waitForRefresh` | Boolean
(optional) | If set to `true`, Kuzzle will wait for the persistence layer to finish indexing |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
---
@@ -76,7 +108,14 @@ Returns an `ArrayList` containing the deleted document ids.
## Usage
-<<< ./snippets/delete-by-query-kotlin.kt
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/delete-by-query-es-kotlin.kt
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/delete-by-query-koncorde-kotlin.kt
:::
-::::
\ No newline at end of file
+::::
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-java.java b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-java.java
new file mode 100644
index 00000000..3822d913
--- /dev/null
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-java.java
@@ -0,0 +1,10 @@
+Map searchQuery = new HashMap<>();
+Map query = new HashMap<>();
+Map match = new HashMap<>();
+match.put("capacity", 4);
+query.put("match", match);
+searchQuery.put("query", query);
+ArrayList result = kuzzle
+ .getDocumentController()
+ .deleteByQuery("nyc-open-data", "yellow-taxi", searchQuery)
+ .get();
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-kotlin.test.yml b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-java.test.yml
similarity index 95%
rename from doc/1/controllers/document/delete-by-query/snippets/delete-by-query-kotlin.test.yml
rename to doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-java.test.yml
index dd258f14..95186544 100644
--- a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-kotlin.test.yml
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-java.test.yml
@@ -1,4 +1,4 @@
-name: kotlin-document#deleteByQuery
+name: java-document#deleteByQuery-es
description: Delete documents matching query
hooks:
before: |
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-kotlin.kt b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-kotlin.kt
new file mode 100644
index 00000000..e040f3b4
--- /dev/null
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-kotlin.kt
@@ -0,0 +1,18 @@
+val searchQuery: Map = HashMap().apply {
+ put(
+ "query",
+ HashMap().apply {
+ put(
+ "match",
+ HashMap().apply {
+ put("capacity", 4)
+ }
+ )
+ }
+ )
+}
+
+val result: ArrayList = kuzzle
+ .documentController
+ .deleteByQuery("nyc-open-data", "yellow-taxi", searchQuery)
+ .get()
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-java.test.yml b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-kotlin.test.yml
similarity index 94%
rename from doc/1/controllers/document/delete-by-query/snippets/delete-by-query-java.test.yml
rename to doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-kotlin.test.yml
index 3f00eb0d..74a72092 100644
--- a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-java.test.yml
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-es-kotlin.test.yml
@@ -1,4 +1,4 @@
-name: java-document#deleteByQuery
+name: kotlin-document#deleteByQuery-es
description: Delete documents matching query
hooks:
before: |
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-java.java b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-java.java
deleted file mode 100644
index ec1e3a2b..00000000
--- a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-java.java
+++ /dev/null
@@ -1,10 +0,0 @@
- Map searchQuery = new HashMap<>();
- Map query = new HashMap<>();
- Map match = new HashMap<>();
- match.put("capacity", 4);
- query.put("match", match);
- searchQuery.put("query", query);
- ArrayList result = kuzzle
- .getDocumentController()
- .deleteByQuery("nyc-open-data", "yellow-taxi", searchQuery)
- .get();
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-java.java b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-java.java
new file mode 100644
index 00000000..20b02b01
--- /dev/null
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-java.java
@@ -0,0 +1,10 @@
+Map searchQuery = new HashMap<>();
+Map query = new HashMap<>();
+Map equals = new HashMap<>();
+equals.put("capacity", 4);
+query.put("equals", equals);
+searchQuery.put("query", query);
+ArrayList result = kuzzle
+ .getDocumentController()
+ .deleteByQuery("nyc-open-data", "yellow-taxi", searchQuery, Lang.KONCORDE)
+ .get();
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-java.test.yml b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-java.test.yml
new file mode 100644
index 00000000..f13c6f91
--- /dev/null
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-java.test.yml
@@ -0,0 +1,22 @@
+name: java-document#deleteByQuery-koncorde
+description: Delete documents matching query
+hooks:
+ before: |
+ curl -XDELETE kuzzle:7512/nyc-open-data
+ curl -XPOST kuzzle:7512/nyc-open-data/_create
+ curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"capacity": 4}' kuzzle:7512/nyc-open-data/yellow-taxi/document_$i/_create
+ done
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"capacity": 7}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ curl -XPOST kuzzle:7512/nyc-open-data/_refresh
+ after:
+template: print-result-arraylist
+expected:
+ - "document_1"
+ - "document_2"
+ - "document_3"
+ - "document_4"
+ - "document_5"
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-kotlin.kt b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-kotlin.kt
similarity index 62%
rename from doc/1/controllers/document/delete-by-query/snippets/delete-by-query-kotlin.kt
rename to doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-kotlin.kt
index c5249ef7..53d72735 100644
--- a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-kotlin.kt
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-kotlin.kt
@@ -1,6 +1,6 @@
val searchQuery: Map = HashMap().apply {
put("query", HashMap().apply {
- put("match", HashMap().apply {
+ put("equals", HashMap().apply {
put("capacity", 4)
})
})
@@ -8,5 +8,5 @@ val searchQuery: Map = HashMap().apply {
val result: ArrayList = kuzzle
.documentController
- .deleteByQuery("nyc-open-data", "yellow-taxi", searchQuery)
+ .deleteByQuery("nyc-open-data", "yellow-taxi", searchQuery, lang = Lang.KONCORDE)
.get()
diff --git a/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-kotlin.test.yml b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-kotlin.test.yml
new file mode 100644
index 00000000..cde8bc6b
--- /dev/null
+++ b/doc/1/controllers/document/delete-by-query/snippets/delete-by-query-koncorde-kotlin.test.yml
@@ -0,0 +1,22 @@
+name: kotlin-document#deleteByQuery-koncorde
+description: Delete documents matching query
+hooks:
+ before: |
+ curl -XDELETE kuzzle:7512/nyc-open-data
+ curl -XPOST kuzzle:7512/nyc-open-data/_create
+ curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"capacity": 4}' kuzzle:7512/nyc-open-data/yellow-taxi/document_$i/_create
+ done
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"capacity": 7}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ curl -XPOST kuzzle:7512/nyc-open-data/_refresh
+ after:
+template: print-result-arraylist
+expected:
+ - "document_1"
+ - "document_2"
+ - "document_3"
+ - "document_4"
+ - "document_5"
diff --git a/doc/1/controllers/document/exists/snippets/exists-kotlin.kt b/doc/1/controllers/document/exists/snippets/exists-kotlin.kt
index 4a5ffbc8..386afd6a 100644
--- a/doc/1/controllers/document/exists/snippets/exists-kotlin.kt
+++ b/doc/1/controllers/document/exists/snippets/exists-kotlin.kt
@@ -1,4 +1,4 @@
val result: Boolean = kuzzle
- .documentController
- .exists("nyc-open-data", "yellow-taxi", "some-id")
- .get()
+ .documentController
+ .exists("nyc-open-data", "yellow-taxi", "some-id")
+ .get()
diff --git a/doc/1/controllers/document/m-delete/snippets/m-delete-kotlin.kt b/doc/1/controllers/document/m-delete/snippets/m-delete-kotlin.kt
index 31bbf83d..648c6eb2 100644
--- a/doc/1/controllers/document/m-delete/snippets/m-delete-kotlin.kt
+++ b/doc/1/controllers/document/m-delete/snippets/m-delete-kotlin.kt
@@ -5,6 +5,6 @@ val ids: ArrayList = ArrayList().apply {
val result: Map> =
kuzzle
- .documentController
- .mDelete("nyc-open-data", "yellow-taxi", ids)
- .get()
\ No newline at end of file
+ .documentController
+ .mDelete("nyc-open-data", "yellow-taxi", ids)
+ .get()
diff --git a/doc/1/controllers/document/m-get/snippets/m-get-kotlin.kt b/doc/1/controllers/document/m-get/snippets/m-get-kotlin.kt
index 55764e84..fd115201 100644
--- a/doc/1/controllers/document/m-get/snippets/m-get-kotlin.kt
+++ b/doc/1/controllers/document/m-get/snippets/m-get-kotlin.kt
@@ -5,6 +5,6 @@ val ids: ArrayList = ArrayList().apply {
val result: Map> =
kuzzle
- .documentController
- .mGet("nyc-open-data", "yellow-taxi", ids)
- .get()
+ .documentController
+ .mGet("nyc-open-data", "yellow-taxi", ids)
+ .get()
diff --git a/doc/1/controllers/document/m-replace/snippets/m-replace-kotlin.kt b/doc/1/controllers/document/m-replace/snippets/m-replace-kotlin.kt
index c2df6eb4..957dd855 100644
--- a/doc/1/controllers/document/m-replace/snippets/m-replace-kotlin.kt
+++ b/doc/1/controllers/document/m-replace/snippets/m-replace-kotlin.kt
@@ -25,4 +25,4 @@ val result: Map?> =
kuzzle
.documentController
.mReplace("nyc-open-data", "yellow-taxi", documents)
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/document/m-update/index.md b/doc/1/controllers/document/m-update/index.md
index a9aeb99f..f185933a 100644
--- a/doc/1/controllers/document/m-update/index.md
+++ b/doc/1/controllers/document/m-update/index.md
@@ -27,7 +27,15 @@ public CompletableFuture>> mUpdate(
String index,
String collection,
ArrayList> documents,
- UpdateOptions options)
+ Boolean waitForRefresh)
+throws NotConnectedException, InternalException
+
+public CompletableFuture>> mUpdate(
+ String index,
+ String collection,
+ ArrayList> documents,
+ Boolean waitForRefresh,
+ Integer retryOnConflict)
throws NotConnectedException, InternalException
```
diff --git a/doc/1/controllers/document/m-update/snippets/m-update-kotlin.kt b/doc/1/controllers/document/m-update/snippets/m-update-kotlin.kt
index cbb8f918..0dd9b0d7 100644
--- a/doc/1/controllers/document/m-update/snippets/m-update-kotlin.kt
+++ b/doc/1/controllers/document/m-update/snippets/m-update-kotlin.kt
@@ -25,4 +25,4 @@ val result: Map?> =
kuzzle
.documentController
.mReplace("nyc-open-data", "yellow-taxi", documents)
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/document/search/index.md b/doc/1/controllers/document/search/index.md
index 30ed0a8a..a3501dc4 100644
--- a/doc/1/controllers/document/search/index.md
+++ b/doc/1/controllers/document/search/index.md
@@ -28,6 +28,15 @@ It can lead to memory leaks if a scroll duration too great is provided, or if to
You can restrict the scroll session maximum duration under the `services.storage.maxScrollDuration` configuration key.
:::
+
+
+This method also supports the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) to match documents by passing the `lang` argument with the value `koncorde`.
+Koncorde filters will be translated into an Elasticsearch query.
+
+::: warning
+Koncorde `bool` operator and `regexp` clauses are not supported for search queries.
+:::
+
---
:::: tabs
@@ -47,19 +56,34 @@ public CompletableFuture search(
Map searchQuery,
String scroll) throws NotConnectedException, InternalException
+public CompletableFuture search(
+ String index,
+ String collection,
+ Map searchQuery,
+ Lang lang) throws NotConnectedException, InternalException
+
public CompletableFuture search(
String index,
String collection,
Map searchQuery,
String scroll,
- Integer size) throws NotConnectedException, InternalException
+ Lang lang) throws NotConnectedException, InternalException
+
+public CompletableFuture search(
+ String index,
+ String collection,
+ Map searchQuery,
+ String scroll,
+ Integer size,
+ Lang lang) throws NotConnectedException, InternalException
public CompletableFuture search(
String index,
String collection,
Map searchQuery
Integer size,
- Integer from)
+ Integer from,
+ Lang lang)
throws NotConnectedException, InternalException
```
@@ -71,11 +95,12 @@ throws NotConnectedException, InternalException
| `from` | Integer
(`0`) | Offset of the first document to fetch |
| `size` | Integer
(`10`) | Maximum number of documents to retrieve per page |
| `scroll` | String
(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `1s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
---
### searchQuery body properties:
-- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
+- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) or the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
- `aggregations`: control how the search results should be [aggregated](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-aggregations.html)
- `sort`: contains a list of fields, used to [sort search results](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-request-sort.html), in order of importance.
@@ -87,7 +112,14 @@ Returns a [SearchResult](/sdk/jvm/1/core-classes/search-result) object.
## Usage
-<<< ./snippets/search-java.java
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/search-es-java.java
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/search-koncorde-java.java
:::
::: tab Kotlin
@@ -102,7 +134,8 @@ Returns a [SearchResult](/sdk/jvm/1/core-classes/search-result) object.
searchQuery: Map,
scroll: String? = null,
size: Int? = null,
- from: Int = 0): CompletableFuture
+ from: Int = 0,
+ land: Lang = Lang.ELASTICSEARCH): CompletableFuture
```
| Arguments | Type | Description |
@@ -113,11 +146,12 @@ Returns a [SearchResult](/sdk/jvm/1/core-classes/search-result) object.
| `from` | Int
(`0`) | Offset of the first document to fetch |
| `size` | Int
(`10`) | Maximum number of documents to retrieve per page |
| `scroll` | String
(`""`) | When set, gets a forward-only cursor having its ttl set to the given value (ie `1s`; cf [elasticsearch time limits](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/common-options.html#time-units)) |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
---
### searchQuery body properties:
-- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) syntax.
+- `query`: the search query itself, using the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/query-dsl.html) or the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
- `aggregations`: control how the search results should be [aggregated](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-aggregations.html)
- `sort`: contains a list of fields, used to [sort search results](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/search-request-sort.html), in order of importance.
@@ -129,7 +163,14 @@ Returns a [SearchResult](/sdk/jvm/1/core-classes/search-result) object.
## Usage
-<<< ./snippets/search-kotlin.kt
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/search-es-kotlin.kt
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/search-koncorde-kotlin.kt
:::
::::
diff --git a/doc/1/controllers/document/search/snippets/search-es-java.java b/doc/1/controllers/document/search/snippets/search-es-java.java
new file mode 100644
index 00000000..a5be1c8d
--- /dev/null
+++ b/doc/1/controllers/document/search/snippets/search-es-java.java
@@ -0,0 +1,36 @@
+Map searchQuery = new HashMap<>();
+Map query = new HashMap<>();
+Map match = new HashMap<>();
+match.put("category", "suv");
+query.put("match", match);
+searchQuery.put("query", query);
+
+SearchResult results = kuzzle
+ .getDocumentController()
+ .search("nyc-open-data", "yellow-taxi", searchQuery).get();
+
+
+/*
+ {
+ "aggregations"=undefined,
+ "hits"=[
+ {
+ "_id"="AWgi6A1POQUM6ucJ3q06",
+ "_score"=0.046520017,
+ "_source"={
+ "category"="suv",
+ "_kuzzle_info"={
+ "author"="-1",
+ "createdAt"=1546773859655,
+ "updatedAt"=null,
+ "updater"=null
+ }
+ }
+ },
+ ...
+ ]
+ },
+ "total"=5,
+ "fetched"=5,
+ "scroll_id"=undefined
+*/
diff --git a/doc/1/controllers/document/search/snippets/search-java.test.yml b/doc/1/controllers/document/search/snippets/search-es-java.test.yml
similarity index 95%
rename from doc/1/controllers/document/search/snippets/search-java.test.yml
rename to doc/1/controllers/document/search/snippets/search-es-java.test.yml
index eea08bf1..ed3d3c84 100644
--- a/doc/1/controllers/document/search/snippets/search-java.test.yml
+++ b/doc/1/controllers/document/search/snippets/search-es-java.test.yml
@@ -1,4 +1,4 @@
-name: java-document#search
+name: java-document#search-es
description: Search for documents
hooks:
before: |
diff --git a/doc/1/controllers/document/search/snippets/search-es-kotlin.kt b/doc/1/controllers/document/search/snippets/search-es-kotlin.kt
new file mode 100644
index 00000000..5f15e504
--- /dev/null
+++ b/doc/1/controllers/document/search/snippets/search-es-kotlin.kt
@@ -0,0 +1,41 @@
+val match: Map =
+ HashMap().apply {
+ put("category", "suv")
+ }
+val query: Map =
+ HashMap().apply {
+ put("match", match)
+ }
+
+val searchQuery: Map =
+ HashMap().apply {
+ put("query", query)
+ }
+val results = kuzzle
+ .documentController
+ .search("nyc-open-data", "yellow-taxi", searchQuery).get();
+
+/*
+ {
+ "aggregations"=undefined,
+ "hits"=[
+ {
+ "_id"="AWgi6A1POQUM6ucJ3q06",
+ "_score"=0.046520017,
+ "_source"={
+ "category"="suv",
+ "_kuzzle_info"={
+ "author"="-1",
+ "createdAt"=1546773859655,
+ "updatedAt"=null,
+ "updater"=null
+ }
+ }
+ },
+ ...
+ ]
+ },
+ "total"=5,
+ "fetched"=5,
+ "scroll_id"=undefined
+*/
diff --git a/doc/1/controllers/document/search/snippets/search-kotlin.test.yml b/doc/1/controllers/document/search/snippets/search-es-kotlin.test.yml
similarity index 95%
rename from doc/1/controllers/document/search/snippets/search-kotlin.test.yml
rename to doc/1/controllers/document/search/snippets/search-es-kotlin.test.yml
index 5cf50699..38fdaecb 100644
--- a/doc/1/controllers/document/search/snippets/search-kotlin.test.yml
+++ b/doc/1/controllers/document/search/snippets/search-es-kotlin.test.yml
@@ -1,4 +1,4 @@
-name: kotlin-document#search
+name: kotlin-document#search-es
description: Search for documents
hooks:
before: |
diff --git a/doc/1/controllers/document/search/snippets/search-java.java b/doc/1/controllers/document/search/snippets/search-java.java
deleted file mode 100644
index 75470a1d..00000000
--- a/doc/1/controllers/document/search/snippets/search-java.java
+++ /dev/null
@@ -1,36 +0,0 @@
- Map searchQuery = new HashMap<>();
- Map query = new HashMap<>();
- Map match = new HashMap<>();
- match.put("category", "suv");
- query.put("match", match);
- searchQuery.put("query", query);
-
- SearchResult results = kuzzle
- .getDocumentController()
- .search("nyc-open-data", "yellow-taxi", searchQuery).get();
-
-
- /*
- {
- "aggregations"=undefined,
- "hits"=[
- {
- "_id"="AWgi6A1POQUM6ucJ3q06",
- "_score"=0.046520017,
- "_source"={
- "category"="suv",
- "_kuzzle_info"={
- "author"="-1",
- "createdAt"=1546773859655,
- "updatedAt"=null,
- "updater"=null
- }
- }
- },
- ...
- ]
- },
- "total"=5,
- "fetched"=5,
- "scroll_id"=undefined
- */
diff --git a/doc/1/controllers/document/search/snippets/search-koncorde-java.java b/doc/1/controllers/document/search/snippets/search-koncorde-java.java
new file mode 100644
index 00000000..5830363b
--- /dev/null
+++ b/doc/1/controllers/document/search/snippets/search-koncorde-java.java
@@ -0,0 +1,36 @@
+Map searchQuery = new HashMap<>();
+Map query = new HashMap<>();
+Map equals = new HashMap<>();
+equals.put("category", "suv");
+query.put("equals", equals);
+searchQuery.put("query", query);
+
+SearchResult results = kuzzle
+ .getDocumentController()
+ .search("nyc-open-data", "yellow-taxi", searchQuery, Lang.KONCORDE).get();
+
+
+/*
+{
+ "aggregations"=undefined,
+ "hits"=[
+ {
+ "_id"="AWgi6A1POQUM6ucJ3q06",
+ "_score"=0.046520017,
+ "_source"={
+ "category"="suv",
+ "_kuzzle_info"={
+ "author"="-1",
+ "createdAt"=1546773859655,
+ "updatedAt"=null,
+ "updater"=null
+ }
+ }
+ },
+ ...
+ ]
+},
+"total"=5,
+"fetched"=5,
+"scroll_id"=undefined
+*/
diff --git a/doc/1/controllers/document/search/snippets/search-koncorde-java.test.yml b/doc/1/controllers/document/search/snippets/search-koncorde-java.test.yml
new file mode 100644
index 00000000..ad829726
--- /dev/null
+++ b/doc/1/controllers/document/search/snippets/search-koncorde-java.test.yml
@@ -0,0 +1,17 @@
+name: java-document#search-koncorde
+description: Search for documents
+hooks:
+ before: |
+ curl -XDELETE kuzzle:7512/nyc-open-data
+ curl -XPOST kuzzle:7512/nyc-open-data/_create
+ curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"category": "suv"}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"category": "limousine"}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ curl -XPOST kuzzle:7512/nyc-open-data/yellow-taxi/_refresh
+ after:
+template: default
+expected: ^Success
diff --git a/doc/1/controllers/document/search/snippets/search-koncorde-kotlin.kt b/doc/1/controllers/document/search/snippets/search-koncorde-kotlin.kt
new file mode 100644
index 00000000..89b4df0b
--- /dev/null
+++ b/doc/1/controllers/document/search/snippets/search-koncorde-kotlin.kt
@@ -0,0 +1,42 @@
+val equals: Map =
+ HashMap().apply {
+ put("category", "suv")
+ }
+val query: Map =
+ HashMap().apply {
+ put("equals", equals)
+ }
+
+val searchQuery: Map =
+ HashMap().apply {
+ put("query", query)
+ }
+
+val results = kuzzle
+ .documentController
+ .search("nyc-open-data", "yellow-taxi", searchQuery, lang = Lang.KONCORDE).get();
+
+/*
+{
+ "aggregations"=undefined,
+ "hits"=[
+ {
+ "_id"="AWgi6A1POQUM6ucJ3q06",
+ "_score"=0.046520017,
+ "_source"={
+ "category"="suv",
+ "_kuzzle_info"={
+ "author"="-1",
+ "createdAt"=1546773859655,
+ "updatedAt"=null,
+ "updater"=null
+ }
+ }
+ },
+ ...
+ ]
+},
+"total"=5,
+"fetched"=5,
+"scroll_id"=undefined
+*/
diff --git a/doc/1/controllers/document/search/snippets/search-koncorde-kotlin.test.yml b/doc/1/controllers/document/search/snippets/search-koncorde-kotlin.test.yml
new file mode 100644
index 00000000..db85e379
--- /dev/null
+++ b/doc/1/controllers/document/search/snippets/search-koncorde-kotlin.test.yml
@@ -0,0 +1,17 @@
+name: kotlin-document#search-koncorde
+description: Search for documents
+hooks:
+ before: |
+ curl -XDELETE kuzzle:7512/nyc-open-data
+ curl -XPOST kuzzle:7512/nyc-open-data/_create
+ curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"category": "suv"}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"category": "limousine"}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ curl -XPOST kuzzle:7512/nyc-open-data/yellow-taxi/_refresh
+ after:
+template: default
+expected: ^Success
diff --git a/doc/1/controllers/document/search/snippets/search-kotlin.kt b/doc/1/controllers/document/search/snippets/search-kotlin.kt
deleted file mode 100644
index 083cfc1e..00000000
--- a/doc/1/controllers/document/search/snippets/search-kotlin.kt
+++ /dev/null
@@ -1,16 +0,0 @@
-val match: Map =
- HashMap().apply {
- put("category", "suv")
- }
-val query: Map =
- HashMap().apply {
- put("match", match)
- }
-
-val searchQuery: Map =
- HashMap().apply {
- put("query", query)
- }
-val results = kuzzle
- .documentController
- .search("nyc-open-data", "yellow-taxi", searchQuery).get();
diff --git a/doc/1/controllers/document/update-by-query/index.md b/doc/1/controllers/document/update-by-query/index.md
index 47fa5805..964801ee 100644
--- a/doc/1/controllers/document/update-by-query/index.md
+++ b/doc/1/controllers/document/update-by-query/index.md
@@ -11,6 +11,15 @@ Updates documents matching the provided search query.
Kuzzle uses the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+
+This method also supports the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) to match documents by passing the `lang` argument with the value `koncorde`.
+Koncorde filters will be translated into an Elasticsearch query.
+
+::: warning
+Koncorde `bool` operator and `regexp` clauses are not supported for search queries.
+:::
+
An empty or null query will match all documents in the collection.
@@ -27,11 +36,45 @@ An empty or null query will match all documents in the collection.
Map changes) throws NotConnectedException, InternalException
public CompletableFuture>> updateByQuery(
- String index,
- String collection,
- Map searchQuery,
- Map changes,
- UpdateOptions options) throws NotConnectedException, InternalException
+ String index,
+ String collection,
+ Map searchQuery,
+ Map changes,
+ Lang lang) throws NotConnectedException, InternalException
+
+ public CompletableFuture>> updateByQuery(
+ String index,
+ String collection,
+ Map searchQuery,
+ Map changes,
+ Boolean waitForRefresh) throws NotConnectedException, InternalException
+
+ public CompletableFuture>> updateByQuery(
+ String index,
+ String collection,
+ Map searchQuery,
+ Map changes,
+ Boolean waitForRefresh,
+ Integer retryOnConflict) throws NotConnectedException, InternalException
+
+ public CompletableFuture>> updateByQuery(
+ String index,
+ String collection,
+ Map searchQuery,
+ Map changes,
+ Boolean waitForRefresh,
+ Integer retryOnConflict,
+ Boolean source) throws NotConnectedException, InternalException
+
+ public CompletableFuture>> updateByQuery(
+ String index,
+ String collection,
+ Map searchQuery,
+ Map changes,
+ Boolean waitForRefresh,
+ Integer retryOnConflict,
+ Boolean source,
+ Lang lang) throws NotConnectedException, InternalException
```
| Argument | Type | Description |
@@ -42,6 +85,7 @@ An empty or null query will match all documents in the collection.
| `changes` | Map
| Partial changes to apply to the documents |
| `waitForRefresh` | Boolean
| If set to `true`, Kuzzle will wait for the persistence layer to finish indexing|
| `source` | Boolean
| If true, returns the updated document inside the response |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
---
@@ -67,7 +111,14 @@ Each errored document is an object of the `errors` array with the following prop
## Usage
-<<< ./snippets/update-by-query-java.java
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/update-by-query-es-java.java
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/update-by-query-koncorde-java.java
:::
::: tab Kotlin
@@ -80,7 +131,8 @@ fun updateByQuery(
changes: Map,
waitForRefresh: Boolean? = null,
retryOnConflict: Int? = null,
- source: Boolean? = null): CompletableFuture>>
+ source: Boolean? = null,
+ lang: Lang = Lang.ELASTICSEARCH): CompletableFuture>>
```
| Argument | Type | Description |
@@ -90,7 +142,9 @@ fun updateByQuery(
| `searchQuery` | Map
| Query to match |
| `changes` | Map
| Partial changes to apply to the documents |
| `waitForRefresh` | Boolean
| If set to `true`, Kuzzle will wait for the persistence layer to finish indexing|
+| `retryOnConflict` | Int
(optional) | The number of times the database layer should retry in case of version conflict |
| `source` | Boolean
| If true, returns the updated document inside the response |
+| `lang` | [Lang](/sdk/jvm/1/core-classes/lang)
| Specify the query language to use. By default, it's `elasticsearch` but `koncorde` can also be used. |
---
@@ -116,7 +170,14 @@ Each errored document is an object of the `errors` array with the following prop
## Usage
-<<< ./snippets/update-by-query-kotlin.kt
+With the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/query-dsl.html) syntax.
+
+<<< ./snippets/update-by-query-es-kotlin.kt
+
+With the [Koncorde Filters DSL](/core/2/api/koncorde-filters-syntax) syntax.
+
+
+<<< ./snippets/update-by-query-koncorde-kotlin.kt
:::
::::
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-java.java b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-java.java
new file mode 100644
index 00000000..6fbfc96e
--- /dev/null
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-java.java
@@ -0,0 +1,30 @@
+Map searchQuery = new HashMap<>();
+Map match = new HashMap<>();
+match.put("capacity", 4);
+searchQuery.put("match", match);
+
+Map changes = new HashMap<>();
+changes.put("capacity", 42);
+
+Map> result = kuzzle
+ .getDocumentController()
+ .updateByQuery("nyc-open-data", "yellow-taxi", searchQuery, changes)
+ .get();
+
+/*
+{
+ successes=[
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ },
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ }
+ ],
+ errors=[]
+}
+*/
\ No newline at end of file
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-java.test.yml b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-java.test.yml
similarity index 95%
rename from doc/1/controllers/document/update-by-query/snippets/update-by-query-java.test.yml
rename to doc/1/controllers/document/update-by-query/snippets/update-by-query-es-java.test.yml
index 95a45914..9d5e2398 100644
--- a/doc/1/controllers/document/update-by-query/snippets/update-by-query-java.test.yml
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-java.test.yml
@@ -1,4 +1,4 @@
-name: java-document#updateByQuery
+name: java-document#updateByQuery-es
description: Update documents matching query
hooks:
before: |
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-kotlin.kt b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-kotlin.kt
new file mode 100644
index 00000000..0273d679
--- /dev/null
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-kotlin.kt
@@ -0,0 +1,38 @@
+val match: Map =
+ HashMap().apply {
+ put("capacity", 4)
+ }
+
+val searchQuery: Map =
+ HashMap().apply {
+ put("match", match)
+ }
+
+val changes: Map =
+ HashMap().apply {
+ put("capacity", 42)
+ }
+
+val result: Map> =
+ kuzzle
+ .documentController
+ .updateByQuery("nyc-open-data", "yellow-taxi", searchQuery, changes)
+ .get()
+
+/*
+{
+ successes=[
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ },
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ }
+ ],
+ errors=[]
+}
+*/
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-kotlin.test.yml b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-kotlin.test.yml
similarity index 94%
rename from doc/1/controllers/document/update-by-query/snippets/update-by-query-kotlin.test.yml
rename to doc/1/controllers/document/update-by-query/snippets/update-by-query-es-kotlin.test.yml
index 5e8f812c..4a2ea95d 100644
--- a/doc/1/controllers/document/update-by-query/snippets/update-by-query-kotlin.test.yml
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-es-kotlin.test.yml
@@ -1,4 +1,4 @@
-name: kotlin-document#updateByQuery
+name: kotlin-document#updateByQuery-es
description: Update documents matching query
hooks:
before: |
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-java.java b/doc/1/controllers/document/update-by-query/snippets/update-by-query-java.java
deleted file mode 100644
index 5c5c1e06..00000000
--- a/doc/1/controllers/document/update-by-query/snippets/update-by-query-java.java
+++ /dev/null
@@ -1,30 +0,0 @@
- Map searchQuery = new HashMap<>();
- Map match = new HashMap<>();
- match.put("capacity", 4);
- searchQuery.put("match", match);
-
- Map changes = new HashMap<>();
- changes.put("capacity", 42);
-
- Map> result = kuzzle
- .getDocumentController()
- .updateByQuery("nyc-open-data", "yellow-taxi", searchQuery, changes)
- .get();
-
- /*
- {
- successes=[
- {
- _id=,
- _source= // if source set to true
- status=200
- },
- {
- _id=,
- _source= // if source set to true
- status=200
- }
- ],
- errors=[]
- }
- */
\ No newline at end of file
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-java.java b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-java.java
new file mode 100644
index 00000000..0d4cc91b
--- /dev/null
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-java.java
@@ -0,0 +1,30 @@
+Map searchQuery = new HashMap<>();
+Map equals = new HashMap<>();
+equals.put("capacity", 4);
+searchQuery.put("equals", equals);
+
+Map changes = new HashMap<>();
+changes.put("capacity", 42);
+
+Map> result = kuzzle
+ .getDocumentController()
+ .updateByQuery("nyc-open-data", "yellow-taxi", searchQuery, changes, Lang.KONCORDE)
+ .get();
+
+/*
+{
+ successes=[
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ },
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ }
+ ],
+ errors=[]
+}
+*/
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-java.test.yml b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-java.test.yml
new file mode 100644
index 00000000..323b19af
--- /dev/null
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-java.test.yml
@@ -0,0 +1,19 @@
+name: java-document#updateByQuery-koncorde
+description: Update documents matching query
+hooks:
+ before: |
+ curl -XDELETE kuzzle:7512/nyc-open-data
+ curl -XPOST kuzzle:7512/nyc-open-data/_create
+ curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+ for i in 1 2 ; do
+ curl -H "Content-type: application/json" -d '{"capacity": 4}' kuzzle:7512/nyc-open-data/yellow-taxi/document_$i/_create
+ done
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"capacity": 7}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ curl -XPOST kuzzle:7512/nyc-open-data/_refresh
+ after:
+template: print-result-array
+expected:
+ - "id=document_1(.*)_version=2(.*)status=200"
+ - "id=document_2(.*)_version=2(.*)status=200"
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-kotlin.kt b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-kotlin.kt
new file mode 100644
index 00000000..ef90e8fc
--- /dev/null
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-kotlin.kt
@@ -0,0 +1,39 @@
+val equals: Map =
+ HashMap().apply {
+ put("capacity", 4)
+ }
+
+val searchQuery: Map =
+ HashMap().apply {
+ put("equals", equals)
+ }
+
+val changes: Map =
+ HashMap().apply {
+ put("capacity", 42)
+ }
+
+
+val result: Map> =
+ kuzzle
+ .documentController
+ .updateByQuery("nyc-open-data", "yellow-taxi", searchQuery, changes, lang = Lang.KONCORDE)
+ .get()
+
+/*
+{
+ successes=[
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ },
+ {
+ _id=,
+ _source= // if source set to true
+ status=200
+ }
+ ],
+ errors=[]
+}
+*/
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-kotlin.test.yml b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-kotlin.test.yml
new file mode 100644
index 00000000..89fd0d89
--- /dev/null
+++ b/doc/1/controllers/document/update-by-query/snippets/update-by-query-koncorde-kotlin.test.yml
@@ -0,0 +1,17 @@
+name: kotlin-document#updateByQuery-koncorde
+description: Update documents matching query
+hooks:
+ before: |
+ curl -XDELETE kuzzle:7512/nyc-open-data
+ curl -XPOST kuzzle:7512/nyc-open-data/_create
+ curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
+ for i in 1 2 ; do
+ curl -H "Content-type: application/json" -d '{"capacity": 4}' kuzzle:7512/nyc-open-data/yellow-taxi/document_$i/_create
+ done
+ for i in 1 2 3 4 5; do
+ curl -H "Content-type: application/json" -d '{"capacity": 7}' kuzzle:7512/nyc-open-data/yellow-taxi/_create
+ done
+ curl -XPOST kuzzle:7512/nyc-open-data/_refresh
+ after:
+template: print-result
+expected: "id=document_1(.*)_version=2(.*)status=200(.*)id=document_2(.*)_version=2(.*)status=200"
\ No newline at end of file
diff --git a/doc/1/controllers/document/update-by-query/snippets/update-by-query-kotlin.kt b/doc/1/controllers/document/update-by-query/snippets/update-by-query-kotlin.kt
deleted file mode 100644
index d93157f6..00000000
--- a/doc/1/controllers/document/update-by-query/snippets/update-by-query-kotlin.kt
+++ /dev/null
@@ -1,21 +0,0 @@
-val match: Map =
- HashMap().apply {
- put("capacity", 4)
- }
-
-val searchQuery: Map =
- HashMap().apply {
- put("match", match)
- }
-
-val changes: Map =
- HashMap().apply {
- put("capacity", 42)
- }
-
-
-val result: Map> =
- kuzzle
- .documentController
- .updateByQuery("nyc-open-data", "yellow-taxi", searchQuery, changes)
- .get()
diff --git a/doc/1/controllers/document/validate/snippets/validate-kotlin.kt b/doc/1/controllers/document/validate/snippets/validate-kotlin.kt
index 412e1826..fffeaa02 100644
--- a/doc/1/controllers/document/validate/snippets/validate-kotlin.kt
+++ b/doc/1/controllers/document/validate/snippets/validate-kotlin.kt
@@ -3,10 +3,8 @@ val document: Map =
put("key", "value")
}
-
val result: Boolean =
- kuzzle
- .documentController
- .validate("nyc-open-data", "yellow-taxi", document)
- .get()
-
\ No newline at end of file
+ kuzzle
+ .documentController
+ .validate("nyc-open-data", "yellow-taxi", document)
+ .get()
diff --git a/doc/1/controllers/realtime/count/snippets/count-kotlin.kt b/doc/1/controllers/realtime/count/snippets/count-kotlin.kt
index 97691ba8..360a35ba 100644
--- a/doc/1/controllers/realtime/count/snippets/count-kotlin.kt
+++ b/doc/1/controllers/realtime/count/snippets/count-kotlin.kt
@@ -3,14 +3,15 @@ val filters: Map = HashMap().apply {
}
val roomId: String = kuzzle.realtimeController.subscribe(
- "nyc-open-data",
- "yellow-taxi",
- filters) {
+ "nyc-open-data",
+ "yellow-taxi",
+ filters
+) {
if (it.scope == "in") {
- println("Document entered the scope")
+ println("Document entered the scope")
} else {
- println("Document left the scope")
+ println("Document left the scope")
}
- }.get()
+}.get()
-val result: Int = kuzzle.realtimeController.count(roomId).get()
\ No newline at end of file
+val result: Int = kuzzle.realtimeController.count(roomId).get()
diff --git a/doc/1/controllers/server/admin-exists/snippets/admin-exists-kotlin.kt b/doc/1/controllers/server/admin-exists/snippets/admin-exists-kotlin.kt
index 6e7a6d5e..774d9571 100644
--- a/doc/1/controllers/server/admin-exists/snippets/admin-exists-kotlin.kt
+++ b/doc/1/controllers/server/admin-exists/snippets/admin-exists-kotlin.kt
@@ -1,2 +1,2 @@
val result: Boolean =
- kuzzle.serverController.adminExists().get()
\ No newline at end of file
+ kuzzle.serverController.adminExists().get()
diff --git a/doc/1/controllers/server/get-all-stats/snippets/get-all-stats-kotlin.kt b/doc/1/controllers/server/get-all-stats/snippets/get-all-stats-kotlin.kt
index f08b0195..514a7c75 100644
--- a/doc/1/controllers/server/get-all-stats/snippets/get-all-stats-kotlin.kt
+++ b/doc/1/controllers/server/get-all-stats/snippets/get-all-stats-kotlin.kt
@@ -1,4 +1,4 @@
val result: Map = kuzzle
.serverController
.getAllStats()
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/server/get-config/snippets/get-config-kotlin.kt b/doc/1/controllers/server/get-config/snippets/get-config-kotlin.kt
index 955c6434..cc625607 100644
--- a/doc/1/controllers/server/get-config/snippets/get-config-kotlin.kt
+++ b/doc/1/controllers/server/get-config/snippets/get-config-kotlin.kt
@@ -1,4 +1,4 @@
val result: Map = kuzzle
.serverController
.getConfig()
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/server/get-last-stats/snippets/get-last-stats-kotlin.kt b/doc/1/controllers/server/get-last-stats/snippets/get-last-stats-kotlin.kt
index deb49c10..70743075 100644
--- a/doc/1/controllers/server/get-last-stats/snippets/get-last-stats-kotlin.kt
+++ b/doc/1/controllers/server/get-last-stats/snippets/get-last-stats-kotlin.kt
@@ -1,4 +1,4 @@
val result: Map = kuzzle
.serverController
.getLastStats()
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/server/get-stats/snippets/get-stats-kotlin.kt b/doc/1/controllers/server/get-stats/snippets/get-stats-kotlin.kt
index fd504297..52a77364 100644
--- a/doc/1/controllers/server/get-stats/snippets/get-stats-kotlin.kt
+++ b/doc/1/controllers/server/get-stats/snippets/get-stats-kotlin.kt
@@ -1,7 +1,7 @@
-val startTime = Date(1234567890000);
-val stopTime = Date(1541426610000);
+val startTime = Date(1234567890000)
+val stopTime = Date(1541426610000)
val result: Map = kuzzle
.serverController
.getStats(startTime, stopTime)
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/server/info/snippets/info-kotlin.kt b/doc/1/controllers/server/info/snippets/info-kotlin.kt
index aa109d1d..84dcefcd 100644
--- a/doc/1/controllers/server/info/snippets/info-kotlin.kt
+++ b/doc/1/controllers/server/info/snippets/info-kotlin.kt
@@ -1,4 +1,4 @@
val result: Map = kuzzle
.serverController
.info()
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/controllers/server/now/snippets/now-kotlin.kt b/doc/1/controllers/server/now/snippets/now-kotlin.kt
index e38e5f8b..6f9603bf 100644
--- a/doc/1/controllers/server/now/snippets/now-kotlin.kt
+++ b/doc/1/controllers/server/now/snippets/now-kotlin.kt
@@ -1,4 +1,4 @@
val result: Date = kuzzle
.serverController
.now()
- .get()
\ No newline at end of file
+ .get()
diff --git a/doc/1/core-classes/lang/index.md b/doc/1/core-classes/lang/index.md
new file mode 100644
index 00000000..dee7ce07
--- /dev/null
+++ b/doc/1/core-classes/lang/index.md
@@ -0,0 +1,6 @@
+---
+code: true
+type: branch
+title: Lang
+description: Lang Enum Class
+---
\ No newline at end of file
diff --git a/doc/1/core-classes/lang/introduction/index.md b/doc/1/core-classes/lang/introduction/index.md
new file mode 100644
index 00000000..db09246f
--- /dev/null
+++ b/doc/1/core-classes/lang/introduction/index.md
@@ -0,0 +1,34 @@
+---
+code: false
+type: page
+title: Introduction
+description: Lang object description
+order: 0
+---
+
+## Response
+
+`Lang` is an **Enum** class listing the possible query syntax to use for search queries.
+
+## Properties
+
+| Property | Type | Description |
+|--- |--- |--- |
+| `ELASTICSEARCH` | Lang
| For Elasticsearch query syntax. |
+| `KONCORDE` | Lang
| For Koncorde query syntax. |
+
+Those enums contain a `lang` value, which is the query language as `String` in lowercase.
+
+```kotlin
+print(Lang.ELASTICSEARCH.lang)
+/*
+"elasticsearch"
+*/
+```
+
+```kotlin
+print(Lang.KONCORDE.lang)
+/*
+"koncorde"
+*/
+```
\ No newline at end of file
diff --git a/doc/1/getting-started/java/index.md b/doc/1/getting-started/java/index.md
index 913f72a4..17d8e7e0 100644
--- a/doc/1/getting-started/java/index.md
+++ b/doc/1/getting-started/java/index.md
@@ -43,7 +43,7 @@ To build the project, add the following lines:
io.kuzzle
sdk-jvm
- 1.0.1
+ 1.1.0
pom
```
@@ -57,14 +57,14 @@ repositories {
}
}
dependencies {
- compile 'io.kuzzle:sdk-jvm:1.0.1'
+ compile 'io.kuzzle:sdk-jvm:1.1.0'
}
```
### Ivy
```html
-
+
```
diff --git a/doc/1/getting-started/kotlin/snippets/document-kotlin.kt b/doc/1/getting-started/kotlin/snippets/document-kotlin.kt
index 52af7870..4e246cd8 100644
--- a/doc/1/getting-started/kotlin/snippets/document-kotlin.kt
+++ b/doc/1/getting-started/kotlin/snippets/document-kotlin.kt
@@ -1,36 +1,35 @@
-import io.kuzzle.sdk.*;
-import io.kuzzle.sdk.protocol.WebSocket;
+import io.kuzzle.sdk.*
+import io.kuzzle.sdk.protocol.WebSocket
fun main() {
- // Creates a WebSocket connection.
- // Replace "kuzzle" with
- // your Kuzzle host name (e.g. "localhost")
- val ws = WebSocket("kuzzle");
-
- // Instantiates a Kuzzle client
- val kuzzle = Kuzzle(ws).apply {
- // Connects to the server.
- connect()
- }
- println("Connected!");
+ // Creates a WebSocket connection.
+ // Replace "kuzzle" with
+ // your Kuzzle host name (e.g. "localhost")
+ val ws = WebSocket("kuzzle")
- try {
- // New document content
- val content: Map = HashMap().apply {
- put("name", "John")
- put("birthday", "1995-11-27")
- put("license", "B")
+ // Instantiates a Kuzzle client
+ val kuzzle = Kuzzle(ws).apply {
+ // Connects to the server.
+ connect()
}
- // Stores the document in the "yellow-taxi" collection.
- kuzzle
- .documentController
- .create( "nyc-open-data", "yellow-taxi", content).get();
- println("New document added to the yellow-taxi collection!")
-
- } catch(e: Exception) {
- e.printStackTrace()
- } finally {
- // Disconnects the SDK.
- kuzzle.disconnect()
- }
-}
+ println("Connected!")
+
+ try {
+ // New document content
+ val content: Map = HashMap().apply {
+ put("name", "John")
+ put("birthday", "1995-11-27")
+ put("license", "B")
+ }
+ // Stores the document in the "yellow-taxi" collection.
+ kuzzle
+ .documentController
+ .create("nyc-open-data", "yellow-taxi", content).get()
+ println("New document added to the yellow-taxi collection!")
+ } catch (e: Exception) {
+ e.printStackTrace()
+ } finally {
+ // Disconnects the SDK.
+ kuzzle.disconnect()
+ }
+}
\ No newline at end of file
diff --git a/doc/1/getting-started/kotlin/snippets/firstconnection-kotlin.kt b/doc/1/getting-started/kotlin/snippets/firstconnection-kotlin.kt
index a81e3f85..75c1e210 100644
--- a/doc/1/getting-started/kotlin/snippets/firstconnection-kotlin.kt
+++ b/doc/1/getting-started/kotlin/snippets/firstconnection-kotlin.kt
@@ -2,35 +2,35 @@ import io.kuzzle.sdk.*;
import io.kuzzle.sdk.protocol.WebSocket;
fun main() {
- // Creates a WebSocket connection.
- // Replace "kuzzle" with
- // your Kuzzle hostname like "localhost"
- val ws = WebSocket("kuzzle");
+ // Creates a WebSocket connection.
+ // Replace "kuzzle" with
+ // your Kuzzle hostname like "localhost"
+ val ws = WebSocket("kuzzle")
- // Instantiates a Kuzzle client
- val kuzzle = Kuzzle(ws).apply {
- // Connects to the server.
- connect()
- };
- println("Connected!")
+ // Instantiates a Kuzzle client
+ val kuzzle = Kuzzle(ws).apply {
+ // Connects to the server.
+ connect()
+ }
+ println("Connected!")
- try {
- // Freshly installed Kuzzle servers are empty: we need to create
- // a new index.
- kuzzle
- .indexController
- .create("nyc-open-data").get();
- println("Index nyc-open-data created!")
+ try {
+ // Freshly installed Kuzzle servers are empty: we need to create
+ // a new index.
+ kuzzle
+ .indexController
+ .create("nyc-open-data").get()
+ println("Index nyc-open-data created!")
- // Creates a collection
- kuzzle
- .collectionController
- .create("nyc-open-data", "yellow-taxi").get();
- println("Collection yellow-taxi created!")
- } catch(e: Exception){
- e.printStackTrace()
- } finally {
- // Disconnects the SDK
- kuzzle.disconnect()
- }
+ // Creates a collection
+ kuzzle
+ .collectionController
+ .create("nyc-open-data", "yellow-taxi").get()
+ println("Collection yellow-taxi created!")
+ } catch (e: Exception) {
+ e.printStackTrace()
+ } finally {
+ // Disconnects the SDK
+ kuzzle.disconnect()
+ }
}
diff --git a/doc/1/getting-started/kotlin/snippets/realtime-kotlin.kt b/doc/1/getting-started/kotlin/snippets/realtime-kotlin.kt
index c3cdc569..47eafe07 100644
--- a/doc/1/getting-started/kotlin/snippets/realtime-kotlin.kt
+++ b/doc/1/getting-started/kotlin/snippets/realtime-kotlin.kt
@@ -1,67 +1,66 @@
-import io.kuzzle.sdk.*;
-import io.kuzzle.sdk.protocol.WebSocket;
+import io.kuzzle.sdk.*
+import io.kuzzle.sdk.protocol.WebSocket
fun main() {
- // Creates a WebSocket connection.
- // Replace "kuzzle" with
- // your Kuzzle hostname like "localhost"
- val ws = WebSocket("kuzzle");
-
- // Instantiates a Kuzzle client
- val kuzzle = Kuzzle(ws).apply {
- // Connects to the server.
- connect()
- };
- println("Connected!")
+ // Creates a WebSocket connection.
+ // Replace "kuzzle" with
+ // your Kuzzle hostname like "localhost"
+ val ws = WebSocket("kuzzle")
- try {
- // Subscribes to notifications for drivers having a "B" driver license.
- val equals: Map = HashMap().apply {
- put("license", "B")
- }
- val filters: Map = HashMap().apply {
- put("equals", equals)
+ // Instantiates a Kuzzle client
+ val kuzzle = Kuzzle(ws).apply {
+ // Connects to the server.
+ connect()
}
+
+ try {
+ // Subscribes to notifications for drivers having a "B" driver license.
+ val equals: Map = HashMap().apply {
+ put("license", "B")
+ }
+ val filters: Map = HashMap().apply {
+ put("equals", equals)
+ }
+ println("Connected!")
- // Sends the subscription
- kuzzle
- .realtimeController
- .subscribe("nyc-open-data", "yellow-taxi", filters) { notification ->
- val content: Map = notification.result as Map
- println("New created document notification: " + content)
- /*
- {
- _source={
- birthday=1995-11-27,
- license=B,
- name=John,
- _kuzzle_info={
- createdAt=1605694059151,author=-1
- }
- },
- _id=9PDS2nUBeGNr7nwl8j2Q,
- _version=1
- }
- */
- }.get();
- println("Successfully subscribed!")
+ // Sends the subscription
+ kuzzle
+ .realtimeController
+ .subscribe("nyc-open-data", "yellow-taxi", filters) { notification ->
+ val content: Map = notification.result as Map
+ println("New created document notification: " + content)
+ /*
+ {
+ _source={
+ birthday=1995-11-27,
+ license=B,
+ name=John,
+ _kuzzle_info={
+ createdAt=1605694059151,author=-1
+ }
+ },
+ _id=9PDS2nUBeGNr7nwl8j2Q,
+ _version=1
+ }
+ */
+ }.get()
+ println("Successfully subscribed!")
- // Writes a new document. This triggers a notification
- // sent to our subscription.
- val content: Map