package databend_proto

uint64 ver = 100
uint64 min_reader_ver = 101
StageFileCompression compression = 1
uint64 headers = 2
string field_delimiter = 3
string record_delimiter = 4
string nan_display = 5
string escape = 6
string quote = 7
string null_display = 8
bool allow_column_count_mismatch = 9
corresponding to `!error_on_column_count_mismatch` for we can not set default value in proto3
optional string empty_field_as = 10
optional string binary_format = 11
bool output_header = 12
optional string geometry_format = 13

One field, AKA column

Used in: DataSchema, UDAFScript

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
The name of this column.
optional string default_expr = 2
A SQL style expression to define the default value for this field, represent as raw sql
optional DataType data_type = 3
Column data type
uint32 column_id = 4
optional ComputedExpr computed_expr = 5

The schema of a table, such as column data types and other meta info.

Used in: DictionaryMeta, TableMeta

uint64 ver = 100
uint64 min_reader_ver = 101
repeated DataField fields = 1
Fields in the table
map<string, string> metadata = 2
Other optional table info
uint32 next_column_id = 3

An enumeration of all supported data types.

Used in: Array, DataField, NullableType, ProcedureMeta, Struct, Tuple, UDAFScript, UDFScript, UDFServer

uint64 ver = 100
uint64 min_reader_ver = 101
oneof dt
- Empty null_type = 22
- NullableType nullable_type = 1
- Empty bool_type = 2
- Empty int8_type = 3
- Empty int16_type = 4
- Empty int32_type = 5
- Empty int64_type = 6
- Empty uint8_type = 7
- Empty uint16_type = 8
- Empty uint32_type = 9
- Empty uint64_type = 10
- Empty float32_type = 11
- Empty float64_type = 12
- Empty date_type = 13
- Timestamp timestamp_type = 14
- Empty string_type = 15
- Struct struct_type = 16
- Array array_type = 17
- Variant variant_type = 18
- VariantArray variant_array_type = 19
- VariantObject variant_object_type = 20
- IntervalType interval_type = 21
oneof dt24
New Datatype version 24 since 2023-01-03 v0.8.178-nightly
- Empty null_t = 31
- Empty empty_array_t = 32
- Empty bool_t = 33
- Empty binary_t = 46
- Empty string_t = 34
- Number number_t = 35
- Empty timestamp_t = 36
- Empty date_t = 37
- DataType nullable_t = 38
- DataType array_t = 39
- DataType map_t = 40
- Tuple tuple_t = 41
- Empty variant_t = 42
- Decimal decimal_t = 43
- Empty empty_map_t = 44
- Empty bitmap_t = 45
- Empty geometry_t = 47
- Empty geography_t = 48
- Empty interval_t = 49

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 db_id = 1
The db id this table belongs to
string table_name = 2
Table name

DatabaseMeta is a container of all non-identity information.

uint64 ver = 100
uint64 min_reader_ver = 101
string engine = 5
Database engine, like github engine.
map<string, string> engine_options = 6
Database engine options, like github engine <token>.
map<string, string> options = 4
Database options.
string created_on = 20
The time database created.
string updated_on = 21
The time database updated.
string comment = 22
Comment about this database.
optional string drop_on = 23
The time table dropped.
bool gc_in_progress = 29
Indicates whether garbage collection is currently in progress for this dropped database. If it is in progress, the database should not be un-dropped, because the data may be incomplete.
repeated uint64 shared_by = 24
optional TIdent from_share = 25
optional string using_share_endpoint = 27
share endpoint name
optional ShareDbId from_share_db_id = 28
share db id

uint64 ver = 100
uint64 min_reader_ver = 101
map<string, string> args = 1
string return_type = 2
string body = 3
optional string comment = 4
string create_on = 5
optional string update_on = 6

Save db name id list history.

