package exec.user

Get desktop application:
View/edit binary Protocol Buffers messages

• optional int32 rpc_version = 2

• optional HandshakeStatus status = 3

• optional string errorId = 4

• optional string errorMessage = 5

• optional RpcEndpointInfos server_infos = 6

• repeated string authenticationMechanisms = 7

• repeated RpcType supported_methods = 8

• optional bool encrypted = 9

• optional int32 maxWrappedSize = 10

Message encapsulating metadata for a Catalog.

Used in: GetCatalogsResp

• optional string catalog_name = 1

• optional string description = 2

• optional string connect = 3

Used in: ServerMeta

• CS_UNKNOWN = 0

  Unknown support (for forward compatibility)

• CS_GROUP_BY = 1

  COLLATE clause can be added after each grouping column

Message encapsulating metadata for a Column.

Used in: GetColumnsResp

• optional string catalog_name = 1

• optional string schema_name = 2

• optional string table_name = 3

• optional string column_name = 4

• optional int32 ordinal_position = 5

• optional string default_value = 6

• optional bool is_nullable = 7

• optional string data_type = 8

• optional int32 char_max_length = 9

• optional int32 char_octet_length = 10

• optional int32 numeric_precision = 11

• optional int32 numeric_precision_radix = 12

• optional int32 numeric_scale = 13

• optional int32 date_time_precision = 14

• optional string interval_type = 15

• optional int32 interval_precision = 16

• optional int32 column_size = 17

How a column can be used in WHERE clause

Used in: ResultColumnMetadata

• UNKNOWN_SEARCHABILITY = 0

• NONE = 1

  can't be used in WHERE clause

• CHAR = 2

  can be used in WHERE clause but only with LIKE predicate

• NUMBER = 3

  can be used in a WHERE clause with all the comparison operators except LIKE

• ALL = 4

  can be used in a WHERE clause with all the comparison operators

Whether a column can be updatable.

Used in: ResultColumnMetadata

• UNKNOWN_UPDATABILITY = 0

• READ_ONLY = 1

• WRITABLE = 2

Used in: ServerMeta

• required common.MinorType from = 1

• required common.MinorType to = 2

Used in: ServerMeta

• CN_NONE = 1

  Correlation names are not supported

• CN_DIFFERENT_NAMES = 2

  Correlation names are supported, but names have to

• CN_ANY = 3

  be different from the tables they represent

  Correlation names are supported without restriction

Request message to create a prepared statement. Currently prepared statement only accepts a SQL query. Query parameter support is not included in current implementation.

• optional string sql_query = 1

Response message for CreatePreparedStatementReq.

• optional RequestStatus status = 1

• optional PreparedStatement prepared_statement = 2

• optional shared.DrillPBError error = 3

Used in: ServerMeta

• DL_UNKNOWN = 0

  Unknown support (for forward compatibility)

• DL_DATE = 1

  DATE literal is supported

• DL_TIME = 2

  TIME literal is supported

• DL_TIMESTAMP = 3

  TIMESTAMP literal is supported

• DL_INTERVAL_YEAR = 4

  INTERVAL YEAR literal is supported

• DL_INTERVAL_MONTH = 5

  INTERVAL MONTH literal is supported

• DL_INTERVAL_DAY = 6

  INTERVAL DAY literal is supported

• DL_INTERVAL_HOUR = 7

  INTERVAL HOUR literal is supported

• DL_INTERVAL_MINUTE = 8

  INTERVAL MINUTE literal is supported

• DL_INTERVAL_SECOND = 9

  INTERVAL SECOND literal is supported

• DL_INTERVAL_YEAR_TO_MONTH = 10

  INTERVAL YEAR TO MONTH literal is supported

• DL_INTERVAL_DAY_TO_HOUR = 11

  INTERVAL DAY TO HOUR literal is supported

• DL_INTERVAL_DAY_TO_MINUTE = 12

  INTERVAL DAY TO MINUTE literal is supported

• DL_INTERVAL_DAY_TO_SECOND = 13

  INTERVAL DAY TO SECOND literal is supported

• DL_INTERVAL_HOUR_TO_MINUTE = 14

  INTERVAL HOUR TO MINUTE literal is supported

• DL_INTERVAL_HOUR_TO_SECOND = 15

  INTERVAL HOUR TO SECOND literal is supported

