package mz_repr.row

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ProtoDatum

• optional ProtoRow elements = 1

  All array elements flattened into 1 dimension, encoded in row-major order.

• repeated ProtoArrayDimension dims = 2

  A list of metadata for each dimension in the array. Each dimension has a lower bound (the index at which the dimension begins) and the length of the dimension (the number of elements in that dimension). For a 3x4 matrix, for example, you'd have two entries in the dims array, the first with length 3 and the second with length 4. ATM the lower bound for each dimension is always 1, but Postgres technically lets you choose any lower bound you like for each dimension.

Used in: ProtoArray

• int64 lower_bound = 1

• uint64 length = 2

Used in: ProtoDictElement, ProtoRangeInner, ProtoRow

• oneof datum_type

  NB: Proto oneof ids `1..=15` get encoded in 1 byte and so we should reserve them for the datum types we expect to be most popular. Null, False, and True are all likely to be frequent, but the encoded length is exactly the same if they're here or in ProtoDatumOther. In general, anything that can be encoded purely as a proto enum variant (i.e. doesn't have a payload) is better off that way. If we run out of 1-byte encodings of ProtoDatumOther, we can always add ProtoDatumOther2.

  • ProtoDatumOther other = 1

  • int32 int16 = 2

  • int32 int32 = 3

  • int64 int64 = 4

  • float float32 = 5

  • double float64 = 6

  • bytes bytes = 7

  • string string = 8

    Don't use 9-15 without truly understanding the NB above.

  • adt.date.ProtoDate date = 16

    These get encoded with 2 bytes for the oneof id. It's a pretty easy and low-debt migration to "bless" one of these into having a 1-byte id (fill in the new field on write, but check if either field is set on read). However, once a 1-byte id is used, it's gone forever, so we're conservative in handing them out. Of these, I'd guess Timestamp and UUID are probably the first ones we'd bless followed by Date and Time.

  • mz_proto.chrono.ProtoNaiveTime time = 17

  • mz_proto.chrono.ProtoNaiveDateTime timestamp = 18

  • mz_proto.chrono.ProtoNaiveDateTime timestamp_tz = 19

  • adt.interval.ProtoInterval interval = 20

  • ProtoArray array = 21

  • ProtoRow list = 22

  • ProtoDict dict = 23

  • ProtoNumeric numeric = 24

  • bytes uuid = 25

  • uint32 uint32 = 26

  • uint32 uint8 = 27

  • uint32 uint16 = 28

  • uint64 uint64 = 29

  • uint64 mz_timestamp = 30

  • ProtoRange range = 31

  • adt.mz_acl_item.ProtoMzAclItem mz_acl_item = 32

  • adt.mz_acl_item.ProtoAclItem acl_item = 33

Used in: ProtoDatum

• UNKNOWN = 0

  It's generally good practice to make id 0 (the default if the field is unset) in proto enums be an Unknown sentinel. This allows for distinguishing between unset and any of the enum variants. This enum is initially used only in a oneof, which means we can distinguish unset without this sentinel. But stick one in here anyway, in case this enum gets used somewhere else in the future.

• NULL = 1

• FALSE = 2

• TRUE = 3

• JSON_NULL = 4

• DUMMY = 5

• NUMERIC_POS_INF = 6

• NUMERIC_NEG_INF = 7

• NUMERIC_NA_N = 8

Used in: ProtoDatum

• repeated ProtoDictElement elements = 1

Used in: ProtoDict

• string key = 1

• optional ProtoDatum val = 2

See [dec::to_packed_bcd] and http://speleotrove.com/decimal/dnpack.html for more information on this format. NB: Special values like NaN, PosInf, and NegInf are represented as variants of ProtoDatumOther.

Used in: ProtoDatum

• bytes bcd = 1

  A a sequence of Binary Coded Decimal digits, most significant first (at the lowest offset into the byte array) and one per 4 bits (that is, each digit taking a value of 0–9, and two digits per byte), with optional leading zero digits.

• int32 scale = 2

  The number of digits that follow the decimal point.

Used in: ProtoDatum

• optional ProtoRangeInner inner = 1

Used in: ProtoRange

• bool lower_inclusive = 1

• optional ProtoDatum lower = 2

• bool upper_inclusive = 3

• optional ProtoDatum upper = 4

Used in: mz_compute_client.protocol.command.ProtoPeek, mz_compute_client.protocol.response.ProtoSubscribeBatch.ProtoUpdate, mz_compute_types.plan.ProtoGetPlan.ProtoGetPlanArrangement, mz_compute_types.plan.render_plan.ProtoExpr.ProtoInputKeyVal, mz_compute_types.plan.render_plan.ProtoExpr.ProtoUpdate, mz_expr.scalar.ProtoMirScalarExpr.ProtoLiteral.ProtoLiteralData, ProtoArray, ProtoDatum, mz_storage_types.errors.ProtoUpsertValueError, mz_storage_types.sources.ProtoSourceData

• repeated ProtoDatum datums = 1