uint64 ver = 100
uint64 min_reader_ver = 101
repeated uint64 ids = 1

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 db_id = 1
string table_name = 2

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101
oneof decimal
- DecimalSize decimal_128 = 1
- DecimalSize decimal_256 = 2

Used in: Decimal

uint64 ver = 100
uint64 min_reader_ver = 101
int32 precision = 1
int32 scale = 2

Describes the metadata of a dictionary

uint64 ver = 100
uint64 min_reader_ver = 101
string source = 1
Dictionary data source, such as MySQL, PostgreSQL, ..
map<string, string> options = 2
Dictionary configuration options
optional DataSchema schema = 3
The schema of a dictionary
map<uint32, string> field_comments = 4
Comments of each field
repeated uint32 primary_column_ids = 5
ID of the primary key column
string comment = 6
Comment about this dictionary.
string created_on = 7
The time dictionary created.
optional string updated_on = 8
The time dictionary updated.

Place holder type for primitive types

Used in: DataType, Number, StageInfo.OnErrorMode, VariantDataType

(message has no fields)

uint64 ver = 100
uint64 min_reader_ver = 101

Used in: StageInfo

uint64 ver = 100
uint64 min_reader_ver = 101
StageFileFormatType format = 1
uint64 skip_header = 2
Number of lines at the start of the file to skip.
string field_delimiter = 3
string record_delimiter = 4
StageFileCompression compression = 5
string escape = 6
string row_tag = 7
string nan_display = 8
string quote = 9

Used in: StageInfo, UserDefinedFileFormat

oneof format
- ParquetFileFormatParams parquet = 1
- CsvFileFormatParams csv = 2
- TsvFileFormatParams tsv = 3
- JsonFileFormatParams json = 4
- NdJsonFileFormatParams nd_json = 5
- XmlFileFormatParams xml = 6
- OrcFileFormatParams orc = 7
- AvroFileFormatParams avro = 8

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string root = 1

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string endpoint_url = 1
string bucket = 2
string root = 3
string credential = 4

Used in: UserGrantSet

uint64 ver = 100
uint64 min_reader_ver = 101
optional GrantObject object = 1
uint64 privileges = 2

Used in: GrantEntry

uint64 ver = 100
uint64 min_reader_ver = 101
oneof object
- GrantObject.GrantGlobalObject global = 1
- GrantObject.GrantDatabaseObject database = 2
- GrantObject.GrantTableObject table = 3
- GrantObject.GrantUdfObject udf = 4
- GrantObject.GrantStageObject stage = 5
- GrantObject.GrantDatabaseIdObject databasebyid = 6
- GrantObject.GrantTableIdObject tablebyid = 7
- GrantObject.GrantWarehouseObject warehouse = 8

Used in: GrantObject

string catalog = 1
uint64 db = 2

Used in: GrantObject

string catalog = 1
string db = 2

Used in: GrantObject

(message has no fields)

Used in: GrantObject

string stage = 1

Used in: GrantObject

string catalog = 1
uint64 db = 2
uint64 table = 3

Used in: GrantObject

string catalog = 1
string db = 2
string table = 3

Used in: GrantObject

string udf = 1

Used in: GrantObject

string warehouse = 1

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string root = 1
string name_node = 2

Used in: CatalogOption

uint64 ver = 100
uint64 min_reader_ver = 101
string address = 1
Hive metastore thrift uri
optional StorageConfig storage_params = 2

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string repo_id = 1
string repo_type = 2
string revision = 3
string root = 4
string token = 5

Used in: CatalogOption

uint64 ver = 100
uint64 min_reader_ver = 101
oneof iceberg_catalog_option
- IcebergRestCatalogOption rest_catalog = 2
- IcebergHmsCatalogOption hms_catalog = 3
- IcebergGlueCatalogOption glue_catalog = 4

Used in: IcebergCatalogOption

uint64 ver = 100
uint64 min_reader_ver = 101
string warehouse = 1
map<string, string> props = 2

Used in: IcebergCatalogOption

