package quickstep.serialization

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AggregationOperationState

• required AggregateFunction function = 1

• repeated Scalar argument = 2

• required bool is_distinct = 3

Used in: Aggregate

• required AggregateFunction.AggregationID aggregation_id = 1

Used in: AggregateFunction

• AVG = 0

• COUNT = 1

• MAX = 2

• MIN = 3

• SUM = 4

Used in: QueryContext.AggregationOperationStateContext

• required int32 relation_id = 1

• repeated Aggregate aggregates = 2

• repeated Scalar group_by_expressions = 3

• optional Predicate predicate = 4

• required uint64 estimated_num_entries = 5

• optional HashTableImplType hash_table_impl_type = 6

  NOTE(chasseur): 'hash_table_impl_type' is marked optional, but it is needed if 'group_by_expressions' is non-empty, and ignored otherwise.

• repeated HashTableImplType distinctify_hash_table_impl_types = 7

  Each DISTINCT aggregation has its distinctify hash table impl type.

• optional bool is_partitioned = 8

• optional uint64 num_partitions = 9

• optional CollisionFreeVectorInfo collision_free_vector_info = 10

  Required if 'hash_table_impl_type' is 'COLLISION_FREE_VECTOR'.

Next tag: 21.

(message has no fields)

• required BinaryOperation.BinaryOperationID operation_id = 1

Used in: BinaryOperation

• ADD = 0

• SUBTRACT = 1

• MULTIPLY = 2

• DIVIDE = 3

• MODULO = 4

(message has no fields)

Used for RegistrationResponse, Unregistration, and FailureReport.

• required uint32 block_domain = 1

BlockLocator related messages.

• required string domain_network_address = 1

  Format IP:Port, i.e., "0.0.0.0:0".

Used for the block locality based scheduling in ForemanDistributed.

• required uint32 block_domain = 1

• required uint64 shiftboss_index = 2

Used when StorageManager loads or evicts a block or a blob from its buffer pool.

• required fixed64 block_id = 1

• required uint32 block_domain = 2

• required fixed64 block_id = 1

(message has no fields)

• optional fixed64 bloom_filter_seed = 1

  The default values were determined from empirical experiments. These values control the amount of false positivity that is expected from Bloom Filter. - Default seed for initializing family of hashes = 0xA5A5A5A55A5A5A5A. - Default bloom filter size = 10 KB. - Default number of hash functions used in bloom filter = 5.

• optional uint32 bloom_filter_size = 2

• optional uint32 number_of_hashes = 3

(message has no fields)

Next tag: 41.

(message has no fields)

Next tag: 54.

(message has no fields)

(message has no fields)

• repeated CatalogDatabase databases = 1

Used in: CatalogRelationSchema

• required string name = 1

• required Type type = 2

• optional string display_name = 3

Used in: Catalog, QueryInitiateMessage, ShiftbossRegistrationResponseMessage

• required string name = 1

• repeated CatalogRelationSchema relations = 2

• repeated int32 null_relations = 3

(message has no fields)

• required int32 relation_id = 1

• required fixed64 block_id = 2

• optional uint64 partition_id = 3

  Used by PartitionAwareInsertDestination.

• required uint64 query_id = 4

Used in: CatalogDatabase, QueryExecutionSuccessMessage

• required int32 relation_id = 1

• required string name = 2

• required bool temporary = 3

• repeated CatalogAttribute attributes = 4

• optional bool is_exact = 1

• optional TypedValue num_tuples = 2

• repeated CatalogRelationStatistics.ColumnStats column_stats = 3

Used in: CatalogRelationStatistics

• required int32 attr_id = 1

• optional TypedValue num_distinct_values = 2

• optional TypedValue min_value = 3

• optional TypedValue max_value = 4

(message has no fields)

Used in: AggregationOperationState

• required uint64 memory_size = 1

• required uint64 num_init_partitions = 2

• repeated uint64 state_offsets = 3

• required string command_response = 1

• required Comparison.ComparisonID comparison_id = 1

Used in: Comparison

• EQUAL = 0

• NOT_EQUAL = 1

• LESS = 2

