code	type	title	description
true	page	Query	Base method to send API query to Kuzzle

query

Base method used to send queries to Kuzzle, following the API Documentation.

:::warning This is a low-level method, exposed to allow advanced SDK users to bypass high-level methods. :::

Arguments

public CompletableFuture<Response> query(
  final ConcurrentHashMap<String, Object> query)
      throws InternalException, NotConnectedException

Argument	Type	Description
`query`	ConcurrentHashMap<String, Object>	API request

All properties necessary for the Kuzzle API can be added in the query object. The following properties are the most common.

Property	Type	Description
`controller`	String	Controller name (mandatory)
`action`	String	Action name (mandatory)
`body`	ConcurrentHashMap<String, Object>	Query body for this action
`index`	String	Index name for this action
`collection`	String	Collection name for this action
`_id`	String	id for this action
`volatile`	ConcurrentHashMap<String, Object>	Additional information to send to Kuzzle

Returns a Response object which represents a raw Kuzzle API response. See the API Documentation.

<<< ./snippets/query.java