package druidGrpc

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Check (HealthCheckRequest, HealthCheckResponse)

  health.proto:38

  returns health of the server

• rpc Watch (HealthCheckRequest, stream HealthCheckResponse)

  health.proto:43

  streaming health check api. The server will immediately send back a message indicating the current serving status. It will then subsequently send a new message whenever the service's serving status changes.

• rpc SubmitQuery (QueryRequest, QueryResponse)

  query.proto:25

  message QueryRequest

  query.proto:70

  • string query = 1

  • QueryResultFormat resultFormat = 2

  • map<string, string> context = 3

  • repeated QueryParameter parameters = 4

    Query parameters. If your query is SELECT * FROM foo WHERE x = ? AND y > ? Then you would include two parameters in the order in which the question marks lexically appear in the query.

  • optional string protobufMessageName = 5

    The name of the Protobuf message to encode the response if the resultFormat is one of the PROTOBUF formats.

  • repeated string skipColumns = 6

    used only for native query columns to skip writing in the result, for example, it can used to skip writing time field in the result for timeseries query

  • repeated string timeColumns = 7

    used only for native query columns which should be converted to Timestamp

  • QueryType queryType = 8

  message QueryResponse

  query.proto:126

  • string queryId = 1

  • QueryStatus status = 2

  • optional string errorMessage = 3

    Error message if the query fails. Not set if the query succeeds.

  • repeated ColumnSchema columns = 4

    The schema of the returned results. This schema is redundant for the JSON and Protobuf formats. It can be used to generate column heads, and understand types, for the CSV result format.

  • optional bytes data = 5

    The query response, encoded using the requested response format. Note that the entire response is placed into a single messages. As a result, this RPC is intended ONLY for queries that return small result sets. It will perform poorly (and consume excess memory) if used for large result sets.

Used in: QueryResponse

• string name = 1

• string sqlType = 2

• DruidType druidType = 3

Used in: ColumnSchema

• UNKNOWN_TYPE = 0

  Default value for unknown, or for future new values

• STRING = 1

  as seen by old clients.

• LONG = 2

• DOUBLE = 3

• FLOAT = 4

• STRING_ARRAY = 5

• LONG_ARRAY = 6

• DOUBLE_ARRAY = 7

• FLOAT_ARRAY = 8

• COMPLEX = 9

Used as request type in: Health.Check, Health.Watch

• string service = 1

Used as response type in: Health.Check, Health.Watch

• HealthCheckResponse.ServingStatus status = 1

Used in: HealthCheckResponse

• UNKNOWN = 0

• SERVING = 1

• NOT_SERVING = 2

• SERVICE_UNKNOWN = 3

  Used only by the Watch method.

Value for a query parameter. The value is essentially a variant of the supported parameter types. The type chosen here must match (or be converable to) the type of the corresponding expression in the SQL statement.

Used in: QueryRequest

• oneof value

  • bool nullValue = 1

  • string stringValue = 2

  • sint64 longValue = 3

  • double doubleValue = 4

  • StringArray arrayValue = 5

Defines the format of the query results. Must be one of the non-unknown formats.

Used in: QueryRequest

• UNKNOWN_FORMAT = 0

  Default value. An old server will see this value

• CSV = 1

  (and fail the request) if a new client passes a new format.

• JSON_ARRAY = 3

  JSON_OBJECT = 2; -- Not yet

• JSON_ARRAY_LINES = 5

  JSON_OBJECT_LINES = 4; -- Not yet

• PROTOBUF_INLINE = 6

  The protobuf formats also require that the protobufMessageName be set in the query request.

• PROTOBUF_RESPONSE = 7

Unauthorized errors return as a StatusRuntimeException with getStatus().getCode() == Status.Code.PERMISSION_DENIED

Used in: QueryResponse

• UNKNOWN_STATUS = 0

  Default value which means "unknown failure". Older clients

• OK = 1

  will see this value if a future version adds a new failure type.

• REQUEST_ERROR = 3

• INVALID_SQL = 4

• RUNTIME_ERROR = 5

Used in: QueryRequest

• SQL = 0

• NATIVE = 1

Query pararameter value for string array properties. At present, string arrays are primarily used by the MSQ engine, which is not yet available via the gRPC API.

Used in: QueryParameter

• repeated string value = 1