• DL_INTERVAL_MINUTE_TO_SECOND = 16

  INTERVAL MINUTE TO SECOND literal is supported

Request message for getting the metadata for catalogs satisfying the given optional filter.

• optional LikeFilter catalog_name_filter = 1

Response message for GetCatalogReq.

• optional RequestStatus status = 1

• repeated CatalogMetadata catalogs = 2

• optional shared.DrillPBError error = 3

Request message for getting the metadata for columns satisfying the given optional filters.

• optional LikeFilter catalog_name_filter = 1

• optional LikeFilter schema_name_filter = 2

• optional LikeFilter table_name_filter = 3

• optional LikeFilter column_name_filter = 4

Response message for GetColumnsReq.

• optional RequestStatus status = 1

• repeated ColumnMetadata columns = 2

• optional shared.DrillPBError error = 3

• required string query = 1

• optional shared.QueryType type = 2

• optional bool split_plan = 3

Request message for getting the metadata for schemas satisfying the given optional filters.

• optional LikeFilter catalog_name_filter = 1

• optional LikeFilter schema_name_filter = 2

Response message for GetSchemasReq.

• optional RequestStatus status = 1

• repeated SchemaMetadata schemas = 2

• optional shared.DrillPBError error = 3

Request message for getting server metadata

(message has no fields)

Response message for GetServerMetaReq

• optional RequestStatus status = 1

• optional ServerMeta server_meta = 2

• optional shared.DrillPBError error = 3

Request message for getting the metadata for tables satisfying the given optional filters.

• optional LikeFilter catalog_name_filter = 1

• optional LikeFilter schema_name_filter = 2

• optional LikeFilter table_name_filter = 3

• repeated string table_type_filter = 4

Response message for GetTablesReq.

• optional RequestStatus status = 1

• repeated TableMetadata tables = 2

• optional shared.DrillPBError error = 3

Used in: ServerMeta

• GB_NONE = 1

  Group by is not supported

• GB_SELECT_ONLY = 2

  Group by supported with non aggregated columns in select

• GB_BEYOND_SELECT = 3

  Group by supported with columns absent from the select list if all the non-aggregated colums from the select list are also added

• GB_UNRELATED = 4

  Group by supported with columns absent from the select list

Used in: BitToUserHandshake

• SUCCESS = 1

  Handshake is successful (including authentication if any)

• RPC_VERSION_MISMATCH = 2

  Client and Server RPC versions are different

• AUTH_FAILED = 3

  User authentication failed

• UNKNOWN_FAILURE = 4

  Unknown failure, refer to the error message for more details

• AUTH_REQUIRED = 5

  User authentication required

Used in: ServerMeta

• IC_UNKNOWN = 0

  Unknown support (for forward compatibility)

• IC_STORES_LOWER = 1

  Mixed case identifier is treated as case insensitive and stored in lower case

• IC_STORES_MIXED = 2

  Mixed case identifier is treated as case insensitive and stored in mixed case

• IC_STORES_UPPER = 3

  Mixed case identifier is treated as case insensitive and stored in upper case

• IC_SUPPORTS_MIXED = 4

  Mixed case identifier is treated as case sensitive and stored in mixed case

Simple filter which encapsulates the SQL LIKE ... ESCAPE function

Used in: GetCatalogsReq, GetColumnsReq, GetSchemasReq, GetTablesReq

• optional string pattern = 1

  pattern to match

• optional string escape = 2

  escape character (if any) present in the pattern

Used in: ServerMeta

• NC_UNKNOWN = 0

  Unknown support (for forward compatibility)

• NC_AT_START = 1

  NULL values are sorted at the start regardless of the order

• NC_AT_END = 2

  NULL values are sorted at the end regardless of the order

• NC_HIGH = 3

  NULL is the highest value

• NC_LOW = 4

  NULL is the lowest value

Used in: ServerMeta

• OB_UNKNOWN = 0

  Unknown support (for forward compatibility)

• OB_UNRELATED = 1

  ORDER BY supported with columns not in SELECT list

• OB_EXPRESSION = 2

  ORDER BY with expressions is supported

Used in: ServerMeta

• OJ_UNKNOWN = 0

  Unknown support (for forward compatibility)

• OJ_LEFT = 1

  Left outer join is supported

• OJ_RIGHT = 2

  Right outer join is supported

• OJ_FULL = 3

  Full outer join is supported

• OJ_NESTED = 4

  Nested outer join is supported