uint64 ver = 100
uint64 min_reader_ver = 101
string address = 1
string warehouse = 2
map<string, string> props = 3

Used in: IcebergCatalogOption

uint64 ver = 100
uint64 min_reader_ver = 101
string uri = 1
string warehouse = 2
map<string, string> props = 3

IndexMeta is a container of all non-identity information.

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 table_id = 1
The table_id index belong to
IndexMeta.IndexType index_type = 2
string created_on = 3
The time index created.
optional string dropped_on = 4
The time index dropped.
string query = 5
The index based query string
optional string updated_on = 6
The time index updated.
bool sync_creation = 7
if true, index will create after data written to databend, no need execute refresh index manually.
string original_query = 8

Used in: IndexMeta

None = 0
AGGREGATING = 1
JOIN = 2

TODO: remove when MIN_MSG_VER becomes >=24

Used in: IntervalType

Year = 0
Month = 1
Day = 2
Hour = 3
Minute = 4
Second = 5
Doy = 6
Dow = 7
Quarter = 8

TODO: remove when MIN_MSG_VER becomes >=24

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101
IntervalKind kind = 1

Used in: FileFormatParams

uint64 ver = 100
uint64 min_reader_ver = 101
StageFileCompression compression = 1

Used in: UserDefinedFunction

uint64 ver = 100
uint64 min_reader_ver = 101
repeated string parameters = 1
string definition = 2

uint64 ver = 100
uint64 min_reader_ver = 101
string time = 1

uint64 ver = 100
uint64 min_reader_ver = 101
oneof key
- LockKey.Table table = 1

Used in: LockKey

uint64 table_id = 1
string tenant = 2

uint64 ver = 100
uint64 min_reader_ver = 101
string user = 1
string node = 2
string query_id = 3
string created_on = 4
optional string acquired_on = 5
LockMeta.LockType lock_type = 6
map<string, string> extra_info = 7

Used in: LockMeta

TABLE = 0

Used in: BackgroundJobParams, BackgroundTaskInfo

uint64 ver = 100
uint64 min_reader_ver = 101
string id = 1
optional UserIdentity trigger = 2
string triggered_at = 3

uint64 ver = 100
uint64 min_reader_ver = 101
string dropped_on = 1
MarkedDeletedIndexMeta.MarkedDeletedIndexType index_type = 2

Used in: MarkedDeletedIndexMeta

AGGREGATING = 0
INVERTED = 1

uint64 ver = 100
uint64 min_reader_ver = 101
repeated uint64 ids = 1

Used in: FileFormatParams

uint64 ver = 100
uint64 min_reader_ver = 101
StageFileCompression compression = 1
optional string missing_field_as = 2
optional string null_field_as = 3
repeated string null_if = 4

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
repeated string allowed_ip_list = 2
repeated string blocked_ip_list = 3
string comment = 4
string create_on = 5
optional string update_on = 6

TODO: remove when MIN_MSG_VER becomes >=24 A wrapper data type of another type. Such a column allows to contain `null` elements

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101
optional DataType inner = 1
The type for the non-null element.

Enum of number types

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101
oneof num
- Empty uint8_type = 1
- Empty uint16_type = 2
- Empty uint32_type = 3
- Empty uint64_type = 4
- Empty int8_type = 5
- Empty int16_type = 6
- Empty int32_type = 7
- Empty int64_type = 8
- Empty float32_type = 9
- Empty float64_type = 10

uint64 ver = 100
uint64 min_reader_ver = 101
repeated uint64 share_ids = 1

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string endpoint_url = 1
string bucket = 2
string root = 3
string access_key_id = 4
string secret_access_key = 5

Used in: FileFormatParams

uint64 ver = 100
uint64 min_reader_ver = 101
optional string missing_field_as = 1

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string endpoint_url = 1
string bucket = 2
string root = 3
string access_key_id = 4
string access_key_secret = 5
string server_side_encryption = 8
string server_side_encryption_key_id = 9

