Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Metadata for a parameter

Used in: Signature

• bool signed = 1

• uint32 precision = 2

• uint32 scale = 3

• uint32 parameter_type = 4

• string type_name = 5

• string class_name = 6

• string name = 7

Base class for a column type

Used in: ColumnMetaData

• uint32 id = 1

• string name = 2

• Rep rep = 3

• repeated ColumnMetaData columns = 4

  Only present when name = STRUCT

• optional AvaticaType component = 5

  Only present when name = ARRAY

Request for Meta#getCatalogs()

• string connection_id = 1

Request for Meta#closeConnection(Meta.ConnectionHandle)

• string connection_id = 1

Response to CloseConnectionRequest {

• optional RpcMetadata metadata = 1

Request for Meta#closeStatement(Meta.StatementHandle)

• string connection_id = 1

• uint32 statement_id = 2

Response to CloseStatementRequest

• optional RpcMetadata metadata = 1

Used in: AvaticaType, Signature

• uint32 ordinal = 1

• bool auto_increment = 2

• bool case_sensitive = 3

• bool searchable = 4

• bool currency = 5

• uint32 nullable = 6

• bool signed = 7

• uint32 display_size = 8

• string label = 9

• string column_name = 10

• string schema_name = 11

• uint32 precision = 12

• uint32 scale = 13

• string table_name = 14

• string catalog_name = 15

• bool read_only = 16

• bool writable = 17

• bool definitely_writable = 18

• string column_class_name = 19

• optional AvaticaType type = 20

A value might be a TypedValue or an Array of TypedValue's

Used in: Row

• repeated TypedValue value = 1

  deprecated, use array_value or scalar_value

• repeated TypedValue array_value = 2

• bool has_array_value = 3

  Is an array value set?

• optional TypedValue scalar_value = 4

Request for Meta#getColumns(String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat).

• string catalog = 1

• string schema_pattern = 2

• string table_name_pattern = 3

• string column_name_pattern = 4

• string connection_id = 5

• bool has_catalog = 6

• bool has_schema_pattern = 7

• bool has_table_name_pattern = 8

• bool has_column_name_pattern = 9

Request to invoke a commit on a Connection

• string connection_id = 1

Response to a commit request

(message has no fields)

Details about a connection

Used in: ConnectionSyncRequest, ConnectionSyncResponse

• bool is_dirty = 1

• bool auto_commit = 2

• bool has_auto_commit = 7

  field is a Boolean, need to discern null and default value

• bool read_only = 3

• bool has_read_only = 8

  field is a Boolean, need to discern null and default value

• uint32 transaction_isolation = 4

• string catalog = 5

• string schema = 6

• string connection_id = 1

• optional ConnectionProperties conn_props = 2

Response to ConnectionSyncRequest

• optional ConnectionProperties conn_props = 1

• optional RpcMetadata metadata = 2

Request for Meta#createStatement(Meta.ConnectionHandle)

• string connection_id = 1

Response to CreateStatementRequest

• string connection_id = 1

• uint32 statement_id = 2

• optional RpcMetadata metadata = 3

Information necessary to convert an Iterable into a Calcite Cursor

Used in: Signature

• CursorFactory.Style style = 1

• string class_name = 2

• repeated string field_names = 3

Used in: CursorFactory

• OBJECT = 0

• RECORD = 1

• RECORD_PROJECTION = 2

• ARRAY = 3

• LIST = 4

• MAP = 5

Database property, list of functions the database provides for a certain operation

Used in: DatabasePropertyElement

• string name = 1

• repeated string functions = 2

Used in: DatabasePropertyResponse

• optional DatabaseProperty key = 1

• optional TypedValue value = 2

• optional RpcMetadata metadata = 3

Request for Meta#getDatabaseProperties()

• string connection_id = 1

Response for Meta#getDatabaseProperties()

• repeated DatabasePropertyElement props = 1

• optional RpcMetadata metadata = 2

Send contextual information about some error over the wire from the server.

• repeated string exceptions = 1

  exception stacktraces, many for linked exceptions.

• bool has_exceptions = 7

  are there stacktraces contained?

• string error_message = 2

  human readable description

• Severity severity = 3

• uint32 error_code = 4

  numeric identifier for error

• string sql_state = 5

  five-character standard-defined value

• optional RpcMetadata metadata = 6

• string connection_id = 1

• uint32 statement_id = 2

• repeated UpdateBatch updates = 3

  A batch of updates is a list<list<typevalue>>

Response to a batch update request

• string connection_id = 1

• uint32 statement_id = 2

• repeated uint64 update_counts = 3

• bool missing_statement = 4

  Did the request fail because of no-cached statement

• optional RpcMetadata metadata = 5

Request for Meta#execute(Meta.ConnectionHandle, list, long)

• optional StatementHandle statementHandle = 1

• repeated TypedValue parameter_values = 2

• uint64 deprecated_first_frame_max_size = 3

  Deprecated, use the signed int instead.

• bool has_parameter_values = 4

• int32 first_frame_max_size = 5

  The maximum number of rows to return in the first Frame

Response to PrepareAndExecuteRequest

• repeated ResultSetResponse results = 1

• bool missing_statement = 2

  Did the request fail because of no-cached statement

• optional RpcMetadata metadata = 3

Request for Meta#fetch(Meta.StatementHandle, List, long, int)

• string connection_id = 1

• uint32 statement_id = 2

• uint64 offset = 3

• uint32 fetch_max_row_count = 4

  Maximum number of rows to be returned in the frame. Negative means no limit. Deprecated!

• int32 frame_max_size = 5

Response to FetchRequest

• optional Frame frame = 1

• bool missing_statement = 2

  Did the request fail because of no-cached statement

• bool missing_results = 3

  Did the request fail because of a cached-statement w/o ResultSet

• optional RpcMetadata metadata = 4

A collection of rows

Used in: FetchResponse, ResultSetResponse

• uint64 offset = 1

• bool done = 2

• repeated Row rows = 3

Enumeration corresponding to DatabaseMetaData operations

Used in: QueryState

• GET_ATTRIBUTES = 0

• GET_BEST_ROW_IDENTIFIER = 1

• GET_CATALOGS = 2

• GET_CLIENT_INFO_PROPERTIES = 3

• GET_COLUMN_PRIVILEGES = 4

• GET_COLUMNS = 5

• GET_CROSS_REFERENCE = 6

• GET_EXPORTED_KEYS = 7

• GET_FUNCTION_COLUMNS = 8

• GET_FUNCTIONS = 9

• GET_IMPORTED_KEYS = 10

• GET_INDEX_INFO = 11

• GET_PRIMARY_KEYS = 12

• GET_PROCEDURE_COLUMNS = 13

• GET_PROCEDURES = 14

• GET_PSEUDO_COLUMNS = 15

• GET_SCHEMAS = 16

• GET_SCHEMAS_WITH_ARGS = 17

• GET_SUPER_TABLES = 18

• GET_SUPER_TYPES = 19

• GET_TABLE_PRIVILEGES = 20

• GET_TABLES = 21

• GET_TABLE_TYPES = 22

• GET_TYPE_INFO = 23

• GET_UDTS = 24

• GET_VERSION_COLUMNS = 25

Represents the breadth of arguments to DatabaseMetaData functions

Used in: QueryState

• string string_value = 1

• bool bool_value = 2

• sint32 int_value = 3

• repeated string string_array_values = 4

• repeated sint32 int_array_values = 5

• MetaDataOperationArgument.ArgumentType type = 6

Used in: MetaDataOperationArgument

• STRING = 0

• BOOL = 1

• INT = 2

• REPEATED_STRING = 3

• REPEATED_INT = 4

• NULL = 5

Request for Meta#openConnection(Meta.ConnectionHandle, Map<String, String>)

• string connection_id = 1

• map<string, string> info = 2

Response to OpenConnectionRequest {

• optional RpcMetadata metadata = 1

Request to prepare and execute a collection of sql statements.

• string connection_id = 1

• uint32 statement_id = 2

• repeated string sql_commands = 3

Request for Meta#prepareAndExecute(Meta.StatementHandle, String, long, Meta.PrepareCallback)

• string connection_id = 1

• string sql = 2

• uint64 max_row_count = 3

  Deprecated

• uint32 statement_id = 4

• int64 max_rows_total = 5

  The maximum number of rows that will be allowed for this query

• int32 first_frame_max_size = 6

  The maximum number of rows that will be returned in the

Request for Meta.prepare(Meta.ConnectionHandle, String, long)

• string connection_id = 1

• string sql = 2

• uint64 max_row_count = 3

  Deprecated

• int64 max_rows_total = 4

  The maximum number of rows that will be allowed for this query

Response to PrepareRequest

• optional StatementHandle statement = 1

• optional RpcMetadata metadata = 2

Used in: SyncResultsRequest

• StateType type = 1

• string sql = 2

• MetaDataOperation op = 3

• repeated MetaDataOperationArgument args = 4

• bool has_args = 5

• bool has_sql = 6

• bool has_op = 7

Used in: AvaticaType, TypedValue

• PRIMITIVE_BOOLEAN = 0

• PRIMITIVE_BYTE = 1

• PRIMITIVE_CHAR = 2

• PRIMITIVE_SHORT = 3

• PRIMITIVE_INT = 4

• PRIMITIVE_LONG = 5

• PRIMITIVE_FLOAT = 6

• PRIMITIVE_DOUBLE = 7

• BOOLEAN = 8

• BYTE = 9

• CHARACTER = 10

• SHORT = 11

• INTEGER = 12

• LONG = 13

• FLOAT = 14

• DOUBLE = 15

• BIG_INTEGER = 25

• BIG_DECIMAL = 26

• JAVA_SQL_TIME = 16

• JAVA_SQL_TIMESTAMP = 17

• JAVA_SQL_DATE = 18

• JAVA_UTIL_DATE = 19

• BYTE_STRING = 20

• STRING = 21

• NUMBER = 22

• OBJECT = 23

• NULL = 24

• ARRAY = 27

• STRUCT = 28

• MULTISET = 29

Response that contains a result set.

Used in: ExecuteResponse

• string connection_id = 1

• uint32 statement_id = 2

• bool own_statement = 3

• optional Signature signature = 4

• optional Frame first_frame = 5

• uint64 update_count = 6

  -1 for normal result sets, else this response contains a dummy result set

• optional RpcMetadata metadata = 7

  with no signature nor other data.

Request to invoke rollback on a Connection

• string connection_id = 1

Response to a rollback request

(message has no fields)

A row is a collection of values

Used in: Frame

• repeated ColumnValue value = 1

Generic metadata for the server to return with each response.

Used in: CloseConnectionResponse, CloseStatementResponse, ConnectionSyncResponse, CreateStatementResponse, DatabasePropertyElement, DatabasePropertyResponse, ErrorResponse, ExecuteBatchResponse, ExecuteResponse, FetchResponse, OpenConnectionResponse, PrepareResponse, ResultSetResponse, SyncResultsResponse

• string server_address = 1

  The host:port of the server

Request for Meta#getSchemas(String, org.apache.calcite.avatica.Meta.Pat)}

• string catalog = 1

• string schema_pattern = 2

• string connection_id = 3

• bool has_catalog = 4

• bool has_schema_pattern = 5

The severity of some unexpected outcome to an operation. Protobuf enum values must be unique across all other enums

Used in: ErrorResponse

• UNKNOWN_SEVERITY = 0

• FATAL_SEVERITY = 1

• ERROR_SEVERITY = 2

• WARNING_SEVERITY = 3

Results of preparing a statement

Used in: ResultSetResponse, StatementHandle

• repeated ColumnMetaData columns = 1

• string sql = 2

• repeated AvaticaParameter parameters = 3

• optional CursorFactory cursor_factory = 4

• StatementType statementType = 5

Used in: QueryState

• SQL = 0

• METADATA = 1

Statement handle

Used in: ExecuteRequest, PrepareResponse

• string connection_id = 1

• uint32 id = 2

• optional Signature signature = 3

Has to be consistent with Meta.StatementType

Used in: Signature

• SELECT = 0

• INSERT = 1

• UPDATE = 2

• DELETE = 3

• UPSERT = 4

• MERGE = 5

• OTHER_DML = 6

• CREATE = 7

• DROP = 8

• ALTER = 9

• OTHER_DDL = 10

• CALL = 11

• string connection_id = 1

• uint32 statement_id = 2

• optional QueryState state = 3

• uint64 offset = 4

• bool missing_statement = 1

  Server doesn't have the statement with the ID from the request

• bool more_results = 2

  Should the client fetch() to get more results

• optional RpcMetadata metadata = 3

Request for Meta#getTableTypes()

• string connection_id = 1

Request for Request for Meta#getTables(String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, java.util.List)

• string catalog = 1

• string schema_pattern = 2

• string table_name_pattern = 3

• repeated string type_list = 4

• bool has_type_list = 6

  Having an empty type_list is distinct from a null type_list

• string connection_id = 7

• bool has_catalog = 8

• bool has_schema_pattern = 9

• bool has_table_name_pattern = 10

Request for Meta#getTypeInfo()

• string connection_id = 1

Generic wrapper to support any SQL type. Struct-like to work around no polymorphism construct.

Used in: ColumnValue, DatabasePropertyElement, ExecuteRequest, UpdateBatch

• Rep type = 1

  The actual type that was serialized in the general attribute below

• bool bool_value = 2

  boolean

• string string_value = 3

  char/varchar

• sint64 number_value = 4

  var-len encoding lets us shove anything from byte to long

• bytes bytes_value = 5

  includes numeric types and date/time types.

  binary/varbinary

• double double_value = 6

  big numbers

• bool null = 7

  a null object

• repeated TypedValue array_value = 8

  The Array

• Rep component_type = 9

  If an Array, the representation for the array values

• bool implicitly_null = 10

  Differentiate between explicitly null (user-set) and implicitly null

Each command is a list of TypedValues

Used in: ExecuteBatchRequest

• repeated TypedValue parameter_values = 1

Message which encapsulates another message to support a single RPC endpoint

• string name = 1

• bytes wrapped_message = 2