package exec.shared

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: MinorFragmentProfile, QueryResult, user.CreatePreparedStatementResp, user.GetCatalogsResp, user.GetColumnsResp, user.GetSchemasResp, user.GetServerMetaResp, user.GetTablesResp, user.QueryPlanFragments

• optional string error_id = 1

  for debug tracing purposes

• optional DrillbitEndpoint endpoint = 2

• optional DrillPBError.ErrorType error_type = 3

• optional string message = 4

• optional ExceptionWrapper exception = 5

• repeated ParsingError parsing_error = 6

  optional, used when providing location of error within a piece of text.

Used in: DrillPBError

• CONNECTION = 0

  equivalent to SQLClientInfoException - handshake version error - invalid schema

• DATA_READ = 1

  equivalent to SQLRecoverableException - corrupt files: can't be read. FS read error - parsing error due to incomplete or incorrectly written records

• DATA_WRITE = 2

  equivalent to SQLDataException - data type unsupported by format

• FUNCTION = 3

  equivalent to SQLDataException - Casting errors - function not found for incoming types after implicit casting - Flatten misuse

• PARSE = 4

  equivalent to SQLSyntaxErrorException - typos - missing table - SQL keyword misuse - function names/resolution

• PERMISSION = 5

  equivalent to SQLInvalidAuthorizationSpecException

• PLAN = 6

  equivalent to SQLNonTransientException

• RESOURCE = 7

  equivalent to SQLRecoverableException or SQLTransientException - Recoverable: memory, disk - Transient: network

• SYSTEM = 8

  equivalent to SQLNonTransientException. - unexpected internal state - uncategorized operation general user action is to contact the Drill team for assistance

• UNSUPPORTED_OPERATION = 9

  equivalent to SQLFeatureNotSupportedException - unimplemented feature, option, or execution path - schema change in operator that does not support it

• VALIDATION = 10

  SQL validation exception - invalid schema path - invalid entries in SQL tree

• EXECUTION_ERROR = 11

  Execution exception - Internal errors not related to bad code

• INTERNAL_ERROR = 12

  Internal exception - Failed assertions - Other "this should not happen" cases

• UNSPECIFIED_ERROR = 13

  Unspecified exception - Exception caught but cause is unknown Indicates code that needs revisiting to move error reporting closer to the cause.

• PLUGIN = 14

  Plugin exception - A failure has occurred within a plugin. Indicates that a plugin is misconfigured or contains a bug.

Used in: DrillPBError

• optional string exception_class = 1

• optional string message = 2

• repeated StackTraceElementWrapper stack_trace = 3

• optional ExceptionWrapper cause = 4

Used in: MinorFragmentProfile

• SENDING = 0

• AWAITING_ALLOCATION = 1

• RUNNING = 2

• FINISHED = 3

• CANCELLED = 4

• FAILED = 5

• CANCELLATION_REQUESTED = 6

Jar contains jar name and list of function signatures. Function signature is concatenation of function name and its input parameters.

Used in: Registry

• optional string name = 1

• repeated string function_signature = 2

Used in: QueryProfile

• optional int32 major_fragment_id = 1

• repeated MinorFragmentProfile minor_fragment_profile = 2

Used in: OperatorProfile

• optional int32 metric_id = 1

• optional int64 long_value = 2

• optional double double_value = 3

Used in: bit.control.FragmentStatus, MajorFragmentProfile

• optional FragmentState state = 1

• optional DrillPBError error = 2

• optional int32 minor_fragment_id = 3

• repeated OperatorProfile operator_profile = 4

• optional int64 start_time = 5

• optional int64 end_time = 6

• optional int64 memory_used = 7

• optional int64 max_memory_used = 8

• optional DrillbitEndpoint endpoint = 9

• optional int64 last_update = 10

• optional int64 last_progress = 11

Used in: SerializedField

• optional NamePart.Type type = 1

• optional string name = 2

• optional NamePart child = 3

Used in: NamePart

• NAME = 0

• ARRAY = 1

• optional int32 node_id = 1

• optional int64 memory_footprint = 2

Used in: MinorFragmentProfile

• repeated StreamProfile input_profile = 1

• optional int32 operator_id = 3

• optional int32 operator_type = 4

• optional int64 setup_nanos = 5

• optional int64 process_nanos = 6

• optional int64 peak_local_memory_allocated = 7

• repeated MetricValue metric = 8

• optional int64 wait_nanos = 9

• optional string operator_type_name = 10

Used in: DrillPBError

• optional int32 start_column = 2

• optional int32 start_row = 3

• optional int32 end_column = 4

• optional int32 end_row = 5