uint64 ver = 100
uint64 min_reader_ver = 101
string owner_role_name = 1
string updated_on = 2

uint64 ver = 100
uint64 min_reader_ver = 101
string role = 1
optional OwnershipObject object = 2

Used in: OwnershipInfo

uint64 ver = 100
uint64 min_reader_ver = 101
oneof object
- OwnershipObject.OwnershipDatabaseObject database = 1
- OwnershipObject.OwnershipTableObject table = 2
- OwnershipObject.OwnershipUdfObject udf = 3
- OwnershipObject.OwnershipStageObject stage = 4
- OwnershipObject.OwnershipWarehouseObject warehouse = 5

Used in: OwnershipObject

string catalog = 1
uint64 db = 2

Used in: OwnershipObject

string stage = 1

Used in: OwnershipObject

string catalog = 1
uint64 db = 2
uint64 table = 3

Used in: OwnershipObject

string udf = 1

Used in: OwnershipObject

string id = 1

Used in: FileFormatParams

uint64 ver = 100
uint64 min_reader_ver = 101
optional string missing_field_as = 1
StageFileCompression compression = 2
repeated string null_if = 4

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
uint64 min_length = 2
uint64 max_length = 3
uint64 min_upper_case_chars = 4
uint64 min_lower_case_chars = 5
uint64 min_numeric_chars = 6
uint64 min_special_chars = 7
uint64 min_age_days = 8
uint64 max_age_days = 9
uint64 max_retries = 10
uint64 lockout_time_mins = 11
uint64 history = 12
string comment = 13
string create_on = 14
optional string update_on = 15

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
string args = 2

ProcedureMeta is a container of all non-identity information.

uint64 ver = 100
uint64 min_reader_ver = 101
repeated DataType return_types = 4
Procedure return type
repeated string arg_names = 5
string created_on = 10
The time database created.
string updated_on = 11
The time database updated.
string comment = 12
Comment about this database.
string script = 13
Comment about this database.
string language = 14

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
optional UserGrantSet grants = 2
optional string created_on = 3
The time role created.
optional string update_on = 4
The time role update.

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string region = 1
string endpoint_url = 2
string access_key_id = 3
string secret_access_key = 4
string bucket = 5
string root = 6
string master_key = 7
bool disable_credential_loader = 8
bool enable_virtual_host_style = 9
string security_token = 10
string role_arn = 11
string external_id = 12

uint64 ver = 100
uint64 min_reader_ver = 101
string create_on = 1
string update_on = 2
optional string comment = 3
uint64 start = 4
int64 step = 5
uint64 current = 6

uint64 ver = 100
uint64 min_reader_ver = 101
string account = 1
uint64 share_id = 2
string share_on = 3
optional string accept_on = 4

Used in: CatalogOption

uint64 ver = 100
uint64 min_reader_ver = 101
string provider = 1
string share_name = 2
string share_endpoint = 3

Used in: ShareEndpointMeta

oneof credential
- ShareCredentialHMAC hmac = 1

Used in: ShareCredential

uint64 ver = 100
uint64 min_reader_ver = 101
string key = 1

Used in: ShareMetaV2

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 privileges = 1
string db_name = 2
uint64 db_id = 3
string grant_on = 4

uint64 ver = 100
uint64 min_reader_ver = 101
string tenant = 1
The user this db belongs to
string db_name = 2
Database name
uint64 db_id = 3

Used in: DatabaseMeta

oneof db_id
- ShareUsageDbId usage = 1
- ShareReferenceDbId reference = 2

uint64 ver = 100
uint64 min_reader_ver = 101
string tenant = 1
The user this share belongs to
string endpoint = 2
share endpoint name

uint64 ver = 100
uint64 min_reader_ver = 101
string url = 1
string tenant = 2
map<string, string> args = 3
optional string comment = 4
string create_on = 5
optional ShareCredential credential = 6

Used in: ShareMetaV1

