gensrc/thrift/FrontendService.thrift

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

namespace cpp doris
namespace java org.apache.doris.thrift

include "Status.thrift"
include "Types.thrift"
include "PaloInternalService.thrift"
include "PlanNodes.thrift"
include "Planner.thrift"
include "Descriptors.thrift"
include "Data.thrift"
include "Exprs.thrift"
include "RuntimeProfile.thrift"
include "MasterService.thrift"
include "AgentService.thrift"
include "DataSinks.thrift"
include "HeartbeatService.thrift"

// These are supporting structs for JniFrontend.java, which serves as the glue
// between our C++ execution environment and the Java frontend.

struct TColumnDesc {
  1: required string columnName
  2: required Types.TPrimitiveType columnType
  3: optional i32 columnLength
  4: optional i32 columnPrecision
  5: optional i32 columnScale
  6: optional bool isAllowNull
  7: optional string columnKey
  8: optional list<TColumnDesc> children
  9: optional string defaultValue
}

// A column definition; used by CREATE TABLE and DESCRIBE <table> statements. A column
// definition has a different meaning (and additional fields) from a column descriptor,
// so this is a separate struct from TColumnDesc.
struct TColumnDef {
  1: required TColumnDesc columnDesc
  2: optional string comment
}

// Arguments to DescribeTables, which returns a list of column descriptors for
// given tables
struct TDescribeTablesParams {
  1: optional string db
  2: required list<string> tables_name
  3: optional string user   // deprecated
  4: optional string user_ip    // deprecated
  5: optional Types.TUserIdentity current_user_ident // to replace the user and user ip
  6: optional bool show_hidden_columns = false
  7: optional string catalog
  // Reserved for downstream field `current_roles` to keep thrift field ids
  // wire-compatible across maintained branches. Do not reuse this id.
  8: optional set<string> reserved_field_8
}

// Results of a call to describeTable()
struct TDescribeTablesResult {
  // tables_offset means that the offset for each table in columns
  1: required list<i32> tables_offset
  2: required list<TColumnDef> columns
}

struct TShowVariableRequest {
    1: required i64 threadId
    2: required Types.TVarType varType
}

// Results of a call to describeTable()
struct TShowVariableResult {
    1: required list<list<string>> variables
}


// Arguments to getDbNames, which returns a list of dbs that match an optional
// pattern
struct TGetDbsParams {
  // If not set, match every database
  1: optional string pattern
  2: optional string user   // deprecated
  3: optional string user_ip    // deprecated
  4: optional Types.TUserIdentity current_user_ident // to replace the user and user ip
  5: optional string catalog
  6: optional bool get_null_catalog  //if catalog is empty , get dbName ="NULL" and dbId = -1.
  // Reserved for downstream field `current_roles` to keep thrift field ids
  // wire-compatible across maintained branches. Do not reuse this id.
  7: optional set<string> reserved_field_7
}

// getDbNames returns a list of database names , database ids and catalog names ,catalog ids
struct TGetDbsResult {
  1: optional list<string> dbs
  2: optional list<string> catalogs
  3: optional list<i64> db_ids
  4: optional list<i64> catalog_ids
}

// Arguments to getTableNames, which returns a list of tables that match an
// optional pattern.
struct TGetTablesParams {
  // If not set, match tables in all DBs
  1: optional string db

  // If not set, match every table
  2: optional string pattern
  3: optional string user   // deprecated
  4: optional string user_ip    // deprecated
  5: optional Types.TUserIdentity current_user_ident // to replace the user and user ip
  6: optional string type
  7: optional string catalog
  8: optional string table
  // Reserved for downstream field `current_roles` to keep thrift field ids
  // wire-compatible across maintained branches. Do not reuse this id.
  9: optional set<string> reserved_field_9
}

struct TTableStatus {
    1: required string name
    2: required string type
    3: required string comment
    4: optional string engine
    5: optional i64 last_check_time
    6: optional i64 create_time
    7: optional string ddl_sql
    8: optional i64 update_time
    9: optional i64 check_time
    10: optional string collation
    11: optional i64 rows;
    12: optional i64 avg_row_length
    13: optional i64 data_length;
    14: optional i64 index_length;
}

struct TListTableStatusResult {
    1: required list<TTableStatus> tables
}

struct TTableMetadataNameIds {
    1: optional string name
    2: optional i64 id
}

struct TListTableMetadataNameIdsResult {
    1: optional list<TTableMetadataNameIds> tables
}

// getTableNames returns a list of unqualified table names
struct TGetTablesResult {
  1: list<string> tables
}

struct TPrivilegeStatus {
    1: optional string table_name
    2: optional string privilege_type
    3: optional string grantee
    4: optional string schema
    5: optional string is_grantable
}

struct TListPrivilegesResult{
  1: required list<TPrivilegeStatus> privileges
}

struct TReportExecStatusResult {
  // required in V1
  1: optional Status.TStatus status
}

// Service Protocol Details
enum FrontendServiceVersion {
  V1 = 0
}

struct TDetailedReportParams {
  1: optional Types.TUniqueId fragment_instance_id
  2: optional RuntimeProfile.TRuntimeProfileTree profile
  3: optional RuntimeProfile.TRuntimeProfileTree loadChannelProfile
  4: optional bool is_fragment_level
}


struct TQueryStatistics {
    // A thrift structure identical to the PQueryStatistics structure.
    1: optional i64 scan_rows
    2: optional i64 scan_bytes
    3: optional i64 returned_rows
    4: optional i64 cpu_ms
    5: optional i64 max_peak_memory_bytes
    6: optional i64 current_used_memory_bytes
    7: optional i64 workload_group_id
    8: optional i64 shuffle_send_bytes
    9: optional i64 shuffle_send_rows
    10: optional i64 scan_bytes_from_local_storage
    11: optional i64 scan_bytes_from_remote_storage
    12: optional i64 spill_write_bytes_to_local_storage
    13: optional i64 spill_read_bytes_from_local_storage
    14: optional i64 bytes_write_into_cache
    15: optional i64 process_rows
    16: optional i32 finished_tasks_num
    17: optional i32 total_tasks_num
}

struct TQueryStatisticsResult {
    1: optional bool query_finished
    2: optional TQueryStatistics statistics
}

struct TReportWorkloadRuntimeStatusParams {
    1: optional i64 backend_id
    2: optional map<string, TQueryStatistics> query_statistics_map // deprecated
    3: optional map<string, TQueryStatisticsResult> query_statistics_result_map
}

struct TQueryProfile {
    1: optional Types.TUniqueId query_id

    2: optional map<i32, list<TDetailedReportParams>> fragment_id_to_profile

    // Types.TUniqueId should not be used as key in thrift map, so we use two lists instead
    // https://thrift.apache.org/docs/types#containers
    3: optional list<Types.TUniqueId> fragment_instance_ids
    // Types.TUniqueId can not be used as key in thrift map, so we use two lists instead
    4: optional list<RuntimeProfile.TRuntimeProfileTree> instance_profiles

    5: optional list<RuntimeProfile.TRuntimeProfileTree> load_channel_profiles
}

struct TFragmentInstanceReport {
  1: optional Types.TUniqueId fragment_instance_id;
  2: optional i32 num_finished_range;
  3: optional i64 loaded_rows
  4: optional i64 loaded_bytes
}


// The results of an INSERT query, sent to the coordinator as part of
// TReportExecStatusParams
struct TReportExecStatusParams {
  1: required FrontendServiceVersion protocol_version

  // required in V1
  2: optional Types.TUniqueId query_id

  // passed into ExecPlanFragment() as TExecPlanFragmentParams.backend_num
  // required in V1
  3: optional i32 backend_num

  // required in V1
  // Move to TDetailedReportParams for pipelineX
  4: optional Types.TUniqueId fragment_instance_id

  // Status of fragment execution; any error status means it's done.
  // required in V1
  5: optional Status.TStatus status

  // If true, fragment finished executing.
  // required in V1
  6: optional bool done

