deephaven_enterprise.proto.table_definition_pb2¶

Module Contents¶

class ColumnDefinitionMessage(*, name=..., dataType=..., componentType=..., columnType=..., isVarSizeString=..., encoding=..., codec=..., codecArgs=..., objectWidthBytes=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
dataType (str)
componentType (str | None)
columnType (Global___ColumnTypeEnum | None)
isVarSizeString (bool)
encoding (Global___EncodingTypeEnum | None)
codec (str | None)
codecArgs (str | None)
objectWidthBytes (int | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_codec', b'_codec']) → Literal['codec'] | None[source]¶

WhichOneof(oneof_group: Literal['_codecArgs', b'_codecArgs']) → Literal['codecArgs'] | None

WhichOneof(oneof_group: Literal['_columnType', b'_columnType']) → Literal['columnType'] | None

WhichOneof(oneof_group: Literal['_componentType', b'_componentType']) → Literal['componentType'] | None

WhichOneof(oneof_group: Literal['_encoding', b'_encoding']) → Literal['encoding'] | None

WhichOneof(oneof_group: Literal['_objectWidthBytes', b'_objectWidthBytes']) → Literal['objectWidthBytes'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

CODECARGS_FIELD_NUMBER: int[source]¶

CODEC_FIELD_NUMBER: int[source]¶

COLUMNTYPE_FIELD_NUMBER: int[source]¶

COMPONENTTYPE_FIELD_NUMBER: int[source]¶

DATATYPE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

ENCODING_FIELD_NUMBER: int[source]¶

ISVARSIZESTRING_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

OBJECTWIDTHBYTES_FIELD_NUMBER: int[source]¶

codec: str[source]¶

codecArgs: str[source]¶

columnType: Global___ColumnTypeEnum[source]¶

componentType: str[source]¶

dataType: str[source]¶

encoding: Global___EncodingTypeEnum[source]¶

isVarSizeString: bool[source]¶

name: str[source]¶

objectWidthBytes: int[source]¶

class ColumnTypeEnum[source]¶: Bases: _ColumnTypeEnum

class EncodingTypeEnum[source]¶: Bases: _EncodingTypeEnum

class StorageTypeEnum[source]¶: Bases: _StorageTypeEnum

class TableDefinitionMessage(*, namespace=..., tableName=..., columns=..., storageType=...)[source]¶