uint64 ver = 100
uint64 min_reader_ver = 101
optional ShareGrantObject object = 1
uint64 privileges = 2
string grant_on = 3
optional string update_on = 4

Used in: ShareGrantEntry

uint64 ver = 100
uint64 min_reader_ver = 101
oneof object
- uint64 db_id = 1
- uint64 table_id = 2

uint64 ver = 100
uint64 min_reader_ver = 101
optional ShareGrantEntry database = 1
repeated ShareGrantEntry entries = 2
repeated string accounts = 3
optional string comment = 4
string share_on = 5
optional string update_on = 6
repeated uint64 share_from_db_ids = 7

uint64 ver = 100
uint64 min_reader_ver = 101
repeated string accounts = 1
optional string comment = 2
string create_on = 3
string update_on = 4
optional ShareDatabase use_database = 5
repeated ShareDatabase reference_database = 6
repeated ShareTable table = 7
repeated ShareReferenceTable reference_table = 8

Used in: ShareDbId

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 id = 1

Used in: ShareMetaV2

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 privileges = 1
string table_name = 2
uint64 db_id = 3
uint64 table_id = 4
string grant_on = 5
string engine = 6
repeated uint64 reference_by = 7

Used in: ShareMetaV2

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 privileges = 1
string table_name = 2
uint64 db_id = 3
uint64 table_id = 4
string grant_on = 5
string engine = 6
repeated uint64 view_reference_table = 7

Used in: ShareDbId

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 id = 1

uint64 ver = 100
uint64 min_reader_ver = 101
string path = 1
uint64 size = 2
optional string md5 = 3
string last_modified = 4
optional UserIdentity creator = 5
optional string etag = 6

Used in: AvroFileFormatParams, CsvFileFormatParams, FileFormatOptions, JsonFileFormatParams, NdJsonFileFormatParams, ParquetFileFormatParams, TsvFileFormatParams, XmlFileFormatParams

Auto = 0
Gzip = 1
Bz2 = 2
Brotli = 3
Zstd = 4
Deflate = 5
RawDeflate = 6
Lzo = 7
Snappy = 8
None = 9
We used to assign `None` as 9, it's a mistake. Please change this value to 0 instead in next version bump.
Xz = 10

Used in: FileFormatOptions

Csv = 0
Json = 1
Avro = 2
Orc = 3
Parquet = 4
Xml = 5
NdJson = 6
Tsv = 7

uint64 ver = 100
uint64 min_reader_ver = 101
string stage_name = 1
StageInfo.StageType stage_type = 2
optional StageInfo.StageParams stage_params = 3
optional FileFormatOptions file_format_options = 4
optional StageInfo.CopyOptions copy_options = 5
string comment = 6
uint64 number_of_files = 7
optional UserIdentity creator = 8
optional FileFormatParams file_format_params = 9
optional string created_on = 10

Used in: StageInfo

optional OnErrorMode on_error = 1
uint64 size_limit = 2
uint64 max_files = 10
bool purge = 3
bool single = 4
uint64 max_file_size = 5
uint64 split_size = 6
bool disable_variant_check = 7
bool return_failed_only = 8

Used in: CopyOptions

oneof mode
- Empty None = 1
- Empty Continue = 2
- Empty SkipFile = 3
- uint64 SkipFileNum = 4
- Empty AbortStatement = 5
- uint64 AbortNum = 6

Used in: StageInfo

optional StorageConfig storage = 1

Used in: StageInfo

LegacyInternal = 0
External = 1
Internal = 2
User = 3

Used in: HiveCatalogOption, StageInfo.StageParams, TableMeta

oneof storage
- S3StorageConfig s3 = 1
- FsStorageConfig fs = 2
- GcsStorageConfig gcs = 3
- OssStorageConfig oss = 4
- WebhdfsStorageConfig webhdfs = 5
- ObsStorageConfig obs = 6
- CosStorageConfig cos = 7
- HdfsStorageConfig hdfs = 8
- HuggingfaceStorageConfig huggingface = 9

