Manticoresearch.Api.Utils (manticoresearch v1.0.2)

API calls for all endpoints tagged Utils.

Link to this section Summary

Functions

Perform SQL requests Run a query in SQL format. Expects a query string passed through body parameter and optional raw_response parameter that defines a format of response. raw_response can be set to False for Select queries only, e.g., SELECT * FROM myindex The query string must be URL encoded if raw_response parameter is set to False The query string must be as is (no URL encoding) if raw_response parameter is set to True or omitted. The response object depends on the query executed. In select mode the response has same format as /search operation.

Link to this section Functions

Link to this function

sql(connection, body, opts \\ [])

Specs

sql(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, map()}
  | {:ok, Manticoresearch.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Perform SQL requests Run a query in SQL format. Expects a query string passed through body parameter and optional raw_response parameter that defines a format of response. raw_response can be set to False for Select queries only, e.g., SELECT * FROM myindex The query string must be URL encoded if raw_response parameter is set to False The query string must be as is (no URL encoding) if raw_response parameter is set to True or omitted. The response object depends on the query executed. In select mode the response has same format as /search operation.

Parameters

  • connection (Manticoresearch.Connection): Connection to server
  • body (String.t): A query parameter string. The query string must be URL encoded if raw_response parameter is set to False The query string must be as is (no URL encoding) if raw_response parameter is set to True or omitted.
  • opts (KeywordList): [optional] Optional parameters
    • :raw_response (boolean()): Optional parameter, defines a format of response. Can be set to False for Select only queries and set to True or omitted for any type of queries:

      Returns

on success {:error, info} on failure