  // cumulative profile
  // required in V1
  // Move to TDetailedReportParams for pipelineX
  7: optional RuntimeProfile.TRuntimeProfileTree profile // to be deprecated

  // New errors that have not been reported to the coordinator
  // optional in V1
  9: optional list<string> error_log

  // URL of files need to load
  // optional
  10: optional list<string> delta_urls
  11: optional map<string, string> load_counters
  12: optional string tracking_url

  // export files
  13: optional list<string> export_files

  14: optional list<Types.TTabletCommitInfo> commitInfos

  15: optional i64 loaded_rows

  16: optional i64 backend_id

  17: optional i64 loaded_bytes

  18: optional list<Types.TErrorTabletInfo> errorTabletInfos

  19: optional i32 fragment_id

  20: optional PaloInternalService.TQueryType query_type

  // Move to TDetailedReportParams for pipelineX
  21: optional RuntimeProfile.TRuntimeProfileTree loadChannelProfile // to be deprecated

  22: optional i32 finished_scan_ranges

  23: optional list<TDetailedReportParams> detailed_report // to be deprecated

  24: optional TQueryStatistics query_statistics // deprecated

  25: optional TReportWorkloadRuntimeStatusParams report_workload_runtime_status

  26: optional list<DataSinks.THivePartitionUpdate> hive_partition_updates

  27: optional TQueryProfile query_profile

  28: optional list<DataSinks.TIcebergCommitData> iceberg_commit_datas

  29: optional i64 txn_id
  30: optional string label

  31: optional list<TFragmentInstanceReport> fragment_instance_reports;

  32: optional list<DataSinks.TMCCommitData> mc_commit_datas

  33: optional string first_error_msg
}

struct TFeResult {
    1: required FrontendServiceVersion protocolVersion
    2: required Status.TStatus status

    // For cloud
    1000: optional string cloud_cluster
    1001: optional bool noAuth
}

enum TSubTxnType {
    INSERT = 0,
    DELETE = 1
}

struct TSubTxnInfo {
    1: optional i64 sub_txn_id
    2: optional i64 table_id
    3: optional list<Types.TTabletCommitInfo> tablet_commit_infos
    4: optional TSubTxnType sub_txn_type
}

struct TTxnLoadInfo {
    1: optional string label
    2: optional i64 dbId
    3: optional i64 txnId
    4: optional i64 timeoutTimestamp
    5: optional i64 allSubTxnNum
    6: optional list<TSubTxnInfo> subTxnInfos
}

struct TGroupCommitInfo{
    1: optional bool getGroupCommitLoadBeId
    2: optional i64 groupCommitLoadTableId
    3: optional string cluster
    5: optional bool updateLoadData
    6: optional i64 tableId 
    7: optional i64 receiveData
}

struct TMasterOpRequest {
    1: required string user
    2: required string db
    3: required string sql
    // Deprecated
    4: optional Types.TResourceInfo resourceInfo
    5: optional string cluster
    6: optional i64 execMemLimit // deprecated, move into query_options
    7: optional i32 queryTimeout // deprecated, move into query_options
    8: optional string user_ip
    9: optional string time_zone // deprecated, move into session_variables
    10: optional i64 stmt_id
    11: optional i64 sqlMode // deprecated, move into session_variables
    12: optional i64 loadMemLimit // deprecated, move into query_options
    13: optional bool enableStrictMode // deprecated, move into session_variables
    // this can replace the "user" field
    14: optional Types.TUserIdentity current_user_ident
    15: optional i32 stmtIdx  // the idx of the sql in multi statements
    16: optional PaloInternalService.TQueryOptions query_options
    17: optional Types.TUniqueId query_id // when this is a query, we translate this query id to master
    18: optional i64 insert_visible_timeout_ms // deprecated, move into session_variables
    19: optional map<string, string> session_variables
    20: optional bool foldConstantByBe
    21: optional map<string, string> trace_carrier
    22: optional string clientNodeHost
    23: optional i32 clientNodePort
    24: optional bool syncJournalOnly // if set to true, this request means to do nothing but just sync max journal id of master
    25: optional string defaultCatalog
    26: optional string defaultDatabase
    27: optional bool cancel_qeury // if set to true, this request means to cancel one forwarded query, and query_id needs to be set
    28: optional map<string, Exprs.TExprNode> user_variables
    // transaction load
    29: optional TTxnLoadInfo txnLoadInfo
    30: optional TGroupCommitInfo groupCommitInfo
    31: optional binary prepareExecuteBuffer
    32: optional bool moreResultExists // Server has more result to send
    33: optional map<string, string> connect_attributes

    // Reserved for downstream fields `current_roles` and `is_su_user` to keep
    // thrift field ids wire-compatible across maintained branches. Do not reuse these ids.
    34: optional set<string> reserved_field_34
    35: optional bool reserved_field_35

    // selectdb cloud
    1000: optional string cloud_cluster
    1001: optional bool noAuth;

    // temporary table
    1002: optional string sessionId
    // propagate client's CLIENT_DEPRECATE_EOF capability for proxy forwarding
    1003: optional bool clientDeprecatedEOF
}

struct TColumnDefinition {
    1: required string columnName;
    2: required Types.TColumnType columnType;
    3: optional Types.TAggregationType aggType;
    4: optional string defaultValue;
}

struct TShowResultSetMetaData {
    1: required list<TColumnDefinition> columns;
}

struct TShowResultSet {
    1: required TShowResultSetMetaData metaData;
    2: required list<list<string>> resultRows;
}

struct TMasterOpResult {
    1: required i64 maxJournalId;
    2: required binary packet;
    3: optional TShowResultSet resultSet;
    4: optional Types.TUniqueId queryId;
    5: optional string status;
    6: optional i32 statusCode;
    7: optional string errMessage;
    8: optional list<binary> queryResultBufList;
    // transaction load
    9: optional TTxnLoadInfo txnLoadInfo;
    10: optional i64 groupCommitLoadBeId;
    11: optional i64 affectedRows;
}

// Certificate-based authentication info forwarded from BE to FE
struct TCertBasedAuth {
    1: optional string cert_pem            // Client certificate in PEM format (for debugging)
    2: optional string subject             // Certificate Subject DN
    3: optional string san                 // Subject Alternative Names (formatted string)
    4: optional string issuer              // Issuer DN
    5: optional string cipher              // SSL cipher suite used
    6: optional string validity_not_before // Certificate validity start time
    7: optional string validity_not_after  // Certificate validity end time
}

struct TLoadTxnBeginRequest {
    1: optional string cluster
    2: required string user
    3: required string passwd
    4: required string db
    5: required string tbl
    6: optional string user_ip
    7: required string label
    8: optional i64 timestamp   // deprecated, use request_id instead
    9: optional i64 auth_code // deprecated, use token instead
    // The real value of timeout should be i32. i64 ensures the compatibility of interface.
    10: optional i64 timeout
    11: optional Types.TUniqueId request_id
    12: optional string token
    13: optional string auth_code_uuid // deprecated, use token instead
    14: optional i64 table_id
    15: optional i64 backend_id
    16: optional TCertBasedAuth cert_based_auth
    // If set to true: use table group_commit_mode property
    17: optional bool use_table_group_commit_mode
}

struct TLoadTxnBeginResult {
    1: required Status.TStatus status
    2: optional i64 txnId
    3: optional string job_status // if label already used, set status of existing job
    4: optional i64 db_id
    // If use_table_group_commit_mode is true in TLoadTxnBeginRequest, and table group_commit_mode property is
    // async_mode or sync_mode, return table group_commit_mode (begin_txn is skipped)
    5: optional string table_group_commit_mode
}

struct TBeginTxnRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional list<i64> table_ids
    6: optional string user_ip
    7: optional string label
    8: optional i64 auth_code // deprecated, use token instead
    // The real value of timeout should be i32. i64 ensures the compatibility of interface.
    9: optional i64 timeout
    10: optional Types.TUniqueId request_id
    11: optional string token
    12: optional i64 backend_id
    // used for ccr
    13: optional i64 sub_txn_num = 0
}