TODO: remove when MIN_MSG_VER becomes >=24 Struct is similar to a `map` with fixed keys.

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101
repeated string names = 1
Struct field names.
repeated DataType types = 2
The corresponding field types.

`[T]enant[Ident]` is a common meta-service key structure in form of `<PREFIX>/<TENANT>/<NAME>`.

Used in: DatabaseMeta

uint64 ver = 100
uint64 min_reader_ver = 101
string tenant = 1
The user this record belongs to. It must not be empty.
string name = 2
Resource name

uint64 ver = 100
uint64 min_reader_ver = 101
optional string etag = 1
uint64 content_length = 2
optional string last_modified = 3

Save table name id list history.

uint64 ver = 100
uint64 min_reader_ver = 101
repeated uint64 ids = 1

The identifier of a table. `table_id` will never change. It can only be created or removed. The `seq` indicates changes of the instance. I.e., the tuple `(db_id, seq)` always identifies the same instance.

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 table_id = 1
uint64 seq = 2
The seq of TableMeta

Used in: TableMeta

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
repeated uint32 column_ids = 2
bool sync_creation = 3
if true, index will create after data written to databend, no need execute refresh index manually.
string version = 4
if the index columns or options change, the index data needs to be regenerated, version is used to identify each change.
map<string, string> options = 5
index options specify the index configs, like tokenizer.
TableIndex.IndexType index_type = 6
Type of table index: inverted, ngram

Used in: TableIndex

INVERTED = 0
NGRAM = 1

TableMeta is a container of all non-identity information.

uint64 ver = 100
uint64 min_reader_ver = 101
optional DataSchema schema = 1
Table schema, i.e., columns definition.
string engine = 6
Table engine.
map<string, string> engine_options = 7
Database engine options, like github engine <token>.
map<string, string> options = 5
Table options.
optional string cluster_key = 9
Keys to sort rows in table.
repeated string cluster_keys = 4
The vector of cluster keys.
optional uint32 cluster_key_seq = 8
A sequential number that uniquely identifies changes to the cluster key.
string created_on = 20
The time table created.
string updated_on = 21
The time table updated.
string comment = 22
Comment about this table.
optional TableStatistics statistics = 23
Statistics of this table.
optional string drop_on = 24
The time table dropped.
repeated string field_comments = 25
Comments of each field.
optional StorageConfig storage_params = 26
Table storage location connection info.
optional string part_prefix = 27
repeated uint64 shared_by = 28
map<string, string> column_mask_policy = 29
map<string, TableIndex> indexes = 31
optional VirtualDataSchema virtual_schema = 32
The schema of virtual columns.

The identifier of a table by name. Names can be changed. There is no guarantee that two get-table request by name will return the same instance.

uint64 ver = 100
uint64 min_reader_ver = 101
string tenant = 1
The user this table belongs to.
string db_name = 2
The database this table belongs to.
string table_name = 3
The table name.

The statistics of a table

Used in: CompactionStats, TableMeta

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 number_of_rows = 1
Number of rows
uint64 data_bytes = 2
Size of data in bytes
uint64 compressed_data_bytes = 3
Size of compressed data in bytes
uint64 index_data_bytes = 4
Size of index data in bytes
optional uint64 number_of_segments = 5
Number of segments
optional uint64 number_of_blocks = 6
Number of blocks

uint64 ver = 100
uint64 min_reader_ver = 101
uint32 max_databases = 1
The max databases can be created in the tenant.
uint32 max_tables_per_database = 2
The max tables per database can be created in the tenant.
uint32 max_stages = 3
The max stages can be created in the tenant.
uint32 max_files_per_stage = 4
The max files per stage can be created in the tenant.
uint32 max_users = 5
The max number of users can be created in the tenant.

TODO: remove when MIN_MSG_VER becomes >=24 Timestamp data type with customizable precision and timezone: `tz`.

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101