• LESS_OR_EQUAL = 3

• GREATER = 4

• GREATER_OR_EQUAL = 5

• LIKE = 6

• NOT_LIKE = 7

• REGEX_MATCH = 8

• NOT_REGEX_MATCH = 9

(message has no fields)

• required uint64 operator_index = 1

• required fixed64 block_id = 2

• required int32 relation_id = 3

• required uint64 query_id = 4

• optional uint64 partition_id = 5

  Used by PartitionAwareInsertDestination.

(message has no fields)

• YEAR = 0

• MONTH = 1

• DAY = 2

• HOUR = 3

• MINUTE = 4

• SECOND = 5

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

Next tag: 148.

(message has no fields)

Used in: QueryContext

• required string function_name = 1

• repeated TypedValue args = 2

• repeated GetAllDomainNetworkAddressesResponseMessage.DomainNetworkAddress domain_network_addresses = 1

Used in: GetAllDomainNetworkAddressesResponseMessage

• required uint32 block_domain = 1

• required string network_address = 2

Next tag: 174.

(message has no fields)

• HASH_ANTI_JOIN = 0

• HASH_INNER_JOIN = 1

• HASH_OUTER_JOIN = 2

• HASH_SEMI_JOIN = 3

NOTE(chasseur): This proto describes the run-time parameters for a resizable HashTable. It does not describe any template parameters of the HashTable class, which are different in different contexts (e.g. join vs. grouping).

Used in: QueryContext.HashTableContext

• required HashTableImplType hash_table_impl_type = 1

• repeated Type key_types = 2

• required uint64 estimated_num_entries = 3

Used in: AggregationOperationState, HashTable

• COLLISION_FREE_VECTOR = 0

• LINEAR_OPEN_ADDRESSING = 1

• SEPARATE_CHAINING = 2

• SIMPLE_SCALAR_SEPARATE_CHAINING = 3

• THREAD_PRIVATE_COMPACT_KEY = 4

• repeated IndexScheme.IndexEntry index_entries = 1

Used in: IndexScheme

• required string index_name = 1

• required IndexSubBlockDescription index_description = 2

(message has no fields)

• required uint64 query_id = 1

• required uint64 operator_index = 2

• required uint64 insert_destination_index = 3

• required int32 relation_id = 4

• required uint64 query_id = 1

• required uint64 operator_index = 2

• required uint64 num_rebuild_work_orders = 3

• required uint64 shiftboss_index = 4

Used in: QueryContext

• required InsertDestinationType insert_destination_type = 1

• required int32 relation_id = 2

• optional StorageBlockLayoutDescription layout = 3

  Note(zuyu): the actual StorageBlockLayout for insertion, if set.

• required uint64 relational_op_index = 4

Used in: InsertDestination

• ALWAYS_CREATE_BLOCK = 0

• BLOCK_POOL = 1

• PARTITION_AWARE = 2

(message has no fields)

Used in: QueryContext

• required LIPFilterType lip_filter_type = 1

Used in: QueryContext

• repeated LIPFilterDeployment.Entry build_entries = 1

• repeated LIPFilterDeployment.Entry probe_entries = 2

Used in: LIPFilterDeployment

• required uint32 lip_filter_id = 1

• required int32 attribute_id = 2

• required Type attribute_type = 3

Used in: LIPFilter

• BIT_VECTOR_EXACT_FILTER = 1

• BLOOM_FILTER = 2

• SINGLE_IDENTITY_HASH_FILTER = 3

• required uint32 num_numa_nodes = 1

• repeated NUMAPlacementScheme.BlockToNUMANodeEntry block_to_numa_node_map = 2

Used in: NUMAPlacementScheme

• required fixed64 block_id = 1

• required int32 numa_node = 2

(message has no fields)

Next tag: 201.

(message has no fields)

Used in: PartitionScheme

• repeated fixed64 blocks = 1

(message has no fields)

• required PartitionSchemeHeader header = 1

• repeated Partition partitions = 2

TODO(zuyu): Move PartitionScheme to a dedicate proto file.

Used in: PartitionScheme