struct TBeginTxnResult {
    1: optional Status.TStatus status
    2: optional i64 txn_id
    3: optional string job_status // if label already used, set status of existing job
    4: optional i64 db_id
    5: optional Types.TNetworkAddress master_address
    // used for ccr
    6: optional list<i64> sub_txn_ids
}

// StreamLoad request, used to load a streaming to engine
struct TStreamLoadPutRequest {
    1: optional string cluster
    2: required string user
    3: required string passwd
    4: required string db
    5: required string tbl
    6: optional string user_ip

    // and use this to assgin to OlapTableSink
    7: required Types.TUniqueId loadId
    8: required i64 txnId

    9: required Types.TFileType fileType
    10: required PlanNodes.TFileFormatType formatType

    // only valid when file_type is FILE_LOCAL
    11: optional string path

    // describe how table's column map to field in source file
    // slot descriptor stands for field of source file
    12: optional string columns
    // filters that applied on data
    13: optional string where
    // only valid when file type is CSV
    14: optional string columnSeparator

    15: optional string partitions
    16: optional i64 auth_code // deprecated, use token instead
    17: optional bool negative
    18: optional i32 timeout
    19: optional bool strictMode
    20: optional string timezone
    21: optional i64 execMemLimit
    22: optional bool isTempPartition
    23: optional bool strip_outer_array
    24: optional string jsonpaths
    25: optional i64 thrift_rpc_timeout_ms
    26: optional string json_root
    27: optional Types.TMergeType merge_type
    28: optional string delete_condition
    29: optional string sequence_col
    30: optional bool num_as_string
    31: optional bool fuzzy_parse
    32: optional string line_delimiter
    33: optional bool read_json_by_line
    34: optional string token
    35: optional i32 send_batch_parallelism
    36: optional double max_filter_ratio
    37: optional bool load_to_single_tablet
    38: optional string header_type
    39: optional string hidden_columns
    40: optional PlanNodes.TFileCompressType compress_type
    41: optional i64 file_size // only for stream load with parquet or orc
    42: optional bool trim_double_quotes // trim double quotes for csv
    43: optional i32 skip_lines // csv skip line num, only used when csv header_type is not set.
    44: optional bool enable_profile
    45: optional bool partial_update
    46: optional list<string> table_names
    47: optional string load_sql // insert into sql used by stream load
    48: optional i64 backend_id
    49: optional i32 version // version 1 means use load_sql
    50: optional string label
    // only valid when file type is CSV
    51: optional i8 enclose
    // only valid when file type is CSV
    52: optional i8 escape
    53: optional bool memtable_on_sink_node;
    54: optional bool group_commit // deprecated
    55: optional i32 stream_per_node;
    56: optional string group_commit_mode
    57: optional Types.TUniqueKeyUpdateMode unique_key_update_mode
    58: optional Descriptors.TPartialUpdateNewRowPolicy partial_update_new_key_policy
    59: optional bool empty_field_as_null
    60: optional TCertBasedAuth cert_based_auth

    // For cloud
    1000: optional string cloud_cluster
    1001: optional i64 table_id
}

struct TStreamLoadPutResult {
    1: required Status.TStatus status
    // valid when status is OK
    //2: optional PaloInternalService.TExecPlanFragmentParams params # deprecated
    3: optional PaloInternalService.TPipelineFragmentParams pipeline_params
    // used for group commit
    4: optional i64 base_schema_version
    5: optional i64 db_id
    6: optional i64 table_id
    7: optional bool wait_internal_group_commit_finish = false
    8: optional i64 group_commit_interval_ms
    9: optional i64 group_commit_data_bytes
}

struct TStreamLoadMultiTablePutResult {
    1: required Status.TStatus status
    // valid when status is OK
    // 2: optional list<PaloInternalService.TExecPlanFragmentParams> params # deprecated
    3: optional list<PaloInternalService.TPipelineFragmentParams> pipeline_params
}

struct TStreamLoadWithLoadStatusResult {
    1: optional Status.TStatus status
    2: optional i64 txn_id
    3: optional i64 total_rows
    4: optional i64 loaded_rows
    5: optional i64 filtered_rows
    6: optional i64 unselected_rows
}

struct TKafkaRLTaskProgress {
    1: required map<i32,i64> partitionCmtOffset
}

// Kinesis routine load task progress
// Maps shard ID to the last committed sequence number
struct TKinesisRLTaskProgress {
    1: required map<string,string> shardCmtSeqNum
    // MillisBehindLatest per shard, returned by GetRecords API.
    // Indicates how far behind the consumer is from the tip of the stream.
    // 0 means the consumer has caught up; absent means unknown.
    2: optional map<string,i64> shardMillsBehindLatest
    // Set of shard IDs that have been closed (split/merge) during consumption.
    // FE should remove these shards from tracking.
    3: optional set<string> closedShardIds
}

struct TRLTaskTxnCommitAttachment {
    1: required Types.TLoadSourceType loadSourceType
    2: required Types.TUniqueId id
    3: required i64 jobId
    4: optional i64 loadedRows
    5: optional i64 filteredRows
    6: optional i64 unselectedRows
    7: optional i64 receivedBytes
    8: optional i64 loadedBytes
    9: optional i64 loadCostMs
    10: optional TKafkaRLTaskProgress kafkaRLTaskProgress
    11: optional string errorLogUrl
    12: optional TKinesisRLTaskProgress kinesisRLTaskProgress
}

struct TTxnCommitAttachment {
    1: required Types.TLoadType loadType
    2: optional TRLTaskTxnCommitAttachment rlTaskTxnCommitAttachment
//    3: optional TMiniLoadTxnCommitAttachment mlTxnCommitAttachment
}

struct TLoadTxnCommitRequest {
    1: optional string cluster
    2: required string user
    3: required string passwd
    4: required string db
    5: required string tbl
    6: optional string user_ip
    7: required i64 txnId
    8: required bool sync
    9: optional list<Types.TTabletCommitInfo> commitInfos
    10: optional i64 auth_code // deprecated, use token instead
    11: optional TTxnCommitAttachment txnCommitAttachment
    12: optional i64 thrift_rpc_timeout_ms
    13: optional string token
    14: optional i64 db_id
    15: optional list<string> tbls
    16: optional i64 table_id
    17: optional string auth_code_uuid // deprecated, use token instead
    18: optional bool groupCommit
    19: optional i64 receiveBytes
    20: optional i64 backendId
    21: optional TCertBasedAuth cert_based_auth
}

struct TLoadTxnCommitResult {
    1: required Status.TStatus status
}

struct TCommitTxnRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional string user_ip
    6: optional i64 txn_id
    7: optional list<Types.TTabletCommitInfo> commit_infos
    8: optional i64 auth_code // deprecated, use token instead
    9: optional TTxnCommitAttachment txn_commit_attachment
    10: optional i64 thrift_rpc_timeout_ms
    11: optional string token
    12: optional i64 db_id
    // used for ccr
    13: optional bool txn_insert
    14: optional list<TSubTxnInfo> sub_txn_infos
    15: optional bool only_commit   // only commit txn, without waiting txn publish
}

struct TCommitTxnResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TLoadTxn2PCRequest {
    1: optional string cluster
    2: required string user
    3: required string passwd
    4: optional string db
    5: optional string user_ip
    6: optional i64 txnId
    7: optional string operation
    8: optional i64 auth_code // deprecated, use token instead
    9: optional string token
    10: optional i64 thrift_rpc_timeout_ms
    11: optional string label
    12: optional TCertBasedAuth cert_based_auth

    // For cloud
    1000: optional string auth_code_uuid // deprecated, use token instead
}

struct TLoadTxn2PCResult {
    1: required Status.TStatus status
}