uint64 ver = 100
uint64 min_reader_ver = 101
TokenInfo.TokenType token_type = 1
optional string parent = 2

Used in: TokenInfo

Session = 0
Refresh = 2

Used in: FileFormatParams

uint64 ver = 100
uint64 min_reader_ver = 101
StageFileCompression compression = 1
uint64 headers = 2
string field_delimiter = 3
string record_delimiter = 4
string nan_display = 5
string escape = 6
string quote = 7

Tuple is similar to a `map` with fixed keys.

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101
repeated string field_names = 1
field names.
repeated DataType field_types = 2
The corresponding field types.

Used in: UserDefinedFunction

uint64 ver = 100
uint64 min_reader_ver = 101
string code = 1
string language = 2
string runtime_version = 3
optional DataType return_type = 4
repeated DataType arg_types = 5
repeated DataField state_fields = 6

Used in: UserDefinedFunction

uint64 ver = 100
uint64 min_reader_ver = 101
string code = 1
string handler = 2
string language = 3
repeated DataType arg_types = 4
optional DataType return_type = 5
string runtime_version = 6

Used in: UserDefinedFunction

uint64 ver = 100
uint64 min_reader_ver = 101
string address = 1
string handler = 2
string language = 3
repeated DataType arg_types = 4
optional DataType return_type = 5
map<string, string> headers = 6

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
string storage_type = 2
map<string, string> storage_params = 3

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
optional FileFormatParams file_format_params = 2
optional UserIdentity creator = 3

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
string description = 2
oneof definition
- LambdaUDF lambda_udf = 3
- UDFServer udf_server = 4
- UDFScript udf_script = 6
- UDAFScript udaf_script = 7
optional string created_on = 5
The time udf created.

Used in: RoleInfo, UserInfo

uint64 ver = 100
uint64 min_reader_ver = 101
repeated GrantEntry entries = 1
map<string, bool> roles = 2

Used in: BackgroundJobInfo, ManualTriggerParams, StageFile, StageInfo, UserDefinedFileFormat

uint64 ver = 100
uint64 min_reader_ver = 101
string username = 1
string hostname = 2

uint64 ver = 100
uint64 min_reader_ver = 101
string name = 1
string hostname = 2
optional AuthInfo auth_info = 3
optional UserGrantSet grants = 4
optional UserQuota quota = 5
optional UserOption option = 6
repeated AuthInfo history_auth_infos = 7
repeated string password_fails = 8
optional string password_update_on = 9
optional string lockout_time = 10
optional string created_on = 11
The time user created.
optional string update_on = 12
The time user update.

Used in: UserInfo

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 flags = 1
optional string default_role = 2
optional string network_policy = 3
optional string password_policy = 4
optional bool disabled = 5
optional bool must_change_password = 6

Used in: UserInfo

uint64 ver = 100
uint64 min_reader_ver = 101
uint64 max_cpu = 1
uint64 max_memory_in_bytes = 2
uint64 max_storage_in_bytes = 3

Used in: BackgroundTaskInfo

uint64 ver = 100
uint64 min_reader_ver = 101

TODO: remove when MIN_MSG_VER becomes >=24 Something under developing.:)

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101

TODO: remove when MIN_MSG_VER becomes >=24

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101

VariantDataType is used to represent the data type that may be contained in VirtualDataField

Used in: VirtualDataField

oneof dt
- Empty jsonb_t = 1
- Empty bool_t = 2
- Empty uint64_t = 3
- Empty int64_t = 4
- Empty float64_t = 5
- Empty string_t = 6
- VariantDataType array_t = 7

TODO: remove when MIN_MSG_VER becomes >=24

Used in: DataType

uint64 ver = 100
uint64 min_reader_ver = 101

VirtualDataField a single column type inferred from a Variant type Column

Used in: VirtualDataSchema