• required PartitionSchemeHeader.PartitionType partition_type = 1

• required uint64 num_partitions = 2

• repeated uint32 partition_attribute_ids = 3

Next tag: 3.

Used in: PartitionSchemeHeader

• HASH = 0

• RANDOM = 2

• RANGE = 1

• repeated TypedValue partition_values = 1

Used in: AggregationOperationState, QueryContext

• required Predicate.PredicateType predicate_type = 1

Used in: Predicate

• TRUE = 0

• FALSE = 1

• COMPARISON = 2

• NEGATION = 3

• CONJUNCTION = 4

• DISJUNCTION = 5

Either ConjunctionPredicate or DisjunctionPredicate.

(message has no fields)

Used in: QueryInitiateMessage

• repeated QueryContext.AggregationOperationStateContext aggregation_states = 1

• repeated GeneratorFunctionHandle generator_functions = 2

• repeated QueryContext.HashTableContext join_hash_tables = 3

• repeated InsertDestination insert_destinations = 4

• repeated LIPFilter lip_filters = 5

• repeated LIPFilterDeployment lip_filter_deployments = 6

• repeated Predicate predicates = 7

• repeated QueryContext.ScalarGroup scalar_groups = 8

• repeated SortConfiguration sort_configs = 9

• repeated Tuple tuples = 10

• repeated QueryContext.UpdateGroup update_groups = 11

  NOTE(zuyu): For UpdateWorkOrder only.

• repeated WindowAggregationOperationState window_aggregation_states = 12

• required uint64 query_id = 13

• repeated uint64 num_partitions_for_nested_loops_joins = 14

• optional uint64 num_partitions_for_lips = 15

Used in: QueryContext

• required AggregationOperationState aggregation_state = 1

• optional uint64 num_partitions = 2

Used in: QueryContext

• required HashTable join_hash_table = 1

• optional uint64 num_partitions = 2

Used in: QueryContext

• repeated Scalar scalars = 1

Used in: QueryContext

• required int32 relation_id = 1

  NOTE(zuyu): Only used for validating UpdateAssignment's attribute_id.

• repeated UpdateGroup.UpdateAssignment update_assignments = 2

Used in: UpdateGroup

• required int32 attribute_id = 1

• required Scalar scalar = 2

• required string error_message = 1

• optional CatalogRelationSchema result_relation = 1

• required uint64 query_id = 1

• required CatalogDatabase catalog_database_cache = 2

• required QueryContext query_context = 3

• required uint64 query_id = 1

• required int32 relation_id = 1

• required uint64 query_id = 1

(message has no fields)

• repeated fixed64 blocks = 1

(message has no fields)

(message has no fields)

Used in: Aggregate, AggregationOperationState, QueryContext.ScalarGroup, QueryContext.UpdateGroup.UpdateAssignment, SortConfiguration.OrderBy, WindowAggregationOperationState

• required Scalar.ScalarDataSource data_source = 1

Used in: Scalar

• LITERAL = 0

• ATTRIBUTE = 1

• UNARY_EXPRESSION = 2

• BINARY_EXPRESSION = 3

• CASE_EXPRESSION = 4

• SHARED_EXPRESSION = 5

(message has no fields)

• NONE = 0

• LEFT_SIDE = 1

• RIGHT_SIDE = 2

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)

Next tag: 250.

(message has no fields)

Distributed version related messages.

• required uint64 work_order_capacity = 1

  The total Work Order processing capacity in Shiftboss, which equals to the sum of the capacity of each worker managed by Shiftboss.

• required uint64 shiftboss_index = 1

• required CatalogDatabase catalog_database = 2

(message has no fields)

Used in: QueryContext

• repeated SortConfiguration.OrderBy order_by_list = 1

Used in: SortConfiguration

• required Scalar expression = 1

• required bool is_ascending = 2

• required bool null_first = 3

• required uint64 merge_level = 1

• repeated fixed64 blocks = 2

(message has no fields)

(message has no fields)

• required string sql_query = 1

(message has no fields)

(message has no fields)

(message has no fields)

Used in: QueryContext

• repeated TypedValue attribute_values = 1