struct TRollbackTxnRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional string user_ip
    6: optional i64 txn_id
    7: optional string reason
    9: optional i64 auth_code // deprecated, use token instead
    10: optional TTxnCommitAttachment txn_commit_attachment
    11: optional string token
    12: optional i64 db_id
}

struct TRollbackTxnResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TLoadTxnRollbackRequest {
    1: optional string cluster
    2: required string user
    3: required string passwd
    4: required string db
    5: required string tbl
    6: optional string user_ip
    7: required i64 txnId
    8: optional string reason
    9: optional i64 auth_code // deprecated, use token instead
    10: optional TTxnCommitAttachment txnCommitAttachment
    11: optional string token
    12: optional i64 db_id
    13: optional list<string> tbls
    14: optional string auth_code_uuid // deprecated, use token instead
    15: optional string label
}

struct TLoadTxnRollbackResult {
    1: required Status.TStatus status
}

struct TSnapshotLoaderReportRequest {
    1: required i64 job_id
    2: required i64 task_id
    3: required Types.TTaskType task_type
    4: optional i32 finished_num
    5: optional i32 total_num
}

enum TFrontendPingFrontendStatusCode {
   OK = 0,
   FAILED = 1
}

struct TFrontendPingFrontendRequest {
   1: required i32 clusterId
   2: required string token
   3: optional string deployMode
}

struct TCloudVersionInfo {
   1: optional i64 tableId
   2: optional i64 partitionId
   3: optional i64 version
   4: optional i64 versionUpdateTime
}

struct TFrontendSyncCloudVersionRequest {
   1: optional i64 dbId
   2: optional list<TCloudVersionInfo> tableVersionInfos
   3: optional list<TCloudVersionInfo> partitionVersionInfos
}

struct TFrontendReportAliveSessionRequest {
   1: required i32 clusterId
   2: required string token
}

struct TFrontendReportAliveSessionResult {
   1: required Status.TStatusCode status
   2: required string msg
   3: required list<string> sessionIdList
}

struct TDiskInfo {
    1: required string dirType
    2: required string dir
    3: required string filesystem
    4: required i64 blocks
    5: required i64 used
    6: required i64 available
    7: required i32 useRate
    8: required string mountedOn
}

struct TFrontendPingFrontendResult {
    1: required TFrontendPingFrontendStatusCode status
    2: required string msg
    3: required i32 queryPort
    4: required i32 rpcPort
    5: required i64 replayedJournalId
    6: required string version
    7: optional i64 lastStartupTime
    8: optional list<TDiskInfo> diskInfos
    9: optional i64 processUUID
    10: optional i32 arrowFlightSqlPort
}

struct TPropertyVal {
    1: optional string strVal
    2: optional i32 intVal
    3: optional i64 longVal
    4: optional bool boolVal
}

struct TWaitingTxnStatusRequest {
    1: optional i64 db_id
    2: optional i64 txn_id
    3: optional string label
}

struct TWaitingTxnStatusResult {
    1: optional Status.TStatus status
    2: optional i32 txn_status_id
}

struct TInitExternalCtlMetaRequest {
    1: optional i64 catalogId
    2: optional i64 dbId
    3: optional i64 tableId
}

struct TInitExternalCtlMetaResult {
    1: optional i64 maxJournalId;
    2: optional string status;
}

enum TSchemaTableName {
  // BACKENDS = 0,
  METADATA_TABLE = 1, // tvf
  ACTIVE_QUERIES = 2, // db information_schema's table
  WORKLOAD_GROUPS = 3, // db information_schema's table
  // Deprecated
  ROUTINES_INFO = 4, // db information_schema's table
  WORKLOAD_SCHEDULE_POLICY = 5,
  TABLE_OPTIONS = 6,
  WORKLOAD_GROUP_PRIVILEGES = 7,
  TABLE_PROPERTIES = 8,
  CATALOG_META_CACHE_STATS = 9,
  PARTITIONS = 10,
  VIEW_DEPENDENCY = 11,
  SQL_BLOCK_RULE_STATUS = 12,
  DATABASE_PROPERTIES = 13,
  AUTHENTICATION_INTEGRATIONS = 14,
  TABLE_STREAMS = 15,
  TABLE_STREAM_CONSUMPTION = 16,
  ROLE_MAPPINGS = 17,
}

struct TMetadataTableRequestParams {
  1: optional Types.TMetadataType metadata_type
  2: optional PlanNodes.TIcebergMetadataParams iceberg_metadata_params
  3: optional PlanNodes.TBackendsMetadataParams backends_metadata_params
  4: optional list<string> columns_name
  5: optional PlanNodes.TFrontendsMetadataParams frontends_metadata_params
  6: optional Types.TUserIdentity current_user_ident
  7: optional PlanNodes.TQueriesMetadataParams queries_metadata_params
  8: optional PlanNodes.TMaterializedViewsMetadataParams materialized_views_metadata_params
  9: optional PlanNodes.TJobsMetadataParams jobs_metadata_params
  10: optional PlanNodes.TTasksMetadataParams tasks_metadata_params
  11: optional PlanNodes.TPartitionsMetadataParams partitions_metadata_params
  12: optional PlanNodes.TMetaCacheStatsParams meta_cache_stats_params
  13: optional PlanNodes.TPartitionValuesMetadataParams partition_values_metadata_params
  14: optional PlanNodes.THudiMetadataParams hudi_metadata_params
  // Reserved for downstream field `current_roles` to keep thrift field ids
  // wire-compatible across maintained branches. Do not reuse this id.
  15: optional set<string> reserved_field_15
}

struct TSchemaTableRequestParams {
    1: optional list<string> columns_name
    2: optional Types.TUserIdentity current_user_ident
    3: optional bool replay_to_other_fe
    4: optional string catalog  // use for table specific queries
    5: optional i64 dbId         // used for table specific queries
    6: optional string time_zone // used for DATETIME field
    7: optional string frontend_conjuncts
    8: optional i64 thread_id // mysql connection id for fetching ConnectContext if needed
    // Reserved for downstream field `current_roles` to keep thrift field ids
    // wire-compatible across maintained branches. Do not reuse this id.
    9: optional set<string> reserved_field_9
}

struct TFetchSchemaTableDataRequest {
  1: optional string cluster_name
  2: optional TSchemaTableName schema_table_name
  3: optional TMetadataTableRequestParams metada_table_params // used for tvf
  4: optional TSchemaTableRequestParams schema_table_params // used for request db information_schema's table
}

struct TFetchSchemaTableDataResult {
  1: required Status.TStatus status
  2: optional list<Data.TRow> data_batch;
}

struct TMySqlLoadAcquireTokenResult {
    1: optional Status.TStatus status
    2: optional string token
}

struct TTabletCooldownInfo {
    1: optional Types.TTabletId tablet_id
    2: optional Types.TReplicaId cooldown_replica_id
    3: optional Types.TUniqueId cooldown_meta_id
}

struct TConfirmUnusedRemoteFilesRequest {
    1: optional list<TTabletCooldownInfo> confirm_list
}

struct TConfirmUnusedRemoteFilesResult {
    1: optional list<Types.TTabletId> confirmed_tablets
}

enum TPrivilegeHier {
  GLOBAL = 0,
  CATALOG = 1,
  DATABASE = 2,
  TABLE = 3,
  COLUMNS = 4,
  RESOURSE = 5,
}

struct TPrivilegeCtrl {
    1: required TPrivilegeHier priv_hier
    2: optional string ctl
    3: optional string db
    4: optional string tbl
    5: optional set<string> cols
    6: optional string res
}

enum TPrivilegeType {
  NONE = -1,
  SHOW = 0,
  SHOW_RESOURCES = 1,
  GRANT = 2,
  ADMIN = 3,
  LOAD = 4,
  ALTER = 5,
  USAGE = 6,
  CREATE = 7,
  ALL = 8,
  OPERATOR = 9,
  DROP = 10
}