string name = 1
The name of this virtual column.
repeated VariantDataType data_types = 2
Virtual column data type, may have different data type in different block
uint32 source_column_id = 3
The column id of source column
uint32 column_id = 4
The column id of this virtual column

VirtualDataSchema records all single columns inferred from the Variant type Column contained in the table

Used in: TableMeta

uint64 ver = 100
uint64 min_reader_ver = 101
repeated VirtualDataField fields = 1
Virtual Fields in the table
map<string, string> metadata = 2
Other optional virutal columns info
uint32 next_column_id = 3
start from 3_000_000_001, Avoid conflicts with the column ids of normal columns
uint64 number_of_blocks = 4
Number of blocks have virtual columns

Used in: StorageConfig

uint64 version = 100
uint64 min_reader_ver = 101
string endpoint_url = 1
string root = 2
string delegation = 3
string user_name = 4
bool disable_list_batch = 6

Used in: FileFormatParams

uint64 ver = 100
uint64 min_reader_ver = 101
StageFileCompression compression = 1
string row_tag = 2

package databend_proto

message Array

uint64 ver = 100

uint64 min_reader_ver = 101

optional DataType inner = 1

message AuthInfo

uint64 ver = 100

uint64 min_reader_ver = 101

oneof info

AuthInfo.None none = 1

AuthInfo.Password password = 2

AuthInfo.JWT jwt = 3

message AuthInfo.JWT

message AuthInfo.None

message AuthInfo.Password

bytes hash_value = 1

Password.PasswordHashMethod hash_method = 2

optional bool need_change = 3

enum AuthInfo.Password.PasswordHashMethod

PlainText = 0

DoubleSha1 = 1

Sha256 = 2

message AvroFileFormatParams

uint64 ver = 100

uint64 min_reader_ver = 101

StageFileCompression compression = 1

optional string missing_field_as = 2

repeated string null_if = 3

message BackgroundJobInfo

uint64 ver = 100

uint64 min_reader_ver = 101

optional BackgroundJobParams job_params = 1

optional BackgroundJobStatus job_status = 2

BackgroundTaskType task_type = 3

string message = 4

optional string last_updated = 5

optional UserIdentity creator = 90

string created_at = 91

message BackgroundJobParams

uint64 ver = 100

uint64 min_reader_ver = 101

BackgroundJobParams.BackgroundJobType job_type = 1

uint64 scheduled_job_interval_seconds = 2

string scheduled_job_cron = 3

optional string scheduled_job_timezone = 4

optional ManualTriggerParams manual_trigger = 5

enum BackgroundJobParams.BackgroundJobType

BACKGROUND_JOB_TYPE_ONE_SHOT = 0

BACKGROUND_JOB_TYPE_INTERVAL = 1

BACKGROUND_JOB_TYPE_CRON = 2

message BackgroundJobStatus

uint64 ver = 100

uint64 min_reader_ver = 101

BackgroundJobStatus.BackgroundJobState job_state = 2

optional string last_task_id = 4

optional string last_task_run_at = 5

optional string next_task_scheduled_time = 6

enum BackgroundJobStatus.BackgroundJobState

BACKGROUND_JOB_STATE_RUNNING = 0

BACKGROUND_JOB_STATE_FAILED = 1

BACKGROUND_JOB_STATE_SUSPENDED = 2

message BackgroundTaskCreator

uint64 ver = 100

uint64 min_reader_ver = 101

string tenant = 1

string name = 2

message BackgroundTaskInfo

uint64 ver = 100

uint64 min_reader_ver = 101

optional string last_updated = 3

BackgroundTaskType task_type = 4

BackgroundTaskState task_state = 5

string message = 6

optional CompactionStats compaction_task_stats = 7

optional VacuumStats vacuum_stats = 8

optional ManualTriggerParams manual_trigger = 9

optional BackgroundTaskCreator creator = 90

string created_at = 91

enum BackgroundTaskState

BACKGROUND_TASK_STATE_STARTED = 0