• OJ_NOT_ORDERED = 5

  Column names in the ON clause don't have to share the same order as their respective table names in the OUTER JOIN clase

• OJ_INNER = 6

  Inner table can also be used in an inner join

• OJ_ALL_COMPARISON_OPS = 7

  Any comparison operator is supported in the ON clause

Prepared statement. It contains the query metadata and handle to prepared statement state on server.

Used in: CreatePreparedStatementResp

• repeated ResultColumnMetadata columns = 1

• optional PreparedStatementHandle server_handle = 2

  In order to execute the prepared statement, clients need to submit this object in RunQuery message.

Server state of prepared statement. Contents are opaque to client. Client just need to submit this object in RunQuery to the prepared statement.

Used in: PreparedStatement, RunQuery

• optional bytes server_info = 1

Used in: UserProperties

• required string key = 1

• required string value = 2

• required shared.QueryResult.QueryState status = 1

• optional shared.QueryId query_id = 2

• repeated bit.control.PlanFragment fragments = 3

• optional shared.DrillPBError error = 4

Used in: RunQuery

• STREAM_FULL = 1

  Server will inform the client regularly on the status of the query. Once the query is completed, service will inform the client as each query chunk is made available.

• optional shared.QueryId query_id = 1

• optional int32 maximum_responses = 2

Enum indicating the request status.

Used in: CreatePreparedStatementResp, GetCatalogsResp, GetColumnsResp, GetSchemasResp, GetServerMetaResp, GetTablesResp

• UNKNOWN_STATUS = 0

• OK = 1

• FAILED = 2

• TIMEOUT = 3

  * Request timed out. Futher attempts can change any API specific parameters and retry or just retry the request.

Metadata of a column in query result set

Used in: PreparedStatement

• optional string catalog_name = 1

  Designated column's catalog name. Empty string if not applicable. Defaults to "DRILL" as drill has only one catalog.

• optional string schema_name = 2

  Designated column's schema name. Not set if not applicable. Initial implementation defaults to no value as we use LIMIT 0 queries to get the schema and schema info is lost. If we derive the schema from plan, we may get the right value.

• optional string table_name = 3

  Designated column's table name. Not set if not applicable. Initial implementation defaults to no value as we use LIMIT 0 queries to get the schema and table info is lost. If we derive the schema from query plan, we may get the right value.

• optional string column_name = 4

  column name

• optional string label = 5

  Column label name for display or print purposes. Ex. a column named "empName" might be labeled as "Employee Name".

• optional string data_type = 6

  Data type in string format. Value is SQL standard type.

• optional bool is_nullable = 7

• optional int32 precision = 8

  For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For all other types 0 is returned where the column size is not applicable.

• optional int32 scale = 9

  Column's number of digits to right of the decimal point. 0 is returned for types where the scale is not applicable

• optional bool signed = 10

  Indicates whether values in the designated column are signed numbers.

• optional int32 display_size = 11

  Maximum number of characters required to display data from the column.

• optional bool is_aliased = 12

  Is the column an aliased column. Initial implementation defaults to true as we derive schema from LIMIT 0 query and not the query plan.

• optional ColumnSearchability searchability = 13

• optional ColumnUpdatability updatability = 14

  Defaults to READ_ONLY

• optional bool auto_increment = 15

  whether the designated column is automatically incremented.

• optional bool case_sensitivity = 16

  Whether column's case matters for collations and comparisons. Defaults to true.

• optional bool sortable = 17

  whether the column can be used in ORDER BY clause

• optional string class_name = 18

  A fully-qualified name of the Java class whose instances are created if the method ResultSet.getObject is called to retrieve a value from the column. Applicable only to JDBC clients.

• optional bool is_currency = 20

  Is the data type a currency type? For JDBC only.

Used in: BitToUserHandshake, UserToBitHandshake

• optional string name = 1

  example: Apache Drill Server, Apache Drill C++ client

• optional string version = 2

  example: 1.9.0

• optional uint32 majorVersion = 3

  example: 1

• optional uint32 minorVersion = 4

  example: 9

• optional uint32 patchVersion = 5

  example: 0

• optional string application = 6

  example: Tableau 9.3

• optional uint32 buildNumber = 7

  example: 32

• optional string versionQualifier = 8

  example: SNAPSHOT

//// User <-> Bit RPC ///////

Used in: BitToUserHandshake