struct TCheckAuthRequest {
    1: optional string cluster
    2: required string user
    3: required string passwd
    4: optional string user_ip
    5: optional TPrivilegeCtrl priv_ctrl
    6: optional TPrivilegeType priv_type
    7: optional i64 thrift_rpc_timeout_ms
}

struct TCheckAuthResult {
    1: required Status.TStatus status
}

enum TQueryStatsType {
    CATALOG = 0,
    DATABASE = 1,
    TABLE = 2,
    TABLE_ALL = 3,
    TABLE_ALL_VERBOSE = 4,
    TABLET = 5,
    TABLETS = 6
}

struct TGetQueryStatsRequest {
    1: optional TQueryStatsType type
    2: optional string catalog
    3: optional string db
    4: optional string tbl
    5: optional i64 replica_id
    6: optional list<i64> replica_ids
}

struct TTableQueryStats {
    1: optional string field
    2: optional i64 query_stats
    3: optional i64 filter_stats
}

struct TTableIndexQueryStats {
    1: optional string index_name
    2: optional list<TTableQueryStats> table_stats
}

struct TQueryStatsResult {
    1: optional Status.TStatus status
    2: optional map<string, i64> simple_result
    3: optional list<TTableQueryStats> table_stats
    4: optional list<TTableIndexQueryStats> table_verbos_stats
    5: optional map<i64, i64> tablet_stats
}

// Lock the binlogs, to avoid being GC during sync.
//
// The caller should lock the binlog before backup, and bumps lock commit seq intervally.
//
// The locked binlogs will be kept until the binlog properties ttl_seconds, max_bytes ... are reached.
struct TLockBinlogRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional string table
    6: optional i64 table_id
    7: optional string token
    8: optional string job_unique_id
    9: optional i64 lock_commit_seq // if not set, lock the latest binlog
}

struct TLockBinlogResult {
    1: optional Status.TStatus status
    2: optional i64 locked_commit_seq
    3: optional Types.TNetworkAddress master_address
}

struct TGetBinlogRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional string table
    6: optional i64 table_id
    7: optional string user_ip
    8: optional string token
    9: optional i64 prev_commit_seq
    10: optional i64 num_acquired // the max num of binlogs in a batch
    11: optional bool allow_follower_read
}

enum TBinlogType {
  UPSERT = 0,
  ADD_PARTITION = 1,
  CREATE_TABLE = 2,
  DROP_PARTITION = 3,
  DROP_TABLE = 4,
  ALTER_JOB = 5,
  MODIFY_TABLE_ADD_OR_DROP_COLUMNS = 6,
  DUMMY = 7,
  ALTER_DATABASE_PROPERTY = 8,
  MODIFY_TABLE_PROPERTY = 9,
  BARRIER = 10,
  MODIFY_PARTITIONS = 11,
  REPLACE_PARTITIONS = 12,
  TRUNCATE_TABLE = 13,
  RENAME_TABLE = 14,
  RENAME_COLUMN = 15,
  MODIFY_COMMENT = 16,
  MODIFY_VIEW_DEF = 17,
  REPLACE_TABLE = 18,
  MODIFY_TABLE_ADD_OR_DROP_INVERTED_INDICES = 19,
  INDEX_CHANGE_JOB = 20,
  RENAME_ROLLUP = 21,
  RENAME_PARTITION = 22,
  DROP_ROLLUP = 23,
  RECOVER_INFO = 24,
  MODIFY_DISTRIBUTION_BUCKET_NUM = 25,
  MODIFY_DISTRIBUTION_TYPE = 26,

  // Keep some IDs for allocation so that when new binlog types are added in the
  // future, the changes can be picked back to the old versions without breaking
  // compatibility.
  //
  // The code will check the IDs of binlog types, any binlog types whose IDs are
  // greater than or equal to MIN_UNKNOWN will be ignored.
  //
  // For example, before you adding new binlog type MODIFY_XXX:
  //    MIN_UNKNOWN = 17,
  //    UNKNOWN_2 = 18,
  //    UNKNOWN_3 = 19,
  // After adding binlog type MODIFY_XXX:
  //    MODIFY_XXX = 17,
  //    MIN_UNKNOWN = 18,
  //    UNKNOWN_3 = 19,
  MIN_UNKNOWN = 27,
  UNKNOWN_12 = 28,
  UNKNOWN_13 = 29,
  UNKNOWN_14 = 30,
  UNKNOWN_15 = 31,
  UNKNOWN_16 = 32,
  UNKNOWN_17 = 33,
  UNKNOWN_18 = 34,
  UNKNOWN_19 = 35,
  UNKNOWN_20 = 36,
  UNKNOWN_21 = 37,
  UNKNOWN_22 = 38,
  UNKNOWN_23 = 39,
  UNKNOWN_24 = 40,
  UNKNOWN_25 = 41,
  UNKNOWN_26 = 42,
  UNKNOWN_27 = 43,
  UNKNOWN_28 = 44,
  UNKNOWN_29 = 45,
  UNKNOWN_30 = 46,
  UNKNOWN_31 = 47,
  UNKNOWN_32 = 48,
  UNKNOWN_33 = 49,
  UNKNOWN_34 = 50,
  UNKNOWN_35 = 51,
  UNKNOWN_36 = 52,
  UNKNOWN_37 = 53,
  UNKNOWN_38 = 54,
  UNKNOWN_39 = 55,
  UNKNOWN_40 = 56,
  UNKNOWN_41 = 57,
  UNKNOWN_42 = 58,
  UNKNOWN_43 = 59,
  UNKNOWN_44 = 60,
  UNKNOWN_45 = 61,
  UNKNOWN_46 = 62,
  UNKNOWN_47 = 63,
  UNKNOWN_48 = 64,
  UNKNOWN_49 = 65,
  UNKNOWN_50 = 66,
  UNKNOWN_51 = 67,
  UNKNOWN_52 = 68,
  UNKNOWN_53 = 69,
  UNKNOWN_54 = 70,
  UNKNOWN_55 = 71,
  UNKNOWN_56 = 72,
  UNKNOWN_57 = 73,
  UNKNOWN_58 = 74,
  UNKNOWN_59 = 75,
  UNKNOWN_60 = 76,
  UNKNOWN_61 = 77,
  UNKNOWN_62 = 78,
  UNKNOWN_63 = 79,
  UNKNOWN_64 = 80,
  UNKNOWN_65 = 81,
  UNKNOWN_66 = 82,
  UNKNOWN_67 = 83,
  UNKNOWN_68 = 84,
  UNKNOWN_69 = 85,
  UNKNOWN_70 = 86,
  UNKNOWN_71 = 87,
  UNKNOWN_72 = 88,
  UNKNOWN_73 = 89,
  UNKNOWN_74 = 90,
  UNKNOWN_75 = 91,
  UNKNOWN_76 = 92,
  UNKNOWN_77 = 93,
  UNKNOWN_78 = 94,
  UNKNOWN_79 = 95,
  UNKNOWN_80 = 96,
  UNKNOWN_81 = 97,
  UNKNOWN_82 = 98,
  UNKNOWN_83 = 99,
  UNKNOWN_84 = 100,
  UNKNOWN_85 = 101,
  UNKNOWN_86 = 102,
  UNKNOWN_87 = 103,
  UNKNOWN_88 = 104,
  UNKNOWN_89 = 105,
  UNKNOWN_90 = 106,
  UNKNOWN_91 = 107,
  UNKNOWN_92 = 108,
  UNKNOWN_93 = 109,
  UNKNOWN_94 = 110,
  UNKNOWN_95 = 111,
  UNKNOWN_96 = 112,
  UNKNOWN_97 = 113,
  UNKNOWN_98 = 114,
  UNKNOWN_99 = 115,
  UNKNOWN_100 = 116,
}

struct TBinlog {
    1: optional i64 commit_seq
    2: optional i64 timestamp
    3: optional TBinlogType type
    4: optional i64 db_id
    5: optional list<i64> table_ids
    6: optional string data
    7: optional i64 belong  // belong == -1 if type is not DUMMY
    8: optional i64 table_ref // only use for gc
    9: optional bool remove_enable_cache
}

