Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Error CodeError DefinitionError Description
 REGION_NOT_FOUNDNo Region exists for the name provided
 CONSTRAINT_VIOLATIONThe key-constraint on the region has been violated and incompatible

 

 

Query

Description

 Pass an OQL query to the server, which will execute it and return the result.

Request fields

  1. query

    • Type: string

    • Description: OQL describing the query to run

  2. timeoutInMillis

    • Type: int

    • Optional (defaults to 0).

    • Description: a timeout in milliseconds after which the query will terminate. If less than or equal to 0, no user-defined timeout is imposed.

  3. parameters

    • Type: repeated EncodedValue

    • Must match the number of parameters expected for the query. Can be absent if no parameters are needed.

    • Description: must match any parameters specified in OQL

Response fields

  1. queryResults

    • Type: repeated string

    • Description: One JSON formatted string per response (see AbstractBaseController.processQueryResponse)

Behavior notes

The query will timeout on the shorter of the provided timeout or the cache’s timeout (configured in gemfire.Cache.MAX_QUERY_EXECUTION_TIME).

Errors

  • CONSTRAINT_VIOLATION - Bind parameter is not of the expected type

  • BAD_QUERY - Name in the query cannot be resolved!

  • BAD_QUERY - Query cannot be parsed.

  • PARAMETER_MISMATCH - The number of bound parameters does not match the number of placeholders!

  • OPERATION_NOT_PERMITTED - Query is not permitted on this type of region!

  • OPERATION_TIMEOUT - Query execution time has exceeded max query execution time (gemfire.Cache.MAX_QUERY_EXECUTION_TIME) configured!

  • OPERATION_TIMEOUT - Query execution time has exceeded provided timeout

GetRegion

Description

Get a structure containing information about a region.

...