Used in: CatalogAttribute, HashTable, LIPFilterDeployment.Entry

• required Type.TypeID type_id = 1

• required bool nullable = 2

Used in: Type, TypedValue

• INT = 0

• LONG = 1

• FLOAT = 2

• DOUBLE = 3

• CHAR = 4

• VAR_CHAR = 5

• DATETIME = 6

• DATETIME_INTERVAL = 7

• YEAR_MONTH_INTERVAL = 8

• NULL_TYPE = 9

• DATE = 10

Used in: CatalogRelationStatistics, CatalogRelationStatistics.ColumnStats, GeneratorFunctionHandle, PartitionValues, Tuple

• required Type.TypeID type_id = 1

• optional int32 int_value = 2

  NOTE(zuyu): For a NULL value, none of the optional fields are filled in.

• optional int64 long_value = 3

• optional float float_value = 4

• optional double double_value = 5

• optional bytes out_of_line_data = 6

• optional int64 datetime_value = 7

• optional int64 datetime_interval_value = 8

• optional int64 year_month_interval_value = 9

• optional TypedValue.DateLit date_value = 10

Used in: TypedValue

• required int32 year = 1

• required uint32 month = 2

• required uint32 day = 3

• required UnaryOperation.UnaryOperationID operation_id = 1

Used in: UnaryOperation

• NEGATE = 0

• CAST = 1

• DATE_EXTRACT = 2

• SUBSTRING = 3

(message has no fields)

(message has no fields)

(message has no fields)

Used in: WindowAggregationOperationState

• required WindowAggregateFunction.WindowAggregationID window_aggregation_id = 1

Used in: WindowAggregateFunction

• AVG = 0

• COUNT = 1

• MAX = 2

• MIN = 3

• SUM = 4

Used in: QueryContext

• required int32 input_relation_id = 1

• required WindowAggregateFunction function = 2

• repeated Scalar arguments = 3

• repeated Scalar partition_by_attributes = 4

• required bool is_row = 5

• required int64 num_preceding = 6

  -1 means UNBOUNDED PRECEDING.

• required int64 num_following = 7

  -1 means UNBOUNDED FOLLOWING.

• repeated Scalar order_by_attributes = 8

(message has no fields)

Used in: WorkOrderMessage

• required WorkOrderType work_order_type = 1

• required uint64 query_id = 2

Next tag: 9.

• required WorkOrderCompletionMessage.WorkOrderType work_order_type = 1

• required uint64 operator_index = 2

• required uint64 worker_thread_index = 3

• required uint64 query_id = 4

• required uint64 partition_id = 8

• optional uint64 execution_start_time = 5

  Epoch time in microseconds.

• optional uint64 execution_end_time = 6

• optional uint64 shiftboss_index = 7

  Required in the distributed version.

Used in: WorkOrderCompletionMessage

• NORMAL = 0

• REBUILD = 1

• required uint64 query_id = 1

• required uint64 operator_index = 2

• required WorkOrder work_order = 3

Next tag: 27.

Used in: WorkOrder

• AGGREGATION = 1

• BUILD_AGGREGATION_EXISTENCE_MAP = 23

• BUILD_HASH = 2

• BUILD_LIP_FILTER = 3

• CREATE_INDEX = 4

  Placeholder.

• CREATE_TABLE = 5

  Placeholder.

• DELETE = 6

• DESTROY_AGGREGATION_STATE = 22

• DESTROY_HASH = 7

• DROP_TABLE = 8

• FINALIZE_AGGREGATION = 9

• HASH_JOIN = 10

• INITIALIZE_AGGREGATION = 25

• INSERT = 11

• NESTED_LOOP_JOIN = 12

• SAMPLE = 13

• SAVE_BLOCKS = 14

• SELECT = 15

• SORT_MERGE_RUN = 16

• SORT_RUN_GENERATION = 17

• TABLE_EXPORT_TO_STRING = 26

• TABLE_GENERATOR = 18

• TEXT_SCAN = 19

• UNION_ALL = 24

• UPDATE = 20

• WINDOW_AGGREGATION = 21