struct TGetBinlogResult {
    1: optional Status.TStatus status
    2: optional i64 next_commit_seq
    3: optional list<TBinlog> binlogs
    4: optional string fe_version
    5: optional i64 fe_meta_version
    6: optional Types.TNetworkAddress master_address
}

struct TGetTabletReplicaInfosRequest {
    1: required list<i64> tablet_ids
    2: optional i64 warm_up_job_id
}

struct TGetTabletReplicaInfosResult {
    1: optional Status.TStatus status
    2: optional map<i64, list<Types.TReplicaInfo>> tablet_replica_infos
    3: optional string token
}

enum TSnapshotType {
    REMOTE = 0,
    LOCAL  = 1,
}

struct TGetSnapshotRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional string table
    6: optional string token
    7: optional string label_name
    8: optional string snapshot_name
    9: optional TSnapshotType snapshot_type
    10: optional bool enable_compress;
}

struct TGetSnapshotResult {
    1: optional Status.TStatus status
    2: optional binary meta
    3: optional binary job_info
    4: optional Types.TNetworkAddress master_address
    5: optional bool compressed;
    6: optional i64 expiredAt;  // in millis
    7: optional i64 commit_seq;
}

struct TTableRef {
    1: optional string table
    3: optional string alias_name
}

struct TRestoreSnapshotRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string db
    5: optional string table
    6: optional string token
    7: optional string label_name
    8: optional string repo_name
    9: optional list<TTableRef> table_refs
    10: optional map<string, string> properties
    11: optional binary meta
    12: optional binary job_info
    13: optional bool clean_tables
    14: optional bool clean_partitions
    15: optional bool atomic_restore
    16: optional bool compressed;
    17: optional bool force_replace
}

struct TRestoreSnapshotResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TGetMasterTokenRequest {
    1: optional string cluster
    2: optional string user
    3: optional string password
}

struct TGetMasterTokenResult {
    1: optional Status.TStatus status
    2: optional string token
    3: optional Types.TNetworkAddress master_address
}

typedef TGetBinlogRequest TGetBinlogLagRequest

struct TGetBinlogLagResult {
    1: optional Status.TStatus status
    2: optional i64 lag
    3: optional Types.TNetworkAddress master_address
    4: optional i64 first_commit_seq
    5: optional i64 last_commit_seq
    6: optional i64 first_binlog_timestamp
    7: optional i64 last_binlog_timestamp
    8: optional i64 next_commit_seq
    9: optional i64 next_binlog_timestamp
}

struct TUpdateFollowerStatsCacheRequest {
    1: optional string key;
    2: optional list<string> statsRows;
    3: optional string colStatsData;
}

struct TUpdatePlanStatsCacheRequest {
    1: optional string key;
    2: optional string planStatsData;
}

struct TInvalidateFollowerStatsCacheRequest {
    1: optional string key;
}

struct TUpdateFollowerPartitionStatsCacheRequest {
    1: optional string key;
}

struct TAutoIncrementRangeRequest {
    1: optional i64 db_id;
    2: optional i64 table_id;
    3: optional i64 column_id;
    4: optional i64 length
    5: optional i64 lower_bound // if set, values in result range must larger than `lower_bound`
}

struct TAutoIncrementRangeResult {
    1: optional Status.TStatus status
    2: optional i64 start
    3: optional i64 length
    4: optional Types.TNetworkAddress master_address
}

struct TMaxComputeBlockIdRequest {
    1: optional i64 txn_id
    2: optional string write_session_id
    3: optional i64 length
}

struct TMaxComputeBlockIdResult {
    1: optional Status.TStatus status
    2: optional i64 start
    3: optional i64 length
    4: optional Types.TNetworkAddress master_address
}

struct TCreatePartitionRequest {
    1: optional i64 txn_id
    2: optional i64 db_id
    3: optional i64 table_id
    // for each partition column's partition values. [missing_rows, partition_keys]->Left bound(for range) or Point(for list)
    4: optional list<list<Exprs.TNullableStringLiteral>> partitionValues
    // be_endpoint = <ip>:<heartbeat_port> to distinguish a particular BE
    5: optional string be_endpoint
    6: optional bool write_single_replica = false
    // query_id to identify the coordinator, if coordinator exists, it means this is a multi-instance load
    7: optional Types.TUniqueId query_id
}

struct TCreatePartitionResult {
    1: optional Status.TStatus status
    2: optional list<Descriptors.TOlapTablePartition> partitions
    3: optional list<Descriptors.TTabletLocation> tablets
    4: optional list<Descriptors.TNodeInfo> nodes
    5: optional list<Descriptors.TTabletLocation> slave_tablets
}

// these two for auto detect replacing partition
struct TReplacePartitionRequest {
    1: optional i64 overwrite_group_id
    2: optional i64 db_id
    3: optional i64 table_id
    4: optional list<i64> partition_ids // partition to replace.
    // be_endpoint = <ip>:<heartbeat_port> to distinguish a particular BE
    5: optional string be_endpoint
    6: optional bool write_single_replica = false
    7: optional Types.TUniqueId query_id
}

struct TReplacePartitionResult {
    1: optional Status.TStatus status
    2: optional list<Descriptors.TOlapTablePartition> partitions
    3: optional list<Descriptors.TTabletLocation> tablets
    4: optional list<Descriptors.TNodeInfo> nodes
    5: optional list<Descriptors.TTabletLocation> slave_tablets
}

struct TGetMetaReplica {
    1: optional i64 id
}

struct TGetMetaTablet {
    1: optional i64 id
    2: optional list<TGetMetaReplica> replicas
}

struct TGetMetaIndex {
    1: optional i64 id
    2: optional string name
    3: optional list<TGetMetaTablet> tablets
}

struct TGetMetaPartition {
    1: optional i64 id
    2: optional string name
    3: optional string key
    4: optional string range
    5: optional bool is_temp
    6: optional list<TGetMetaIndex> indexes
}

struct TGetMetaTable {
    1: optional i64 id
    2: optional string name
    3: optional bool in_trash
    4: optional list<TGetMetaPartition> partitions
}

struct TGetMetaDB {
    1: optional i64 id
    2: optional string name
    3: optional bool only_table_names
    4: optional list<TGetMetaTable> tables
}

struct TGetMetaRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string user_ip
    5: optional string token
    6: optional TGetMetaDB db
    // trash
}

struct TGetMetaReplicaMeta {
    1: optional i64 id
    2: optional i64 backend_id
    3: optional i64 version
}

struct TGetMetaTabletMeta {
    1: optional i64 id
    2: optional list<TGetMetaReplicaMeta> replicas
}

struct TGetMetaIndexMeta {
    1: optional i64 id
    2: optional string name
    3: optional list<TGetMetaTabletMeta> tablets
}

struct TGetMetaPartitionMeta {
    1: optional i64 id
    2: optional string name
    3: optional string key
    4: optional string range
    5: optional i64 visible_version
    6: optional bool is_temp
    7: optional list<TGetMetaIndexMeta> indexes
}

struct TGetMetaTableMeta {
    1: optional i64 id
    2: optional string name
    3: optional bool in_trash
    4: optional list<TGetMetaPartitionMeta> partitions
    5: optional string type
}

struct TGetMetaDBMeta {
    1: optional i64 id
    2: optional string name
    3: optional list<TGetMetaTableMeta> tables
    4: optional list<i64> dropped_partitions    // DEPRECATED
    5: optional list<i64> dropped_tables        // DEPRECATED
    6: optional list<i64> dropped_indexes       // DEPRECATED
    7: optional map<i64, i64> dropped_partition_map     // id -> commit seq
    8: optional map<i64, i64> dropped_table_map         // id -> commit seq
    9: optional map<i64, i64> dropped_index_map         // id -> commit seq
}