• HANDSHAKE = 0

• ACK = 1

• GOODBYE = 2

• RUN_QUERY = 3

  user to bit

  user is submitting a new query to the drillbit

• CANCEL_QUERY = 4

  user is sending a query cancellation request to the drillbit

• REQUEST_RESULTS = 5

• RESUME_PAUSED_QUERY = 11

  user is sending a query resume request to the drillbit

• GET_QUERY_PLAN_FRAGMENTS = 12

  to get plan fragments from query

• GET_CATALOGS = 14

  user is requesting metadata of catalog(s).

• GET_SCHEMAS = 15

  user is requesting metadata of schema(s)

• GET_TABLES = 16

  user is requesting metadata of table(s)

• GET_COLUMNS = 17

  user is requesting metadata of column(s)

• CREATE_PREPARED_STATEMENT = 22

  user is sending a request to create prepared statement

• GET_SERVER_META = 8

  user is sending a request to receive server metadata

• QUERY_DATA = 6

  bit to user

  drillbit is sending a query result data batch to the user

• QUERY_HANDLE = 7

• QUERY_PLAN_FRAGMENTS = 13

  return plan fragments

• CATALOGS = 18

  return catalogs metadata in response to GET_CATALOGS

• SCHEMAS = 19

  return schema metadata in response to GET_SCHEMAS

• TABLES = 20

  return table metadata in response to GET_TABLES

• COLUMNS = 21

  return column metadata in response to GET_COLUMNS

• PREPARED_STATEMENT = 23

  return preparated statement in response to CREATE_PREPARED_STATEMENT

• SERVER_META = 9

  return server infos in respose to GET_SERVER_META

• QUERY_RESULT = 10

  drillbit is reporting a query status change, most likely a terminal message, to the user

• SASL_MESSAGE = 24

  user to bit and bit to user

Request message for running a query.

• optional QueryResultsMode results_mode = 1

• optional shared.QueryType type = 2

• optional string plan = 3

  Input for query type LOGICAL, PHYSICAL or SQL.

• repeated bit.control.PlanFragment fragments = 4

  Input for query type EXECUTION. Input is a set of executable fragments.

• optional PreparedStatementHandle prepared_statement_handle = 5

  Input for query type PREPARED_STATEMENT. Input is a prepared statement handle to state on server side which is returned in response to CreatePreparedStatementReq.

• optional int32 autolimit_rowcount = 6

  Input for indicating the limit on a query's result set.

Used in: UserToBitHandshake

• UNKNOWN_SASL_SUPPORT = 0

• SASL_AUTH = 1

• SASL_PRIVACY = 2

Message encapsulating metadata for a Schema.

Used in: GetSchemasResp

• optional string catalog_name = 1

• optional string schema_name = 2

• optional string owner = 3

• optional string type = 4

  Type. Ex. "file", "mongodb", "hive" etc.

• optional string mutable = 5

Used in: GetServerMetaResp

• optional bool all_tables_selectable = 1

  True if current user can use all tables returned by GetTables

• optional bool blob_included_in_max_row_size = 2

  True if BLOB are included into the max row size

• optional bool catalog_at_start = 3

  True if catalog name is at the start of a fully qualified table

• optional string catalog_separator = 4

  The catalog separator

• optional string catalog_term = 5

  The term used to designate catalogs

• repeated CollateSupport collate_support = 6

  COLLATE support

• optional bool column_aliasing_supported = 7

  True if column aliasing is supported

• repeated ConvertSupport convert_support = 8

  CONVERT support

• optional CorrelationNamesSupport correlation_names_support = 9

  Correlation names support

• repeated string date_time_functions = 10

  Supported ODBC/JDBC Date Time scalar functions

• repeated DateTimeLiteralsSupport date_time_literals_support = 11

  Supported Date Time literals

• optional GroupBySupport group_by_support = 12

  Group By support

• optional IdentifierCasing identifier_casing = 13

  Unquoted Identifier casing

• optional string identifier_quote_string = 14

  Quote string for identifiers

• optional bool like_escape_clause_supported = 15

  True if LIKE supports an ESCAPE clause

• optional uint32 max_binary_literal_length = 16

  Maximum number of hexa characters for binary literals (0 if unlimited or unknown)

• optional uint32 max_catalog_name_length = 17

  Maximum length of catalog names (0 if unlimited or unknown)