Used by the server when sending query result data batches to the client

• optional QueryId query_id = 1

• optional int32 row_count = 2

• optional RecordBatchDef def = 3

• optional int32 affected_rows_count = 4

Used in: bit.FragmentHandle, bit.data.FragmentRecordBatch, bit.data.RuntimeFilterBDef, QueryData, QueryProfile, QueryResult, user.QueryPlanFragments, user.RequestResults

• optional sfixed64 part1 = 1

• optional sfixed64 part2 = 2

• optional string query = 1

• optional int64 start = 2

• optional QueryResult.QueryState state = 3

• optional string user = 4

• optional DrillbitEndpoint foreman = 5

• optional string options_json = 6

• optional double total_cost = 7

• optional string queue_name = 8

• optional QueryId id = 1

• optional QueryType type = 2

• optional int64 start = 3

• optional int64 end = 4

• optional string query = 5

• optional string plan = 6

• optional DrillbitEndpoint foreman = 7

• optional QueryResult.QueryState state = 8

• optional int32 total_fragments = 9

• optional int32 finished_fragments = 10

• repeated MajorFragmentProfile fragment_profile = 11

• optional string user = 12

• optional string error = 13

• optional string verboseError = 14

• optional string error_id = 15

• optional string error_node = 16

• optional string options_json = 17

• optional int64 planEnd = 18

• optional int64 queueWaitEnd = 19

• optional double total_cost = 20

• optional string queue_name = 21

• optional string queryId = 22

• optional int32 autoLimit = 23

• repeated string scanned_plugins = 24

Used by the server to report informations about the query state to the client

• optional QueryResult.QueryState query_state = 1

• optional QueryId query_id = 2

• repeated DrillPBError error = 3

Used in: QueryInfo, QueryProfile, QueryResult, user.QueryPlanFragments

• STARTING = 0

  query has been scheduled for execution. This is post-enqueued.

• RUNNING = 1

• COMPLETED = 2

  query has completed successfully

• CANCELED = 3

  query has been cancelled, and all cleanup is complete

• FAILED = 4

• CANCELLATION_REQUESTED = 5

  cancellation has been requested, and is being processed

• ENQUEUED = 6

  query has been enqueued. this is pre-starting.

• PREPARING = 7

  query is at preparation stage, foreman is initializing

• PLANNING = 8

  query is at planning stage (includes logical or / and physical planning)

Used in: QueryProfile, user.GetQueryPlanFragments, user.RunQuery

• SQL = 1

• LOGICAL = 2

• PHYSICAL = 3

• EXECUTION = 4

• PREPARED_STATEMENT = 5

  Input is a prepared statement

Used in: bit.data.FragmentRecordBatch, QueryData

• optional int32 record_count = 1

• repeated SerializedField field = 2

• optional bool carries_two_byte_selection_vector = 3

• optional int32 affected_rows_count = 4

  The value is set when result set is disabled and its value corresponds to number of rows affected by query (see JDBC java.sql.ResultSet#getUpdateCount())

Registry that contains list of jars, each jar contains its name and list of function signatures. Structure example: REGISTRY -> Jar1.jar -> upper(VARCHAR-REQUIRED) -> upper(VARCHAR-OPTIONAL) -> Jar2.jar -> lower(VARCHAR-REQUIRED) -> lower(VARCHAR-OPTIONAL)

• repeated Jar jar = 1

Used in: bit.control.BitControlHandshake, bit.data.BitClientHandshake, user.UserToBitHandshake

• BIT_CONTROL = 0

• BIT_DATA = 1

• USER = 2

• optional string mechanism = 1

• optional bytes data = 2

• optional SaslStatus status = 3

Used in: SaslMessage

• SASL_UNKNOWN = 0

• SASL_START = 1

• SASL_IN_PROGRESS = 2

• SASL_SUCCESS = 3

• SASL_FAILED = 4

Used in: RecordBatchDef

• optional common.MajorType major_type = 1

  the type associated with this field.

• optional NamePart name_part = 2

• repeated SerializedField child = 3

  only in the cases of type == MAP or REPEAT_MAP or REPEATED_LIST

• optional int32 value_count = 4

• optional int32 var_byte_length = 5

• optional int32 buffer_length = 7

Used in: ExceptionWrapper

• optional string class_name = 1

• optional string file_name = 2

• optional int32 line_number = 3

• optional string method_name = 4

• optional bool is_native_method = 5

Used in: OperatorProfile

• optional int64 records = 1

• optional int64 batches = 2

• optional int64 schemas = 3

Used in: bit.control.PlanFragment, user.UserToBitHandshake

• optional string user_name = 1