struct TGetMetaResult {
    1: required Status.TStatus status
    2: optional TGetMetaDBMeta db_meta
    3: optional Types.TNetworkAddress master_address
}

struct TGetBackendMetaRequest {
    1: optional string cluster
    2: optional string user
    3: optional string passwd
    4: optional string user_ip
    5: optional string token
    6: optional i64 backend_id
}

struct TGetBackendMetaResult {
    1: required Status.TStatus status
    2: optional list<Types.TBackend> backends
    3: optional Types.TNetworkAddress master_address
}

struct TColumnInfo {
  1: optional string column_name
  2: optional i64 column_id
}

struct TGetColumnInfoRequest {
    1: optional i64 db_id
    2: optional i64 table_id
}

struct TGetColumnInfoResult {
    1: optional Status.TStatus status
    2: optional list<TColumnInfo> columns
}

struct TShowProcessListRequest {
    1: optional bool show_full_sql
    2: optional Types.TUserIdentity current_user_ident
    3: optional string time_zone
    // Reserved for downstream field `current_roles` to keep thrift field ids
    // wire-compatible across maintained branches. Do not reuse this id.
    4: optional set<string> reserved_field_4
}

struct TShowProcessListResult {
    1: optional list<list<string>> process_list
}

struct TShowUserRequest {
}

struct TShowUserResult {
    1: optional list<list<string>> userinfo_list
}

struct TReportCommitTxnResultRequest {
    1: optional i64 dbId
    2: optional i64 txnId
    3: optional string label
    4: optional binary payload
    // tablets which need to update stats
    5: optional list<i64> tabletIds
}

struct TQueryColumn {
    1: optional string catalogId
    2: optional string dbId
    3: optional string tblId
    4: optional string colName
}

struct TSyncQueryColumns {
    1: optional list<TQueryColumn> highPriorityColumns;
    2: optional list<TQueryColumn> midPriorityColumns;
}

struct TFetchSplitBatchRequest {
    1: optional i64 split_source_id
    2: optional i32 max_num_splits
}

struct TFetchSplitBatchResult {
    1: optional list<Planner.TScanRangeLocations> splits
    2: optional Status.TStatus status
}

struct TFetchRunningQueriesResult {
    1: optional Status.TStatus status
    2: optional list<Types.TUniqueId> running_queries
}

struct TFetchRunningQueriesRequest {
}

struct TFetchRoutineLoadJobRequest {
}

struct TRoutineLoadJob {
    1: optional string job_id
    2: optional string job_name
    3: optional string create_time
    4: optional string pause_time
    5: optional string end_time
    6: optional string db_name
    7: optional string table_name
    8: optional string state
    9: optional string current_task_num
    10: optional string job_properties
    11: optional string data_source_properties
    12: optional string custom_properties
    13: optional string statistic
    14: optional string progress
    15: optional string lag
    16: optional string reason_of_state_changed
    17: optional string error_log_urls
    18: optional string user_name
    19: optional i32 current_abort_task_num
    20: optional bool is_abnormal_pause
    21: optional string compute_group
}

struct TFetchRoutineLoadJobResult {
    1: optional list<TRoutineLoadJob> routineLoadJobs
}

struct TFetchLoadJobRequest {
}

struct TLoadJob {
    1: optional string job_id
    2: optional string label
    3: optional string state
    4: optional string progress
    5: optional string type
    6: optional string etl_info
    7: optional string task_info
    8: optional string error_msg
    9: optional string create_time
    10: optional string etl_start_time
    11: optional string etl_finish_time
    12: optional string load_start_time
    13: optional string load_finish_time
    14: optional string url
    15: optional string job_details
    16: optional string transaction_id
    17: optional string error_tablets
    18: optional string user
    19: optional string comment
    20: optional string first_error_msg
}

struct TFetchLoadJobResult {
    1: optional list<TLoadJob> loadJobs
}

struct TPlanNodeRuntimeStatsItem {
    // node_id means PlanNodeId, add this field so that we can merge RuntimeProfile of same node more easily
    1: optional i32 node_id
    2: optional i64 input_rows
    3: optional i64 output_rows
    4: optional i64 common_filter_rows
    5: optional i64 common_filter_input_rows
    6: optional i64 runtime_filter_rows
    7: optional i64 runtime_filter_input_rows
    8: optional i64 join_builder_rows
    9: optional i64 join_probe_rows
    10: optional i32 join_builder_skew_ratio
    11: optional i32 join_prober_skew_ratio
    12: optional i32 instance_num
}

enum TEncryptionKeyType {
    MASTER_KEY = 0,
    DATA_KEY = 1,
}

struct TEncryptionKey {
    1: optional binary key_pb;
}

struct TGetEncryptionKeysRequest {
    2: optional i32 version
}

struct TGetEncryptionKeysResult {
    1: optional Status.TStatus status
    2: optional list<TEncryptionKey> master_keys
}

struct TGetTableTDEInfoRequest {
    1: optional i64 db_id
    2: optional i64 table_id
}

struct TGetTableTDEInfoResult {
    1: optional Status.TStatus status
    2: optional AgentService.TEncryptionAlgorithm algorithm
}

struct TPartitionMeta {
    1: optional i64 id
    2: optional i64 visible_version
    3: optional i64 visible_version_time
    4: optional string meta_checksum
}

struct TGetOlapTableMetaRequest {
    1: required string user
    2: required string passwd
    3: required string db
    4: required string table
    5: required i64 table_id
    6: optional i32 version // todo serialize according to the version
    7: optional list<TPartitionMeta> partitions // client owned partition meta
    8: optional list<TPartitionMeta> temp_partitions // client owned partition meta
}

struct TGetOlapTableMetaResult {
    1: required Status.TStatus status
    2: required binary table_meta
    3: optional list<binary> updated_partitions
    4: optional list<i64> removed_partitions
    5: optional list<binary> updated_temp_partitions
    6: optional list<i64> removed_temp_partitions
    7: optional list<string> updated_partition_checksums
    8: optional list<string> updated_temp_partition_checksums
}

// Remote transaction request and Result definitions for cross-cluster export.
// These structs are used by beginRemoteTxn/commitRemoteTxn/abortRemoteTxn RPCs.
struct TBeginRemoteTxnRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional string label
    8: optional i64 timeout_ms
}

struct TBeginRemoteTxnResult {
    1: optional Status.TStatus status
    2: optional i64 txn_id
    3: optional Types.TNetworkAddress master_address
}

struct TCommitRemoteTxnRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional i64 txn_id
    8: optional list<Types.TTabletCommitInfo> commit_infos
    9: optional i64 insert_visible_timeout_ms
}

struct TCommitRemoteTxnResult {
    1: optional Status.TStatus status
    2: optional bool txn_status
    3: optional Types.TNetworkAddress master_address
}

struct TAbortRemoteTxnRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional i64 txn_id
    7: optional string reason
    8: optional Types.TNetworkAddress master_address
}

struct TAbortRemoteTxnResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TAddOrDropPartitionsRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional list<string> partition_names
    8: optional list<string> temp_partition_names
    9: optional bool is_drop
    10: optional bool is_temp
    11: optional bool is_force
}

struct TAddOrDropPartitionsResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TReplacePartitionsRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional list<string> partition_names
    8: optional list<string> temp_partition_names
    9: optional bool is_force
}

struct TReplacePartitionsResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TInsertOverwriteRegisterRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional i64 group_id
    8: optional i64 task_id
    9: optional list<string> partition_names
}

struct TInsertOverwriteRegisterResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
    3: optional i64 task_id
    4: optional i64 group_id
}

struct TInsertOverwriteTaskRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional i64 group_id
    8: optional i64 task_id
    9: optional bool is_success
    10: optional bool force_drop_partition
}

struct TInsertOverwriteTaskResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TInsertOverwriteRecordRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional bool is_add
}

struct TInsertOverwriteRecordResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TRecordFinishedLoadJobRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
    4: optional string catalog
    5: optional string db
    6: optional string tbl
    7: optional string label
    8: optional i64 txn_id
    9: optional i64 create_ts
    10: optional string fail_msg
    11: optional string first_err_msg
    12: optional string tracking_url
    13: optional i64 job_id
}
struct TRecordFinishedLoadJobResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TMasterAddressRequest {
    1: optional string user
    2: optional string passwd
    3: optional string token
}

struct TMasterAddressResult {
    1: optional Status.TStatus status
    2: optional Types.TNetworkAddress master_address
}

struct TSyncCloudTabletStatsRequest {
    1: optional binary tablet_stats_pb
}

service FrontendService {
    TGetDbsResult getDbNames(1: TGetDbsParams params)
    TGetTablesResult getTableNames(1: TGetTablesParams params)
    TDescribeTablesResult describeTables(1: TDescribeTablesParams params)
    TShowVariableResult showVariables(1: TShowVariableRequest params)
    TReportExecStatusResult reportExecStatus(1: TReportExecStatusParams params)

    MasterService.TMasterResult finishTask(1: MasterService.TFinishTaskRequest request)
    MasterService.TMasterResult report(1: MasterService.TReportRequest request)
    // Deprecated
    MasterService.TFetchResourceResult fetchResource()

    TMasterOpResult forward(1: TMasterOpRequest params)

    TListTableStatusResult listTableStatus(1: TGetTablesParams params)
    TListTableMetadataNameIdsResult listTableMetadataNameIds(1: TGetTablesParams params)
    TListPrivilegesResult listTablePrivilegeStatus(1: TGetTablesParams params)
    TListPrivilegesResult listSchemaPrivilegeStatus(1: TGetTablesParams params)
    TListPrivilegesResult listUserPrivilegeStatus(1: TGetTablesParams params)

    TLoadTxnBeginResult loadTxnBegin(1: TLoadTxnBeginRequest request)
    TLoadTxnCommitResult loadTxnPreCommit(1: TLoadTxnCommitRequest request)
    TLoadTxn2PCResult loadTxn2PC(1: TLoadTxn2PCRequest request)
    TLoadTxnCommitResult loadTxnCommit(1: TLoadTxnCommitRequest request)
    TLoadTxnRollbackResult loadTxnRollback(1: TLoadTxnRollbackRequest request)

    TBeginTxnResult beginTxn(1: TBeginTxnRequest request)
    TCommitTxnResult commitTxn(1: TCommitTxnRequest request)
    TRollbackTxnResult rollbackTxn(1: TRollbackTxnRequest request)

    // Remote transaction RPCs for cross-cluster export.
    TBeginRemoteTxnResult beginRemoteTxn(1: TBeginRemoteTxnRequest request)
    TCommitRemoteTxnResult commitRemoteTxn(1: TCommitRemoteTxnRequest request)
    TAbortRemoteTxnResult abortRemoteTxn(1: TAbortRemoteTxnRequest request)

    TGetBinlogResult getBinlog(1: TGetBinlogRequest request)
    TGetSnapshotResult getSnapshot(1: TGetSnapshotRequest request)
    TRestoreSnapshotResult restoreSnapshot(1: TRestoreSnapshotRequest request)
    TLockBinlogResult lockBinlog(1: TLockBinlogRequest request)

    TWaitingTxnStatusResult waitingTxnStatus(1: TWaitingTxnStatusRequest request)

    TStreamLoadPutResult streamLoadPut(1: TStreamLoadPutRequest request)

    TStreamLoadMultiTablePutResult streamLoadMultiTablePut(1: TStreamLoadPutRequest request)

    Status.TStatus snapshotLoaderReport(1: TSnapshotLoaderReportRequest request)

    TFrontendReportAliveSessionResult getAliveSessions(1: TFrontendReportAliveSessionRequest request)

    TFrontendPingFrontendResult ping(1: TFrontendPingFrontendRequest request)

    Status.TStatus syncCloudVersion(1: TFrontendSyncCloudVersionRequest request)

    TInitExternalCtlMetaResult initExternalCtlMeta(1: TInitExternalCtlMetaRequest request)

    TFetchSchemaTableDataResult fetchSchemaTableData(1: TFetchSchemaTableDataRequest request)

    TMySqlLoadAcquireTokenResult acquireToken()

    bool checkToken(1: string token)

    TConfirmUnusedRemoteFilesResult confirmUnusedRemoteFiles(1: TConfirmUnusedRemoteFilesRequest request)

    TCheckAuthResult checkAuth(1: TCheckAuthRequest request)

    TQueryStatsResult getQueryStats(1: TGetQueryStatsRequest request)

    TGetTabletReplicaInfosResult getTabletReplicaInfos(1: TGetTabletReplicaInfosRequest request)

    TGetMasterTokenResult getMasterToken(1: TGetMasterTokenRequest request)

    TGetBinlogLagResult getBinlogLag(1: TGetBinlogLagRequest request)

    Status.TStatus updateStatsCache(1: TUpdateFollowerStatsCacheRequest request)
    
    Status.TStatus updatePlanStatsCache(1: TUpdatePlanStatsCacheRequest request)

    TAutoIncrementRangeResult getAutoIncrementRange(1: TAutoIncrementRangeRequest request)
    TMaxComputeBlockIdResult getMaxComputeBlockIdRange(1: TMaxComputeBlockIdRequest request)

    TCreatePartitionResult createPartition(1: TCreatePartitionRequest request)
    // insert overwrite partition(*)
    TReplacePartitionResult replacePartition(1: TReplacePartitionRequest request)

    TGetMetaResult getMeta(1: TGetMetaRequest request)

    TGetBackendMetaResult getBackendMeta(1: TGetBackendMetaRequest request)

    TGetColumnInfoResult getColumnInfo(1: TGetColumnInfoRequest request)

    Status.TStatus invalidateStatsCache(1: TInvalidateFollowerStatsCacheRequest request)

    TShowProcessListResult showProcessList(1: TShowProcessListRequest request)
    Status.TStatus reportCommitTxnResult(1: TReportCommitTxnResultRequest request)
    TShowUserResult showUser(1: TShowUserRequest request)
    Status.TStatus syncQueryColumns(1: TSyncQueryColumns request)

    TFetchSplitBatchResult fetchSplitBatch(1: TFetchSplitBatchRequest request)
    Status.TStatus updatePartitionStatsCache(1: TUpdateFollowerPartitionStatsCacheRequest request)

    TFetchRunningQueriesResult fetchRunningQueries(1: TFetchRunningQueriesRequest request)

    TFetchRoutineLoadJobResult fetchRoutineLoadJob(1: TFetchRoutineLoadJobRequest request)

    TFetchLoadJobResult fetchLoadJob(1: TFetchLoadJobRequest request)

    TGetEncryptionKeysResult getEncryptionKeys(1: TGetEncryptionKeysRequest request)

    TGetTableTDEInfoResult getTableTDEInfo(1: TGetTableTDEInfoRequest request)

    TGetOlapTableMetaResult getOlapTableMeta(1: TGetOlapTableMetaRequest request)

    TMasterAddressResult getMasterAddress(1: TMasterAddressRequest request)

    TAddOrDropPartitionsResult addOrDropPartitions(1: TAddOrDropPartitionsRequest request)
    TReplacePartitionsResult replacePartitions(1: TReplacePartitionsRequest request)

    TInsertOverwriteRegisterResult registerInsertOverwriteTask(1: TInsertOverwriteRegisterRequest request)
    TInsertOverwriteTaskResult insertOverwriteTaskAction(1: TInsertOverwriteTaskRequest request)
    TInsertOverwriteRecordResult addOrDropInsertOverwriteRecord(1: TInsertOverwriteRecordRequest request)

    TRecordFinishedLoadJobResult recordFinishedLoadJobRequest(1: TRecordFinishedLoadJobRequest request)

    Status.TStatus syncCloudTabletStats(1: TSyncCloudTabletStatsRequest request)
}