• optional uint32 max_char_literal_length = 18

  Maximum number of characters for string literals (0 if unlimited or unknown)

• optional uint32 max_column_name_length = 19

  Maximum length of column names (0 if unlimited or unknown)

• optional uint32 max_columns_in_group_by = 20

  Maximum number of columns in GROUP BY expressions (0 if unlimited or unknown)

• optional uint32 max_columns_in_order_by = 21

  Maximum number of columns in ORDER BY expressions (0 if unlimited or unknown)

• optional uint32 max_columns_in_select = 22

  Maximum number of columns in SELECT expressions (0 if unlimited or unknown)

• optional uint32 max_cursor_name_length = 23

  Maximum length of cursor names (0 if unlimited or unknown)

• optional uint32 max_logical_lob_size = 24

  Maximum logical size for LOB types (0 if unlimited or unknown)

• optional uint32 max_row_size = 25

  Maximum number of bytes for a single row (0 if unlimited or unknown)

• optional uint32 max_schema_name_length = 26

  Maximum length of schema names (0 if unlimited or unknown)

• optional uint32 max_statement_length = 27

  Maximum length for statements (0 if unlimited or unknown)

• optional uint32 max_statements = 28

  Maximum number of statements (0 if unlimited or unknown)

• optional uint32 max_table_name_length = 29

  Maximum length of table names (0 if unlimited or unknown)

• optional uint32 max_tables_in_select = 30

  Maximum number of tables in a SELECT expression (0 if unlimited or unknown)

• optional uint32 max_user_name_length = 31

  Maximum length of user names (0 if unlimited or unknown)

• optional NullCollation null_collation = 32

  How NULL are sorted

• optional bool null_plus_non_null_equals_null = 33

  True if NULL + non NULL is NULL

• repeated string numeric_functions = 34

  Supported ODBC/JDBC numeric scalar functions

• repeated OrderBySupport order_by_support = 35

  Outer join suport

• repeated OuterJoinSupport outer_join_support = 36

  Outer join suport

• optional IdentifierCasing quoted_identifier_casing = 37

  Quoted identifier casing

• optional bool read_only = 38

  True if connection access is read only

• optional string schema_term = 39

  The term used to designate a schema

• optional string search_escape_string = 40

  Characters used for escaping (empty if not suported)

• optional bool select_for_update_supported = 41

  True if SELECT FOR UPDATE is supported

• optional string special_characters = 42

  List of extra characters that can be used in identifier names

• repeated string sql_keywords = 43

  list of SQL keywords

• repeated string string_functions = 44

  Supported ODBC/JDBC string scalar functions

• repeated SubQuerySupport subquery_support = 45

  Subquery support

• repeated string system_functions = 46

  Supported ODBC/JDBC systen scalar functions

• optional string table_term = 47

  The term used to designate a table

• optional bool transaction_supported = 48

  True if transaction is supported

• repeated UnionSupport union_support = 49

  UNION support

• optional string current_schema = 50

  current schema

Used in: ServerMeta

• SQ_UNKNOWN = 0

  Unknown support (for forward compatibility)

• SQ_CORRELATED = 1

  Correlated subquery is supported

• SQ_IN_COMPARISON = 2

  Subquery in comparison expression is supported

• SQ_IN_EXISTS = 3

  Subquery in EXISTS expression is supported

• SQ_IN_INSERT = 4

  Subquery in INSERT expression is supported

• SQ_IN_QUANTIFIED = 5

  Subquery in quantified expression is supported

Message encapsulating metadata for a Table.

Used in: GetTablesResp

• optional string catalog_name = 1

• optional string schema_name = 2

• optional string table_name = 3

• optional string type = 4

  Type. Ex. "TABLE", "VIEW" etc.

Used in: ServerMeta

• U_UNKNOWN = 0

  Unknown support (for forward compatibility)

• U_UNION = 1

  UNION is supported

• U_UNION_ALL = 2

  UNION_ALL is supported

Used in: UserToBitHandshake

• repeated Property properties = 1

• optional shared.RpcChannel channel = 1

• optional bool support_listening = 2

• optional int32 rpc_version = 3

• optional shared.UserCredentials credentials = 4

• optional UserProperties properties = 5

• optional bool support_complex_types = 6

• optional bool support_timeout = 7

• optional RpcEndpointInfos client_infos = 8

• optional SaslSupport sasl_support = 9