gensrc/proto/cloud.proto

// 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.

syntax="proto2";

package doris.cloud;
option java_package = "org.apache.doris.cloud.proto";

import "olap_file.proto";

option cc_generic_services = true;

//==============================================================================
// Resources
//==============================================================================

message EncryptionInfoPB {
    optional string encryption_method = 1;
    optional int64 key_id = 2;
}

message EncryptionKeyInfoPB {
    message KMSInfo {
        optional string endpoint = 1;
        optional string region = 2;
        optional string cmk = 3;
    }
    message Item {
        optional int64 key_id = 1;
        optional string key = 2;
        optional KMSInfo kms_info = 3;
    }
    repeated Item items = 1;
}

message RamUserPB {
    optional string user_id = 1;
    optional string ak = 2;
    optional string sk = 3;
    optional string external_id = 4;
    optional EncryptionInfoPB encryption_info = 6;
}

enum MultiVersionStatus {
    MULTI_VERSION_DISABLED = 0;     // write/read single version
    MULTI_VERSION_WRITE_ONLY = 1;   // write both single/multi version, but read single version
    MULTI_VERSION_READ_WRITE = 2;   // write both single/multi version, but read multi version
    MULTI_VERSION_ENABLED = 3;      // write/read multi version
}

enum SnapshotSwitchStatus {
    SNAPSHOT_SWITCH_DISABLED = 0; // This instance is not ready to enable the snapshot.
    SNAPSHOT_SWITCH_OFF = 1;
    SNAPSHOT_SWITCH_ON = 2;
}

enum SnapshotCompactStatus {
    SNAPSHOT_COMPACT_UNKNOWN = 0;
    SNAPSHOT_COMPACT_DOING = 1;
    SNAPSHOT_COMPACT_DONE = 2;
}

enum KeySetType {
    UNKNOWN_KEY_SET = 0;

    // Single version keys
    SINGLE_VERSION_PARTITION_VERSION = 1;
    SINGLE_VERSION_TABLE_VERSION = 2;
    SINGLE_VERSION_META_ROWSET = 3;
    SINGLE_VERSION_META_TABLET = 4;
    SINGLE_VERSION_META_SCHEMA = 5;
    SINGLE_VERSION_TABLET_STATS = 6;
    SINGLE_VERSION_TABLET_INDEX = 7;

    // Multi version keys
    MULTI_VERSION_PARTITION_VERSION = 10;
    MULTI_VERSION_TABLE_VERSION = 12;
    MULTI_VERSION_INDEX_PARTITION = 13;
    MULTI_VERSION_INDEX_INDEX = 14;
    MULTI_VERSION_INDEX_TABLET = 15;
    MULTI_VERSION_TABLET_STATS = 16;
    MULTI_VERSION_META_PARTITION = 17;
    MULTI_VERSION_META_INDEX = 18;
    MULTI_VERSION_META_TABLET = 19;
    MULTI_VERSION_META_SCHEMA = 20;
    MULTI_VERSION_META_ROWSET = 21;
}

message InstanceInfoPB {
    enum Status {
        NORMAL = 0;
        DELETED = 1;
        OVERDUE = 2;
    }
    optional string user_id = 1;
    optional string instance_id = 2;
    optional string name = 3;
    repeated string lb_ip = 4;
    optional int64 ctime = 5;
    optional int64 mtime = 6;
    repeated ClusterPB clusters = 7;
    repeated ObjectStoreInfoPB obj_info = 8; // Only legacy obj info would be store in this fields, other objs would be lied in vaults.
    repeated StagePB stages = 9;
    optional Status status = 10;
    optional RamUserPB ram_user = 11;
    optional RamUserPB iam_user = 12;
    optional bool sse_enabled = 13;

    repeated string resource_ids = 100;
    repeated string storage_vault_names = 101;
    optional string default_storage_vault_id = 102;
    optional string default_storage_vault_name = 103;
    optional bool enable_storage_vault = 104;

    // For snapshot
    optional MultiVersionStatus multi_version_status = 110;
    optional SnapshotSwitchStatus snapshot_switch_status = 111;
    optional string source_instance_id = 112;   // The instance cloned from (the snapshot instance id).
    optional string source_snapshot_id = 113;   // The snapshot cloned from.

    // Inherited from which instance (only used during rollback, the earliest instance id).
    optional string original_instance_id = 114;
    optional string successor_instance_id = 115;  // The last heir (only used during rollback).
    optional bool ready_only = 116;             // A read only instance.

    // Snapshot properties.
    optional int64 max_reserved_snapshot = 117;
    optional int64 snapshot_interval_seconds = 118;

    repeated KeySetType migrated_key_sets = 119;    // convert single version keys to multi version keys
    repeated KeySetType compacted_key_sets = 120;   // compact snapshot chain ...

    optional int64 snapshot_retained_data_size = 121;
    optional int64 snapshot_billable_data_size = 122;
    optional SnapshotCompactStatus snapshot_compact_status = 123;

    // The instance that is being rolled back, only used during rollback.
    // It is not always same as source_instance_id, because the source instance may inherit from another
    // instance during rollback, and the predecessor instance is the real instance which to execute the rollback.
    optional string predecessor_instance_id = 124;
}

message StagePB {
    enum StageType {
        INTERNAL = 0;
        EXTERNAL = 1;
    }
    optional StageType type = 1;
    // mysql user name and id only used for internal stage
    repeated string mysql_user_name = 2;
    // external stage name
    optional string name = 3;
    optional ObjectStoreInfoPB obj_info = 6;
    optional string stage_id = 7;
    // file and copy properties
    map<string, string> properties = 8;
    repeated string mysql_user_id = 9;
    optional string comment = 10;
    optional int64 create_time = 11;
    enum StageAccessType {
        UNKNOWN = 0;
        AKSK = 1;
        IAM = 2;
        BUCKET_ACL = 3;
    }
    optional StageAccessType access_type = 12 [default = AKSK];
    // used when access_type is IAM
    // In OBS, role name is agency name, arn is domain name.
    optional string role_name = 13;
    optional string arn = 14;
    // only used for aws
    optional string external_id = 15;
}

enum ClusterStatus {
    UNKNOWN = 0;
    NORMAL = 1;
    SUSPENDED = 2;
    TO_RESUME = 3;
    MANUAL_SHUTDOWN = 4;
}

// just for virtual cluster
message ClusterPolicy {
    enum PolicyType {
        ActiveStandby = 0;
    }
    optional PolicyType type = 1;
    optional string active_cluster_name = 2;
    repeated string standby_cluster_names = 3;
    optional int64 failover_failure_threshold = 4;
    optional int64 unhealthy_node_threshold_percent = 5;
    repeated string cache_warmup_jobids = 6;
}

message ClusterPB {
    enum Type {
        SQL = 0;
        COMPUTE = 1;
        VIRTUAL = 2;
    }
    optional string cluster_id = 1;
    optional string cluster_name = 2;
    optional Type type = 3;
    optional string desc = 4;
    repeated NodeInfoPB nodes = 5;
    repeated string mysql_user_name = 6;
    optional string public_endpoint = 7;
    optional string private_endpoint = 8;
    optional ClusterStatus cluster_status = 9;
    optional int64 ctime = 10;
    optional int64 mtime = 11;
    repeated string cluster_names = 12; // clusters in virtual cluster
    optional ClusterPolicy cluster_policy = 13; // virtual cluster policy
    map<string, string> properties = 14; // clsuter additional properties
}

message NodeInfoPB {
    enum NodeType {
        UNKNOWN = 0;
        // lagacy logic for one-master-multi-observer mode
        FE_MASTER = 1;
        FE_OBSERVER = 2;
        FE_FOLLOWER = 3;
    }
    optional string cloud_unique_id = 1;
    optional string name = 2;
    optional string ip = 3;
    optional string vpc_name = 4;
    optional int64 ctime = 5;
    optional int64 mtime = 6;
    optional NodeStatusPB status = 7;
    // There may be other ports, just add new fields in need
    optional int32 heartbeat_port = 8;
    optional string desc = 9;
    optional int32 edit_log_port = 10;
    optional NodeType node_type = 11;
    optional bool is_smooth_upgrade = 12;
    // fqdn
    optional string host = 13;
    optional string public_endpoint = 14;
    optional string private_endpoint = 15;
}

enum NodeStatusPB {
    NODE_STATUS_UNKNOWN = 0;
    NODE_STATUS_RUNNING = 1;
    NODE_STATUS_SHUTDOWN = 2;
    NODE_STATUS_DECOMMISSIONING = 3;
    NODE_STATUS_DECOMMISSIONED = 4;
}

enum CredProviderTypePB {
    // used for creating different credentials provider when creating s3client
    DEFAULT = 1;    // DefaultAWSCredentialsProviderChain
    SIMPLE = 2;     // SimpleAWSCredentialsProvider, corresponding to (ak, sk)
    INSTANCE_PROFILE = 3;  // InstanceProfileCredentialsProvider
    ENV = 4;  // EnvironmentAWSCredentialsProvider
    SYSTEM_PROPERTIES = 5;  // SystemPropertiesCredentialsProvider
    WEB_IDENTITY = 6;  // STSAssumeRoleWebIdentityCredentialsProvider
    CONTAINER = 7;  // TaskRoleCredentialsProvider
    ANONYMOUS = 8;  // AnonymousAWSCredentialsProvider
}

message ObjectStoreInfoPB {
    // presigned url use
    // oss,aws,cos,obs,bos
    enum Provider {
        UNKONWN = -1;
        OSS     = 0;
        S3      = 1;
        COS     = 2;
        OBS     = 3;
        BOS     = 4;
        GCP     = 5;
        AZURE   = 6;
        TOS     = 7;
    }
    optional int64 ctime = 1;
    optional int64 mtime = 2;
    optional string id = 3;
    optional string ak = 4;
    optional string sk = 5;
    optional string bucket = 6;
    optional string prefix = 7;
    optional string endpoint = 8;
    optional string region = 9;
    optional Provider provider = 10;
    optional string external_endpoint = 11;
    optional string user_id = 13;
    optional EncryptionInfoPB encryption_info = 14;
    optional bool sse_enabled = 15;
    optional bool use_path_style = 16;

    optional CredProviderTypePB cred_provider_type = 17;
    optional string role_arn = 18;  // aws assumed role's arn
    optional string external_id = 19;  // aws assumed role's external_id if configure
}

// The legacy ObjectStoreInfoPB is stored in InstanceInfoPB
message StorageVaultPB {
    optional string id = 1;
    optional string name = 2;
    optional HdfsVaultInfo hdfs_info = 3; // HdfsResource
    optional ObjectStoreInfoPB obj_info = 4;

    message PathFormat {
        optional int64 path_version = 1;
        optional int64 shard_num = 2;
    }

    optional PathFormat path_format = 5;
    // Set this filed when the user tries to alter name to alter_name
    optional string alter_name = 6;
}

message HdfsBuildConf {
    message HdfsConfKVPair {
        required string key = 1;
        required string value = 2;
    }
    optional string fs_name = 1; // name_node
    optional string user = 2;
    optional string hdfs_kerberos_principal = 3;
    optional string hdfs_kerberos_keytab = 4;
    repeated HdfsConfKVPair hdfs_confs = 5;
}

message HdfsVaultInfo {
    optional HdfsBuildConf build_conf = 1;
    optional string prefix = 2;
}

//==============================================================================
// Transaction persistence
//==============================================================================

// Wire format for UniqueId
message UniqueIdPB {
  optional int64 hi = 1;
  optional int64 lo = 2;
}

// ATTN: keep the values the same as
//       org.apache.doris.transaction.TransactionState.TxnSourceType
enum TxnSourceTypePB {
    UKNOWN_TXN_SOURCE_TYPE = 0;
    TXN_SOURCE_TYPE_FE     = 1;
    TXN_SOURCE_TYPE_BE     = 2;
}

// ATTN: keep the same values as
//       org.apache.doris.transaction.TransactionState.LoadJobSourceType
enum LoadJobSourceTypePB {
    LOAD_JOB_SRC_TYPE_UNKNOWN           = 0;
    LOAD_JOB_SRC_TYPE_FRONTEND          = 1;
    LOAD_JOB_SRC_TYPE_BACKEND_STREAMING = 2; // streaming load use this type
    LOAD_JOB_SRC_TYPE_INSERT_STREAMING  = 3; // insert stmt (streaming type), update stmt use this type
    LOAD_JOB_SRC_TYPE_ROUTINE_LOAD_TASK = 4; // routine load task use this type
    LOAD_JOB_SRC_TYPE_BATCH_LOAD_JOB    = 5; // load job v2 for broker load
    LOAD_JOB_SRC_TYPE_STREAMING_JOB     = 6; // streaming job use this type
}

enum TxnStatusPB {
    TXN_STATUS_UNKNOWN      = 0;
    TXN_STATUS_PREPARED     = 1;
    TXN_STATUS_COMMITTED    = 2;
    TXN_STATUS_VISIBLE      = 3;
    TXN_STATUS_ABORTED      = 4;
    TXN_STATUS_PRECOMMITTED = 5;
}

message TxnCoordinatorPB {
    optional TxnSourceTypePB sourceType = 1;
    optional string ip = 2;
    optional int64 id = 3;
    optional int64 start_time = 4;
}

message RoutineLoadProgressPB {
    map<int32, int64> partition_to_offset = 1;
    optional RoutineLoadJobStatisticPB stat = 2;
}

message RLTaskTxnCommitAttachmentPB {
    optional int64 job_id = 1;
    optional UniqueIdPB task_id = 2;
    optional int64 filtered_rows = 3;
    optional int64 loaded_rows = 4;
    optional int64 unselected_rows = 5;
    optional int64 received_bytes = 6;
    optional int64 task_execution_time_ms = 7;
    optional RoutineLoadProgressPB progress = 8;
    optional string error_log_url = 9;
}

message RoutineLoadJobStatisticPB {
    optional int64 filtered_rows = 1;
    optional int64 loaded_rows = 2;
    optional int64 unselected_rows = 3;
    optional int64 received_bytes = 4;
    optional int64 task_execution_time_ms = 5;
}

message StreamingTaskCommitAttachmentPB {
    optional int64 job_id = 1;
    optional string offset = 2;
    optional int64 scanned_rows = 3;
    optional int64 load_bytes = 4;
    optional int64 num_files = 5;
    optional int64 file_bytes = 6;
    optional int64 filtered_rows = 7;
}

message TxnCommitAttachmentPB {
    enum Type {
        LODD_JOB_FINAL_OPERATION = 0;
        RT_TASK_TXN_COMMIT_ATTACHMENT = 1;
        STREAMING_TASK_TXN_COMMIT_ATTACHMENT = 2;
    }
    message LoadJobFinalOperationPB {
        message EtlStatusPB {
            enum EtlStatePB {
                RUNNING = 0;
                FINISHED = 1;
                CANCELLED = 2;
                UNKNOWN = 3;
            }

            optional EtlStatePB state = 1;
            optional string tracking_url = 2;
            map<string, string> stats = 3;
            map<string, string> counters = 4;
        }

        enum JobStatePB {
            UNKNOWN = 0;
            PENDING = 1;
            ETL = 2;
            LOADING = 3;
            COMMITTED = 4;
            FINISHED = 5;
            CANCELLED = 6;
        }

        message FailMsgPB {
            enum CancelTypePB {
                USER_CANCEL = 0;
                ETL_SUBMIT_FAIL = 1;
                ETL_RUN_FAIL = 2;
                ETL_QUALITY_UNSATISFIED = 3;
                LOAD_RUN_FAIL = 4;
                TIMEOUT = 5;
                UNKNOWN = 6;
                TXN_UNKNOWN =7;
            }
            optional CancelTypePB cancel_type = 1;
            optional string msg = 2;
        }

        optional int64 id = 1;
        optional EtlStatusPB loading_status = 2;
        optional int32 progress = 3;
        optional int64 load_start_timestamp = 4;
        optional int64 finish_timestamp = 5;
        optional JobStatePB job_state = 6;
        optional FailMsgPB fail_msg = 7;
        optional string copy_id = 8;
        optional string load_file_paths = 9;
    }


    optional Type type = 1;
    optional LoadJobFinalOperationPB load_job_final_operation = 2;
    optional RLTaskTxnCommitAttachmentPB rl_task_txn_commit_attachment = 3;
    optional StreamingTaskCommitAttachmentPB streaming_task_txn_commit_attachment = 4;
}

// For storing label -> txn_ids
message TxnLabelPB {
    repeated int64 txn_ids = 1;
}

// txn_id -> db_id
message TxnIndexPB {
    optional TabletIndexPB tablet_index = 1;
    optional int64 parent_txn_id = 2;
}

message TxnInfoPB {
    optional int64 db_id = 1;
    repeated int64 table_ids = 2;
    optional int64 txn_id = 3;
    optional string label = 4;
    optional UniqueIdPB request_id = 5;
    optional TxnCoordinatorPB coordinator = 6;
    optional LoadJobSourceTypePB load_job_source_type = 7;
    optional int64 timeout_ms = 8;
    optional int64 precommit_timeout_ms = 9;
    optional int64 prepare_time = 10;
    optional int64 precommit_time = 11;
    optional int64 commit_time = 12;
    optional int64 finish_time = 13;
    optional string reason = 14;
    optional TxnStatusPB status = 15;
    optional TxnCommitAttachmentPB commit_attachment = 16;
    optional int64 listener_id = 17; //callback id
    // for transaction load, used for recycler
    repeated int64 sub_txn_ids = 18;
    // TODO: There are more fields TBD
    optional bool versioned_write = 19;  // versioned write, don't need to write RecycleTxnPB again
    optional bool versioned_read = 20;  // whether to read versioned keys
    // When enabled, defer deleting pending delete bitmaps until lazy commit completes.
    // This is used for lazy commit to reduce contention during transaction commit.
    // The delete bitmap locks will be extended and removed during lazy commit phase.
    optional bool defer_deleting_pending_delete_bitmaps = 21;
    // The cluster_id of the compute cluster that performed the load
    // Set by FE during begin_txn, used by commit_txn for compaction read-write separation
    optional string load_cluster_id = 22;
}

// For check txn conflict and txn timeout
message TxnRunningPB {
    repeated int64 table_ids = 1;
    //milliseconds
    optional int64 timeout_time = 2;
}

message VersionPB {
    optional int64 version = 1;
    optional int64 update_time_ms = 2;
    // now only allow one element
    repeated int64 pending_txn_ids = 3;
}

message RecycleTxnPB {
    optional int64 creation_time = 1;
    optional string label = 2;
    optional bool immediate = 3; //recycle immediately
}

message RecycleIndexPB {
    enum State {
        UNKNOWN = 0;
        PREPARED = 1;
        DROPPED = 2;
        RECYCLING = 3;
    }
    optional int64 table_id = 1;
    optional int64 creation_time = 2;
    optional int64 expiration = 3; // expiration timestamp
    optional State state = 4;
    optional int64 db_id = 5;
}

message RecyclePartitionPB {
    enum State {
        UNKNOWN = 0;
        PREPARED = 1;
        DROPPED = 2;
        RECYCLING = 3;
    }
    optional int64 table_id = 1;
    repeated int64 index_id = 2;
    optional int64 creation_time = 3;
    optional int64 expiration = 4; // expiration timestamp
    optional State state = 5;
    optional int64 db_id = 6; // For version recycling
}

message RecycleRowsetPB {
    enum Type {
        UNKNOWN = 0;
        PREPARE = 1;
        COMPACT = 2;
        DROP = 3;
    }
    optional int64 tablet_id = 1; // deprecated
    optional string resource_id = 2; // deprecated
    optional int64 creation_time = 3;
    optional int64 expiration = 4; // expiration timestamp
    optional Type type = 5;
    optional doris.RowsetMetaCloudPB rowset_meta = 6;
}

message RecycleStagePB {
    optional string instance_id = 1;
    optional string reason = 2;
    optional StagePB stage = 3;
}

message RestoreJobCloudPB {
    enum State {
        UNKNOWN = 0;
        PREPARED = 1;
        COMMITTED = 2;
        DROPPED = 3;
        COMPLETED = 4;
        RECYCLING = 5;
    }
    optional int64 tablet_id = 1;
    optional int64 ctime_s = 2;
    optional int64 mtime_s = 3;
    optional int64 expired_at_s = 4; // expiration timestamp
    optional doris.TabletMetaCloudPB tablet_meta = 5;
    optional State state = 6;
    optional int64 total_rowset_num = 7;
    optional int64 total_row_num = 8;
    optional int64 total_segment_num = 9;
    optional int64 total_disk_size = 10;
    optional int64 committed_rowset_num = 11;
    optional bool need_recycle_data = 12;
    optional int64 version = 13;
}

message JobRecyclePB {
    enum Status {
        IDLE = 0;
        BUSY = 1;
    }
    optional string instance_id = 1;
    optional string ip_port = 2;
    optional int64 last_ctime_ms = 3;
    optional int64 expiration_time_ms = 4;
    optional int64 last_finish_time_ms = 5;
    optional Status status = 6;
    optional int64 last_success_time_ms = 7;
}

message TabletIndexPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
    optional int64 index_id = 3;
    optional int64 partition_id = 4;
    optional int64 tablet_id = 5;
}

message PartitionIndexPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
}

message IndexIndexPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
}

message TabletMetaInfoPB { // For update tablet meta
    optional int64 tablet_id = 1;
    optional bool is_in_memory = 2; // deprecated
    optional bool is_persistent = 3; // deprecated
    optional int64 ttl_seconds = 4;
    optional int64 group_commit_interval_ms = 5;
    optional int64 group_commit_data_bytes = 6;
    optional string compaction_policy = 7;
    optional int64 time_series_compaction_goal_size_mbytes = 8;
    optional int64 time_series_compaction_file_count_threshold = 9;
    optional int64 time_series_compaction_time_threshold_seconds = 10;
    optional int64 time_series_compaction_empty_rowsets_threshold = 11;
    optional int64 time_series_compaction_level_threshold = 12;
    optional bool disable_auto_compaction = 13;
    optional bool enable_mow_light_delete = 14;
    optional int32 vertical_compaction_num_columns_per_group = 15;
    optional string group_commit_mode = 16;
}

message TabletCompactionJobPB {
    enum CompactionType {
        UNKOWN = 0;
        BASE = 1;
        CUMULATIVE = 2;
        EMPTY_CUMULATIVE = 3; // just update cumulative point
        FULL = 4;
        STOP_TOKEN = 5; // fail existing compactions and deny newly incomming compactions
    }
    // IP and port of the node which initiates this job
    optional string initiator = 1; // prepare
    optional int64 ctime = 2;
    optional int64 mtime = 3;
    optional CompactionType type = 4; // prepare
    optional int64 input_cumulative_point = 5;
    optional int64 output_cumulative_point = 6;
    optional int64 num_input_rowsets = 7;
    optional int64 num_input_segments = 8;
    optional int64 num_output_rowsets = 9;
    optional int64 num_output_segments = 10;
    optional int64 size_input_rowsets = 11;
    optional int64 size_output_rowsets = 12;
    optional int64 num_input_rows = 13;
    optional int64 num_output_rows = 14;
    repeated int64 input_versions = 15;
    repeated int64 output_versions = 16;
    repeated string output_rowset_ids = 17;
    repeated int64 txn_id = 18;
    optional int64 base_compaction_cnt = 19;        // prepare
    optional int64 cumulative_compaction_cnt = 20;  // prepare
    optional string id = 21; // prepare
    // Expiration time, unix timestamp, -1 for no expiration
    optional int64 expiration = 22; // prepare
    // Lease time, unix timestamp
    optional int64 lease = 23; // prepare
    optional int64 delete_bitmap_lock_initiator = 24;
    optional int64 full_compaction_cnt = 25;  // prepare
    optional bool check_input_versions_range = 26;
    optional int64 index_size_input_rowsets = 27;
    optional int64 segment_size_input_rowsets = 28;
    optional int64 index_size_output_rowsets = 29;
    optional int64 segment_size_output_rowsets = 30;
}

message TabletSchemaChangeJobPB {
    // IP and port of the node which initiates this job
    optional string initiator = 1; // prepare
    optional string id = 2; // prepare
    // Expiration time, unix timestamp, -1 for no expiration
    optional int64 expiration = 3; // prepare
    optional TabletIndexPB new_tablet_idx = 4; // prepare
    repeated int64 txn_ids = 5;
    optional int64 alter_version = 6;
    optional int64 num_output_rowsets = 7;
    optional int64 num_output_segments = 8;
    optional int64 size_output_rowsets = 9;
    optional int64 num_output_rows = 10;
    repeated int64 output_versions = 11;
    optional int64 output_cumulative_point = 12;
    optional bool is_inverted_index_change = 13 [default = false];
    optional int64 delete_bitmap_lock_initiator = 14;
    optional int64 index_size_output_rowsets = 15;
    optional int64 segment_size_output_rowsets = 16;
}

message TabletJobInfoPB {
    optional TabletIndexPB idx = 1;
    repeated TabletCompactionJobPB compaction = 4;
    optional TabletSchemaChangeJobPB schema_change = 5;
}

message CompactionLogPB {
    optional int64 tablet_id = 1;
    optional int64 start_version = 2;
    optional int64 end_version = 3; // included, [start, end]
    repeated RecycleRowsetPB recycle_rowsets = 4;
}

message CommitTxnLogPB {
    repeated int64 table_ids = 1;
    map<int64, int64> partition_version_map = 2;
    map<int64, int64> tablet_to_partition_map = 3;

    // for recycle txn key
    optional int64 txn_id = 4;
    optional RecycleTxnPB recycle_txn = 5;
    optional int64 db_id = 6;
}

message SchemaChangeLogPB {
    optional int64 old_tablet_id = 1;
    optional int64 new_tablet_id = 2;
    optional int64 alter_version = 3;
    repeated RecycleRowsetPB recycle_rowsets = 4;
}

message CommitPartitionLogPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
    repeated int64 index_ids = 3;
    repeated int64 partition_ids = 4;
}

message DropPartitionLogPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
    repeated int64 index_ids = 3;
    repeated int64 partition_ids = 4;
    optional int64 expired_at_s = 5; // expiration timestamp
    optional bool update_table_version = 6;

    map<string, int64> index_partition_to_data_size = 7;
}

message CommitIndexLogPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
    repeated int64 index_ids = 3;
    optional bool update_table_version = 4;
    repeated int64 partition_ids = 5;
}

message DropIndexLogPB {
    optional int64 db_id = 1;
    optional int64 table_id = 2;
    repeated int64 index_ids = 3;
    optional int64 expiration = 4; // expiration timestamp

    map<string, int64> index_partition_to_data_size = 5;
}

message UpdateTabletLogPB {
    repeated int64 tablet_ids = 1;
}

message UpdateDeleteBitmapLogPB {
    // TODO
}

// The operation log records which data needs to be recycled.
// If the log is not referenced by any snapshot, the operation log will be recycled.
message OperationLogPB {
    optional uint64 min_timestamp = 1;

    optional CommitTxnLogPB commit_txn = 2;
    optional CompactionLogPB compaction = 3;
    optional SchemaChangeLogPB schema_change = 4;
    optional DropPartitionLogPB drop_partition = 5;
    optional DropIndexLogPB drop_index = 6;
    optional UpdateTabletLogPB update_tablet = 7;
    optional UpdateDeleteBitmapLogPB update_delete_bitmap = 8;
    optional CommitPartitionLogPB commit_partition = 9;
    optional CommitIndexLogPB commit_index = 10;
}

enum SnapshotType {
    // A snapshot references the metadata saved in the TxnKv.
    SNAPSHOT_REFERENCE = 0;
}

enum SnapshotStatus {
    // This snapshot is being prepared.
    SNAPSHOT_PREPARE = 0;
    // This snapshot is ready for serving.
    SNAPSHOT_NORMAL = 1;
    // This snapshot was aborted due to an error.
    SNAPSHOT_ABORTED = 2;
    // This snapshot was recycled.
    SNAPSHOT_RECYCLED = 3;
}

// A cluster snapshot.
message SnapshotPB {
    optional SnapshotStatus status = 1;
    optional SnapshotType type = 2;

    // The image dir in the object store. The FE will upload the FE image to the directory.
    optional string image_url = 3;
    // The last journal id of the image.
    optional int64 last_journal_id = 4;

    optional int64 create_at = 5;
    optional int64 finish_at = 6;

    // The timeout for making snapshots. After the timeout, the snapshot will be marked as aborted.
    optional int64 timeout_seconds = 7;
    // The instance id to which snapshot belongs.
    optional string instance_id = 8;
    // When creating a snapshot, the source snapshot id of the instance (if any)
    optional string snapshot_ancestor = 9;
    // Whether the snapshot was created automatically or manually
    optional bool auto = 10;
    // Snapshot survival time (for manually created snapshots)
    optional int64 ttl_seconds = 11;
    // The abort reason.
    optional string reason = 12;
    // The label of the snapshot, which is not guaranteed to be unique.
    optional string label = 13;

    // The resource id of the object store where snapshot image stored.
    optional string resource_id = 14;

    // record the multipart upload file_name and upload_id, used for aborting multipart upload
    optional string upload_file = 15;
    optional string upload_id = 16;

    optional int64 snapshot_meta_image_size = 17;
    optional int64 snapshot_logical_data_size = 18;
    optional int64 snapshot_retained_data_size = 19;
    optional int64 snapshot_billable_data_size = 20;

    // TODO: add the referenced resources
}

//==============================================================================
// Stats
//==============================================================================
message TabletStatsPB {
    optional TabletIndexPB idx = 1;
    optional int64 data_size = 2; // data_size = index_size + segment_size
    optional int64 num_rows = 3;
    optional int64 num_rowsets = 4;
    optional int64 num_segments = 5;
    reserved 6;
    optional int64 base_compaction_cnt = 7;
    optional int64 cumulative_compaction_cnt = 8;
    optional int64 cumulative_point = 9;
    optional int64 last_base_compaction_time_ms = 10;
    optional int64 last_cumu_compaction_time_ms = 11;
    optional int64 full_compaction_cnt = 12; // used by calc_sync_versions() only
    optional int64 last_full_compaction_time_ms = 13;
    optional int64 index_size = 14;
    optional int64 segment_size = 15;
    // The cluster ID that most recently performed load or compaction on this tablet
    optional string last_active_cluster_id = 16;
    // Timestamp (ms) when the last_active_cluster was updated
    optional int64 last_active_time_ms = 17;
    // Current status of the last_active_cluster (filled by MS at get_rowset time)
    // NORMAL means available, other states (SUSPENDED/MANUAL_SHUTDOWN) or UNKNOWN means unavailable
    optional ClusterStatus last_active_cluster_status = 18;
    // Timestamp for timeout judgment
    // - Normal case: dynamically filled with ClusterPB.mtime (not persisted)
    // - Deleted case: persisted when first detected as deleted, reused thereafter
    optional int64 last_active_cluster_status_mtime_ms = 19;
}

message ObjectFilePB {
    optional string relative_path = 1;
    optional string etag = 2;
    optional int64 size = 3;
}

message CopyJobPB {
    enum JobStatus {
        UNKNOWN = 0;
        LOADING = 1;
        FINISH  = 2;
    }
    optional StagePB.StageType stage_type = 1;
    repeated ObjectFilePB object_files = 2;
    optional JobStatus job_status = 3;
    optional int64 start_time_ms = 4;
    optional int64 timeout_time_ms = 5;
    optional int64 finish_time_ms = 6;
}

message CopyFilePB {
    optional string copy_id = 1;
    optional int32 group_id = 2;
}

message ServiceRegistryPB {
    message Item {
        optional string id = 1;
        optional string ip = 2;
        optional int32 port = 3;
        optional int64 ctime_ms = 4;
        optional int64 mtime_ms = 5;
        optional int64 expiration_time_ms = 6;

        // Support FQDN
        optional string host = 7;
    }
    repeated Item items = 1;
}

// A special message, to test the message splitting logic.
message SplitSingleMessagePB {
    optional KeyBoundsPB segment_key_bounds = 1;
    optional int64 other_fields = 2;

    optional SplitSchemaPB __split_schema = 3; // A special field, DO NOT change it.
}

//==============================================================================
// Rpc structures
//==============================================================================

message BeginTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional TxnInfoPB txn_info = 2;
    optional string request_ip = 3;
}

message BeginTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 txn_id = 2;
    optional int64 dup_txn_id = 3;
    optional TxnStatusPB txn_status = 4;
    // TODO: There may be more fields TBD
}

message PrecommitTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 txn_id = 3;
    optional TxnCommitAttachmentPB commit_attachment = 4;
    optional int64 precommit_timeout_ms = 5;
    optional string request_ip = 6;
}

message PrecommitTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 txn_id = 2;
    // TODO: There may be more fields TBD
}

message CommitTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 txn_id = 3;
    optional bool is_2pc = 4;
    optional TxnCommitAttachmentPB commit_attachment = 5;
    // merge-on-write table ids
    repeated int64 mow_table_ids = 6;
    repeated int64 base_tablet_ids= 7; // all tablet from base tables (excluding mv)
    // for transaction load
    optional bool is_txn_load = 9;
    repeated SubTxnInfo sub_txn_infos = 10;
    optional bool enable_txn_lazy_commit = 11;
    optional string request_ip = 12;
}

message SubTxnInfo {
    optional int64 sub_txn_id = 1;
    optional int64 table_id = 2;
    repeated int64 base_tablet_ids= 3;
}

// corresponding to TabletStats in meta_service.h and FrontendServiceImpl.java
// make sure update all of them when adding new fields
message TableStatsPB {
    optional int64 table_id = 1;
    optional int64 updated_row_count = 2;
    optional int64 table_version = 3;
}

message CommitTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional TxnInfoPB txn_info = 2;
    // <table_id, partition_id> --> version
    repeated int64 table_ids = 3;
    repeated int64 partition_ids = 4;
    repeated int64 versions = 5;
    repeated TableStatsPB table_stats = 6;
    optional int64 version_update_time_ms = 7;
}

message AbortTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 txn_id = 3;
    optional string label = 4;
    optional string reason = 5;
    optional TxnCommitAttachmentPB commit_attachment = 6;
    optional string request_ip = 7;
}

message AbortTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional TxnInfoPB txn_info = 2;
}

message GetTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 txn_id = 3;
    optional string label = 4;
    optional string request_ip = 5;
}

message GetTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional TxnInfoPB txn_info = 2;
}

message GetTxnIdRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional string label = 3;
    repeated TxnStatusPB txn_status = 4;
    optional string request_ip = 5;
}

message GetTxnIdResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 txn_id = 2;
}

message BeginSubTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 txn_id = 2;
    // all successful or failed sub txn except the first one
    optional int64 sub_txn_num = 3;
    optional int64 db_id = 4;
    // set table_ids in txn_info
    repeated int64 table_ids = 5;
    // a random label used to generate a sub_txn_id
    optional string label = 6;
    optional string request_ip = 7;
}

message BeginSubTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 sub_txn_id = 2;
    optional TxnInfoPB txn_info = 3;
}

message AbortSubTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 txn_id = 2;
    // used for log
    optional int64 sub_txn_id = 3;
    // all successful or failed sub txn except the first one
    optional int64 sub_txn_num = 4;
    optional int64 db_id = 5;
    // set table_ids in txn_info
    repeated int64 table_ids = 6;
    optional string request_ip = 7;
}

message AbortSubTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional TxnInfoPB txn_info = 2;
}

message GetCurrentMaxTxnRequest {
    optional string cloud_unique_id = 1; // For auth
    optional string request_ip = 2;
}

message GetCurrentMaxTxnResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 current_max_txn_id = 2;
}

message CreateMetaSyncPointRequest {
    optional string cloud_unique_id = 1; // For auth
    optional string request_ip = 2;
}

message CreateMetaSyncPointResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 committed_version = 2;
    optional string versionstamp = 3;
}

message AbortTxnWithCoordinatorRequest {
    optional string cloud_unique_id = 1; // For auth
    optional string ip = 2;
    optional int64 id = 3;
    optional int64 start_time = 4;
    optional string request_ip = 5;
}

message AbortTxnWithCoordinatorResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetPrepareTxnByCoordinatorRequest {
    optional string cloud_unique_id = 1; // For auth
    optional string ip = 2;
    optional int64 id = 3;
    optional int64 start_time = 4;
    optional string request_ip = 5;
}

message GetPrepareTxnByCoordinatorResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated TxnInfoPB txn_infos = 2;
}

message CheckTxnConflictRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 end_txn_id = 3;
    repeated int64 table_ids = 4;
    optional bool ignore_timeout_txn = 5;
    optional string request_ip = 6;
}

message CheckTxnConflictResponse {
    optional MetaServiceResponseStatus status = 1;
    optional bool finished = 2;
    repeated TxnInfoPB conflict_txns = 3;
}

message CleanTxnLabelRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    repeated string labels = 3;
    optional string request_ip = 4;
}

message CleanTxnLabelResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetVersionRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 table_id = 3;
    optional int64 partition_id = 4;

    // For batch get version.
    optional bool batch_mode = 5;
    repeated int64 db_ids = 6;
    repeated int64 table_ids = 7;
    repeated int64 partition_ids = 8;

    // True if get table version
    optional bool is_table_version = 9;

    optional string request_ip = 10;

    // Wait the pending txn to be finished before getting version
    optional bool wait_for_pending_txn = 11;
};

message GetVersionResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 version = 2;

    // For batch get version.
    // <db_id, table_id, partition_id> --> version
    repeated int64 db_ids = 3;
    repeated int64 table_ids = 4;
    repeated int64 partition_ids = 5;
    repeated int64 versions = 6;
    repeated int64 version_update_time_ms = 7;
};

message GetObjStoreInfoRequest {
    optional string cloud_unique_id = 1; // For auth
    optional string request_ip = 2;
};

message AlterObjStoreInfoRequest {
    enum Operation {
        UNKNOWN         = 0;
        UPDATE_AK_SK    = 1;
        ADD_OBJ_INFO    = 2;
        LEGACY_UPDATE_AK_SK = 3;
        ALTER_OBJ_INFO = 4;

        ADD_HDFS_INFO = 100;
        DROP_HDFS_INFO = 101;
        ADD_BUILT_IN_VAULT = 102;
        ADD_S3_VAULT = 103;
        DROP_S3_VAULT = 104;
        ALTER_S3_VAULT = 105;
        ALTER_HDFS_VAULT = 106;

        SET_DEFAULT_VAULT = 200;
        UNSET_DEFAULT_VAULT = 201;
    }
    optional string cloud_unique_id = 1; // For auth
    optional ObjectStoreInfoPB obj = 2;
    optional Operation op = 3;
    optional StorageVaultPB vault = 4;
    optional bool set_as_default_storage_vault = 5;
    optional string request_ip = 6;
}

message AlterObjStoreInfoResponse {
    optional MetaServiceResponseStatus status = 1;
    optional string storage_vault_id = 2;
    optional bool default_storage_vault_replaced = 3;
}

message UpdateAkSkRequest {
    optional string instance_id = 1;
    repeated RamUserPB internal_bucket_user = 2;
    optional RamUserPB ram_user = 3;
    optional string request_ip = 4;
}

message UpdateAkSkResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetObjStoreInfoResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated ObjectStoreInfoPB obj_info = 2;
    repeated StorageVaultPB storage_vault = 3;
    optional string default_storage_vault_id = 4;
    optional string default_storage_vault_name = 5;
    optional bool enable_storage_vault = 6;
};

message CreateTabletsRequest {
    optional string cloud_unique_id = 1; // For auth
    repeated doris.TabletMetaCloudPB tablet_metas = 2;
    optional string storage_vault_name = 3;
    optional int64 db_id = 4;
    optional string request_ip = 5;
}

message CreateTabletsResponse {
    optional MetaServiceResponseStatus status = 1;
    optional string storage_vault_id = 2;
    optional string storage_vault_name = 3;
}

message UpdateTabletRequest {
    optional string cloud_unique_id = 1; // For auth
    repeated TabletMetaInfoPB tablet_meta_infos = 2;
    optional string request_ip = 3;
}

message UpdateTabletResponse {
    optional MetaServiceResponseStatus status = 1;
}

message UpdateTabletSchemaRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 tablet_id = 2;
    optional doris.TabletSchemaCloudPB tablet_schema = 3;
    optional string request_ip = 4;
}

message UpdateTabletSchemaResponse {
    optional MetaServiceResponseStatus status = 1;
}

message DropTabletRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 tablet_id = 2;
    optional string request_ip = 3;
    // TODO: There are more fields TBD
}

message GetTabletRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 tablet_id = 2;
    optional string request_ip = 3;
    // TODO: There are more fields TBD
}

message GetTabletResponse {
    optional MetaServiceResponseStatus status = 1;
    optional doris.TabletMetaCloudPB tablet_meta = 2;
}

message CreateRowsetRequest {
    optional string cloud_unique_id = 1; // For auth
    optional doris.RowsetMetaCloudPB rowset_meta = 2;
    optional bool temporary = 3;
    optional int64 txn_id = 4;
    optional string tablet_job_id = 5;
    optional string request_ip = 6;
}

message CreateRowsetResponse {
    optional MetaServiceResponseStatus status = 1;
    optional doris.RowsetMetaCloudPB existed_rowset_meta = 2;
}

message GetRowsetRequest {
    enum SchemaOp {
        FILL_WITH_DICT = 0; // fill rowset schema with SchemaCloudDictionary value
        RETURN_DICT = 1;    // not use dict value in MS, return SchemaCloudDictionary directly
        NO_DICT = 2;        // not read dict info, use local cached SchemaCloudDictionary instead
    }
    optional string cloud_unique_id = 1; // For auth
    optional TabletIndexPB idx = 2;
    optional int64 start_version = 3;
    optional int64 end_version = 4;
    optional int64 base_compaction_cnt = 5;
    optional int64 cumulative_compaction_cnt = 6;
    optional int64 cumulative_point = 7;
    // returned schema format on rowset schema, used in variant type directly.
    // for compability reason we use FILL_WITH_DICT as default
    optional SchemaOp schema_op = 8  [default = FILL_WITH_DICT];
    optional string request_ip = 9;
    optional int64 full_compaction_cnt = 10;
}

message GetRowsetResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated doris.RowsetMetaCloudPB rowset_meta = 2;
    optional TabletStatsPB stats = 3;
    // Return dict value if SchemaOp is RETURN_DICT
    optional SchemaCloudDictionary schema_dict = 4;
    // The current max version of the partition
    optional int64 partition_max_version = 5;
    // The cluster_id of the requester
    optional string requester_cluster_id = 6;
}

message GetSchemaDictRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 index_id = 2;
    optional string request_ip = 3;
}

message GetSchemaDictResponse {
    optional MetaServiceResponseStatus status = 1;
    optional SchemaCloudDictionary schema_dict = 2;
}

message IndexRequest {
    optional string cloud_unique_id = 1; // For auth
    repeated int64 index_ids = 2;
    optional int64 table_id = 3;
    optional int64 expiration = 4;
    optional int64 db_id = 5;
    optional bool is_new_table = 6; // For table version
    optional string request_ip = 7;
    repeated int64 partition_ids = 8;
}

message IndexResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 table_version = 2;
}

message PartitionRequest {
    optional string cloud_unique_id = 1; // For auth
    repeated int64 partition_ids = 2;
    optional int64 table_id = 3;
    repeated int64 index_ids = 4;
    optional int64 expiration = 5;
    optional int64 db_id = 6;
    optional bool need_update_table_version = 7;
    optional string request_ip = 8;
    repeated int64 partition_versions = 9;
}

message PartitionResponse {
    optional MetaServiceResponseStatus status = 1;
    optional int64 table_version = 2;
}

message RestoreJobRequest {
    enum Action {
        UNKONWN  = 0;
        PREPARE = 1;
        COMMIT = 2;
        ABORT = 3;
        COMPLETE = 4;
    }
    optional string cloud_unique_id = 1;
    optional int64 tablet_id = 2;
    optional doris.TabletMetaCloudPB tablet_meta = 3;
    optional int64 expiration = 4;
    optional string request_ip = 5;
    optional Action action = 6;
    // 50: used for delete bitmap storage v2
    optional int64 store_version = 50;
}

message RestoreJobResponse {
    optional MetaServiceResponseStatus status = 1;
}

message MetaServiceResponseStatus {
    optional MetaServiceCode code = 1;
    optional string msg = 2;
}

message MetaServiceHttpRequest {
}

message MetaServiceHttpResponse {
}

message CreateInstanceRequest {
    optional string instance_id = 1;
    optional string user_id = 2;
    optional string name = 3; // Alias
    optional ObjectStoreInfoPB obj_info = 4;
    optional RamUserPB ram_user = 5;
    optional bool sse_enabled = 6;
    optional StorageVaultPB vault = 7;
    optional string request_ip = 8;
}

message CreateInstanceResponse {
    optional MetaServiceResponseStatus status = 1;
}

message AlterInstanceRequest {
    enum Operation {
        UNKNOWN                     = 0;
        DROP                        = 1;
        REFRESH                     = 2;
        RENAME                      = 3;
        ENABLE_SSE                  = 4;
        DISABLE_SSE                 = 5;
        SET_OVERDUE                 = 6;
        SET_NORMAL                  = 7;
        SET_SNAPSHOT_PROPERTY       = 8;
    }

    enum SnapshotProperty {
        UNKNOWN_PROPERTY                = 0;
        ENABLE_SNAPSHOT                 = 1;    // true or false
        MAX_RESERVED_SNAPSHOTS          = 2;    // in [0, max_reserved_snapshots]
        SNAPSHOT_INTERVAL_SECONDS       = 3;    // in [min_interval_seconds, +inf)
    }

    optional string instance_id = 1;
    optional Operation op = 2;
    optional string name = 3;
    optional string request_ip = 4;
    map<string, string> properties = 5; // key is the Name of SnapshotProperty value.
}

message AlterInstanceResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetInstanceRequest {
    optional string instance_id = 1;
    optional string cloud_unique_id = 2;
    optional string request_ip = 3;
}

message GetInstanceResponse {
    optional MetaServiceResponseStatus status = 1;
    optional InstanceInfoPB instance = 2;
}

message AlterClusterRequest {
    enum Operation {
        UNKNOWN        = 0;
        ADD_CLUSTER    = 1;
        DROP_CLUSTER   = 2;
        ADD_NODE       = 3;
        DROP_NODE      = 4;
        RENAME_CLUSTER = 5;
        UPDATE_CLUSTER_MYSQL_USER_NAME = 6; // just for update cluster's mysql_user_name
        DECOMMISSION_NODE = 7;
        NOTIFY_DECOMMISSIONED = 8;
        UPDATE_CLUSTER_ENDPOINT = 9;
        SET_CLUSTER_STATUS = 10;
        ALTER_VCLUSTER_INFO = 11;
        ALTER_PROPERTIES = 12;
    }
    optional string instance_id = 1;
    optional string cloud_unique_id = 2; // For auth
    optional ClusterPB cluster = 3;
    optional Operation op = 4;
    // for SQL mode rename cluster, rename to cluster name eq instance empty cluster name, need drop empty cluster
    optional bool replace_if_existing_empty_target_cluster = 5;
    optional string request_ip = 6;
}

message AlterClusterResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetClusterRequest {
    optional string instance_id = 1; // Redundant field
    optional string cloud_unique_id = 2;
    optional string cluster_id = 3;
    optional string cluster_name = 4;
    optional string mysql_user_name = 5;
    optional string request_ip = 6;
}

message GetClusterStatusRequest {
    repeated string instance_ids = 1; // Redundant field
    repeated string cloud_unique_ids = 2;
    optional ClusterStatus status = 3;
    optional string request_ip = 4;
}

message GetClusterStatusResponse {
    message GetClusterStatusResponseDetail {
        optional string instance_id = 1;
        repeated ClusterPB clusters = 2;
    }
    optional MetaServiceResponseStatus status = 1;
    repeated GetClusterStatusResponseDetail details = 2;
    // The cluster_id of the requesting node (resolved from cloud_unique_id)
    optional string requester_cluster_id = 3;
}

message GetClusterResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated ClusterPB cluster = 2;
    optional bool enable_storage_vault = 3;
}

message GetTabletStatsRequest {
    optional string cloud_unique_id = 1;
    repeated TabletIndexPB tablet_idx = 2;
    optional string request_ip = 3;
}

message GetTabletStatsResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated TabletStatsPB tablet_stats = 2;
}

message CreateStageRequest {
    optional string cloud_unique_id = 1;
    optional StagePB stage = 2;
    optional string request_ip = 3;
}

message CreateStageResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetStageRequest {
    optional string cloud_unique_id = 1;
    optional string stage_name = 2;
    optional string mysql_user_name = 3;
    optional StagePB.StageType type = 4;
    optional string mysql_user_id = 5;
    optional string request_ip = 6;
}

message GetStageResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated StagePB stage = 2;
}

message DropStageRequest {
    optional string cloud_unique_id = 1;
    optional string stage_name = 2;
    optional string mysql_user_name = 3;
    optional StagePB.StageType type = 4;
    optional string mysql_user_id = 5;
    optional string reason = 6;
    optional string request_ip = 7;
}

message DropStageResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetIamRequest {
    optional string cloud_unique_id = 1;
    optional string request_ip = 2;
}

message GetIamResponse {
    optional MetaServiceResponseStatus status = 1;
    optional RamUserPB iam_user = 2;
    optional RamUserPB ram_user = 3;
}

message AlterIamRequest {
    optional string account_id = 1;
    optional string ak = 2;
    optional string sk = 3;
    optional string request_ip = 4;
}

message AlterIamResponse {
    optional MetaServiceResponseStatus status = 1;
}

message AlterRamUserRequest {
    optional string instance_id = 1;
    optional RamUserPB ram_user = 2;
    optional string request_ip = 3;
}

message AlterRamUserResponse {
    optional MetaServiceResponseStatus status = 1;
}

message StartTabletJobRequest {
    optional string cloud_unique_id = 1; // For auth
    optional TabletJobInfoPB job = 2;
    optional string request_ip = 3;
}

message StartTabletJobResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated int64 version_in_compaction = 2;
    optional int64 alter_version = 3;
}

message FinishTabletJobRequest {
    enum Action {
        UNKONWN = 0;
        COMMIT  = 1;
        ABORT   = 2;
        LEASE   = 3;
    }
    optional string cloud_unique_id = 1; // For auth
    optional Action action = 2;
    optional TabletJobInfoPB job = 3;
    optional string request_ip = 4;
}

message FinishTabletJobResponse {
    optional MetaServiceResponseStatus status = 1;
    optional TabletStatsPB stats = 2;
    optional int64 alter_version = 3;
}

message BeginCopyRequest {
    optional string cloud_unique_id = 1;
    optional string stage_id = 2;
    optional StagePB.StageType stage_type = 3;
    optional int64 table_id = 4;
    optional string copy_id = 5;
    optional int32 group_id = 6;
    optional int64 start_time_ms = 7;
    optional int64 timeout_time_ms = 8;
    repeated ObjectFilePB object_files = 9;
    optional int64 file_num_limit = 10;
    optional int64 file_size_limit = 11;
    optional int64 file_meta_size_limit = 12;
    optional string request_ip = 13;
}

message BeginCopyResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated ObjectFilePB filtered_object_files = 2;
}

message FinishCopyRequest {
    enum Action {
        UNKNOWN = 0;
        COMMIT  = 1;
        ABORT   = 2;
        REMOVE  = 3;
    }
    optional string cloud_unique_id = 1;
    optional string stage_id = 2;
    optional StagePB.StageType stage_type = 3;
    optional int64 table_id = 4;
    optional string copy_id = 5;
    optional int32 group_id = 6;
    optional Action action = 7;
    optional int64 finish_time_ms = 8;
    optional string request_ip = 9;
}

message FinishCopyResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetCopyJobRequest {
    optional string cloud_unique_id = 1;
    optional string stage_id = 2;
    optional int64 table_id = 3;
    optional string copy_id = 4;
    optional int32 group_id = 5;
    optional string request_ip = 6;
}

message GetCopyJobResponse {
    optional MetaServiceResponseStatus status = 1;
    optional CopyJobPB copy_job = 2;
}

message GetCopyFilesRequest {
    optional string cloud_unique_id = 1;
    optional string stage_id = 2;
    optional int64 table_id = 3;
    optional string request_ip = 4;
}

message GetCopyFilesResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated ObjectFilePB object_files = 2;
}

message FilterCopyFilesRequest {
    optional string cloud_unique_id = 1;
    optional string stage_id = 2;
    optional int64 table_id = 3;
    repeated ObjectFilePB object_files = 4;
    optional string request_ip = 5;
}

message FilterCopyFilesResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated ObjectFilePB object_files = 2;
}

message RecycleInstanceRequest {
    repeated string instance_ids = 1;
    optional string request_ip = 2;
}

message StatisticsRecycleRequest {
    repeated string instance_ids = 1;
    repeated string resource_type = 2;
}

message RecycleInstanceResponse {
    optional MetaServiceResponseStatus status = 1;
}

enum MetaServiceCode {
    OK = 0;

    //Meta service internal error
    INVALID_ARGUMENT = 1001;
    KV_TXN_CREATE_ERR = 1002;
    KV_TXN_GET_ERR = 1003;
    KV_TXN_COMMIT_ERR = 1004;
    KV_TXN_CONFLICT = 1005;
    PROTOBUF_PARSE_ERR = 1006;
    PROTOBUF_SERIALIZE_ERR = 1007;
    // A code indicates that the underlying store returns an error that
    // needs to be retried. This code is not sent back to the client.
    // See `selectdb::MetaServiceProxy` for details.
    KV_TXN_STORE_GET_RETRYABLE = 1008;
    KV_TXN_STORE_COMMIT_RETRYABLE = 1009;
    KV_TXN_STORE_CREATE_RETRYABLE = 1010;
    KV_TXN_TOO_OLD = 1011;
    // WARNING: KV_TXN_MAYBE_COMMITTED is NOT returned to clients. It is kept as an
    // internal retry signal inside MetaServiceProxy::call_impl(), then downgraded to
    // KV_TXN_COMMIT_ERR before the response is sent back. Older BE/FE versions do not
    // recognize this enum value, and proto2 would otherwise fall back to OK (= 0).
    KV_TXN_MAYBE_COMMITTED = 1012;

    //Doris error
    TXN_GEN_ID_ERR = 2001;
    TXN_DUPLICATED_REQ = 2002;
    TXN_LABEL_ALREADY_USED = 2003;
    TXN_INVALID_STATUS = 2004;
    TXN_LABEL_NOT_FOUND = 2005;
    TXN_ID_NOT_FOUND = 2006;
    TXN_ALREADY_ABORTED = 2007;
    TXN_ALREADY_VISIBLE = 2008;
    TXN_ALREADY_PRECOMMITED = 2009;
    VERSION_NOT_FOUND = 2010;
    TABLET_NOT_FOUND = 2011;
    STALE_TABLET_CACHE = 2012;
    STALE_PREPARE_ROWSET = 2013;
    TXN_ALREADY_COMMITED = 2014;

    CLUSTER_NOT_FOUND = 3001;
    ALREADY_EXISTED = 3002;
    CLUSTER_ENDPOINT_MISSING = 3003;

    STORAGE_VAULT_NOT_FOUND = 3004;

    // Stage
    STAGE_NOT_FOUND = 4001;
    STAGE_GET_ERR = 4002;
    STATE_ALREADY_EXISTED_FOR_USER = 4003;
    COPY_JOB_NOT_FOUND = 4004;

    // Job
    JOB_EXPIRED = 5000;
    JOB_TABLET_BUSY = 5001;
    JOB_ALREADY_SUCCESS = 5002;
    ROUTINE_LOAD_DATA_INCONSISTENT = 5003;
    ROUTINE_LOAD_PROGRESS_NOT_FOUND = 5004;
    JOB_CHECK_ALTER_VERSION = 5005;
    STREAMING_JOB_PROGRESS_NOT_FOUND = 5006;

    // Rate limit
    // Request is rejected by the RPC-specific QPS limiter.
    MAX_QPS_LIMIT = 6001;
    // Request is rejected by the MetaService-wide rate limiter instead of a single RPC limiter.
    MS_TOO_BUSY = 6002;

    ERR_ENCRYPT = 7001;
    ERR_DECPYPT = 7002;

    // delete bitmap
    LOCK_EXPIRED = 8001;
    LOCK_CONFLICT = 8002;
    ROWSETS_EXPIRED = 8003;
    VERSION_NOT_MATCH = 8004;
    UPDATE_OVERRIDE_EXISTING_KV = 8005;

    // partial update
    ROWSET_META_NOT_FOUND = 9001;

    // The meta service retries KV_TXN_CONFLICT error but is exceeded the max times.
    KV_TXN_CONFLICT_RETRY_EXCEEDED_MAX_TIMES = 10001;

    SCHEMA_DICT_NOT_FOUND = 11001;

    // WARNING: Before adding a new MetaServiceCode, consider backward compatibility.
    // This is a proto2 optional enum field. If an older client receives an unrecognized
    // enum value, the field is treated as unset and defaults to OK (= 0), silently
    // turning errors into success. Any new error code that may be sent to older clients
    // MUST be downgraded to a legacy code before the response is sent to the client.
    UNDEFINED_ERR = 1000000;
}

message DeleteBitmapStoragePB {
    optional bool store_in_fdb = 1;
    optional DeleteBitmapPB delete_bitmap = 2;
    optional PackedSliceLocationPB packed_slice_location = 3;
}

message UpdateDeleteBitmapRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 table_id = 2;
    optional int64 partition_id = 3;
    optional int64 tablet_id = 4;
    optional int64 lock_id = 5;
    optional int64 initiator = 6;
    // 7-10: used for storage v1
    repeated string rowset_ids = 7;
    repeated uint32 segment_ids = 8;
    repeated int64 versions = 9;
    // Serialized roaring bitmaps indexed with {rowset_id, segment_id, version}
    repeated bytes segment_delete_bitmaps = 10;
    optional bool without_lock = 11;
    // to determine whether this is in an explicit txn and whether it's the first sub txn
    optional bool is_explicit_txn = 12;
    optional int64 txn_id = 13;
    // for load txn only
    optional int64 next_visible_version = 14;
    optional string request_ip = 15;
    // remove delete_bitmap of pre rowsets since it is agged when compaction
    optional int64 pre_rowset_agg_start_version = 16;
    optional int64 pre_rowset_agg_end_version = 17;
    // when update delete_bitmap of pre rowsets, check the rowset exists
    repeated int64 pre_rowset_versions = 18;
    // 50-51: used for storage v2
    repeated string delta_rowset_ids = 50;
    repeated DeleteBitmapStoragePB delete_bitmap_storages = 51;
    optional int64 store_version = 52;
}

message UpdateDeleteBitmapResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetDeleteBitmapRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 tablet_id = 2;
    repeated string rowset_ids = 3;
    repeated int64 begin_versions = 4;
    repeated int64 end_versions = 5;
    optional TabletIndexPB idx = 6;
    optional int64 base_compaction_cnt = 7;
    optional int64 cumulative_compaction_cnt = 8;
    optional int64 cumulative_point = 9;
    optional string request_ip = 10;
    optional int64 dbm_bytes_threshold = 11;
    optional int64 store_version = 50;
}

message GetDeleteBitmapResponse {
    optional MetaServiceResponseStatus status = 1;
    // 2-5: used for storage v1
    repeated string rowset_ids = 2;
    repeated uint32 segment_ids = 3;
    repeated int64 versions = 4;
    // Serialized roaring bitmaps indexed with {rowset_id, segment_id, version}
    repeated bytes segment_delete_bitmaps = 5;
    optional int64 tablet_id = 6;
    // 50-51: used for storage v2
    repeated string delta_rowset_ids = 50;
    repeated DeleteBitmapStoragePB delete_bitmap_storages = 51;

    // indicates whether the reponse contains all request rowsets' delete bitmap
    // when `has_more` is `true`, BE should launch RPC again to get the results for remaining rowsets
    optional bool has_more = 100;
    repeated string returned_rowset_ids = 101;
}

message RemoveDeleteBitmapRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 tablet_id = 2;
    repeated string rowset_ids = 3;
    repeated int64 begin_versions = 4;
    repeated int64 end_versions = 5;
    optional string request_ip = 6;
}

message RemoveDeleteBitmapResponse {
    optional MetaServiceResponseStatus status = 1;
}

message PendingDeleteBitmapPB {
    repeated bytes delete_bitmap_keys = 1;
}

message DeleteBitmapUpdateLockPB {
    optional int64 lock_id = 1;
    optional int64 expiration = 2;
    repeated int64 initiators = 3;
}

message MowTabletJobPB {
    optional int64 expiration = 1;
}

message GetDeleteBitmapUpdateLockRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 table_id = 2;
    repeated int64 partition_ids = 3;
    optional int64 lock_id = 4;
    optional int64 initiator = 5;
    optional int64 expiration = 6;
    optional bool require_compaction_stats = 7 [default = false];
    repeated TabletIndexPB tablet_indexes = 8;
    optional string request_ip = 9;
    optional bool urgent = 10;
}

message GetDeleteBitmapUpdateLockResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated int64 base_compaction_cnts = 2;
    repeated int64 cumulative_compaction_cnts = 3;
    repeated int64 cumulative_points = 4;
    repeated int64 tablet_states = 5;
}

message RemoveDeleteBitmapUpdateLockRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 table_id = 2;
    optional int64 tablet_id = 3;
    optional int64 lock_id = 4;
    optional int64 initiator = 5;
    optional string request_ip = 6;
}

message RemoveDeleteBitmapUpdateLockResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetRLTaskCommitAttachRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 job_id = 3;
    optional string request_ip = 4;
}

message GetRLTaskCommitAttachResponse {
    optional MetaServiceResponseStatus status = 1;
    optional RLTaskTxnCommitAttachmentPB commit_attach = 2;
}

message ResetRLProgressRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 job_id = 3;
    map<int32, int64> partition_to_offset = 4;
    optional string request_ip = 5;
}

message ResetRLProgressResponse {
    optional MetaServiceResponseStatus status = 1;
}

message GetStreamingTaskCommitAttachRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 job_id = 3;
    optional string request_ip = 4;
}

message GetStreamingTaskCommitAttachResponse {
    optional MetaServiceResponseStatus status = 1;
    optional StreamingTaskCommitAttachmentPB commit_attach = 2;
}

message DeleteStreamingJobRequest {
    optional string cloud_unique_id = 1;
    optional int64 db_id = 2;
    optional int64 job_id = 3;
    optional string request_ip = 4;
}

message DeleteStreamingJobResponse {
    optional MetaServiceResponseStatus status = 1;
}

message ResetStreamingJobOffsetRequest {
    optional string cloud_unique_id = 1; // For auth
    optional int64 db_id = 2;
    optional int64 job_id = 3;
    optional string offset = 4;
    optional string request_ip = 5;
}

message ResetStreamingJobOffsetResponse {
    optional MetaServiceResponseStatus status = 1;
}

message CheckKeyInfos {
    repeated int64 db_ids = 1;
    repeated int64 table_ids = 2;
    repeated int64 index_ids = 3;
    repeated int64 partition_ids = 4;
}

message CheckKVRequest {
    enum Operation {
        CREATE_INDEX_AFTER_FE_COMMIT        = 1;
        CREATE_PARTITION_AFTER_FE_COMMIT    = 2;
    }
    optional string cloud_unique_id = 1; // For auth
    optional CheckKeyInfos check_keys = 2;
    optional Operation op = 3;
    optional string request_ip = 4;
}

message CheckKVResponse {
    optional MetaServiceResponseStatus status = 1;
    optional CheckKeyInfos bad_keys = 2;
}

message BeginSnapshotRequest {
    optional string cloud_unique_id = 1;
    optional string snapshot_label = 2;
    optional bool auto_snapshot = 3;
    optional int64 timeout_seconds = 4;
    optional int64 ttl_seconds = 5;
    optional string request_ip = 6;
    optional string vault_name = 7;
}

message BeginSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
    optional string snapshot_id = 2;
    optional string image_url = 3;
    optional ObjectStoreInfoPB obj_info = 4;
}

message UpdateSnapshotRequest {
    optional string cloud_unique_id = 1;
    optional string snapshot_id = 2;
    // record the multipart upload file_name and upload_id, used for aborting multipart upload
    optional string upload_file = 3;
    optional string upload_id = 4;
    optional string request_ip = 5;
}

message UpdateSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
}

message CommitSnapshotRequest {
    optional string cloud_unique_id = 1;
    optional string snapshot_id = 2;
    optional string image_url = 3;
    optional int64 last_journal_id = 4;
    optional string request_ip = 5;
    optional int64 snapshot_meta_image_size = 6;
    optional int64 snapshot_logical_data_size = 7;
}

message CommitSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
}

message AbortSnapshotRequest {
    optional string cloud_unique_id = 1;
    optional string snapshot_id = 2;
    optional string reason = 3;
    optional string request_ip = 4;
}

message AbortSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
}

message SnapshotInfoPB {
    optional string snapshot_id = 1;
    optional string ancestor_id = 2; // The snapshot cloned from (if any).
    optional int64 create_at = 3;    // unix timestamp, in seconds
    optional int64 finish_at = 4;    // unix timestamp, in seconds
    optional string image_url = 5;
    optional int64 journal_id = 6;
    optional SnapshotStatus status = 7;
    optional SnapshotType type = 8;
    optional string instance_id = 9;
    optional bool auto_snapshot = 10;
    optional int64 ttl_seconds = 11;
    optional int64 timeout_seconds = 12;
    optional string snapshot_label = 13;
    optional string reason = 14;

    repeated string derived_instance_ids = 15;
    optional int64 snapshot_meta_image_size = 16;
    optional int64 snapshot_logical_data_size = 17;
    optional int64 snapshot_retained_data_size = 18;
    optional int64 snapshot_billable_data_size = 19;
    optional string resource_id = 20;
}

message ListSnapshotRequest {
    optional string cloud_unique_id = 1;
    optional string required_snapshot_id = 2;   // Return all snapshots if not set.
    optional bool include_aborted = 3;
    optional string request_ip = 4;
    optional string instance_id = 5;
}

message ListSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
    repeated SnapshotInfoPB snapshots = 2;
}

message DropSnapshotRequest {
    optional string cloud_unique_id = 1;
    optional string snapshot_id = 2;  // The snapshot to drop
    optional string request_ip = 3;
}

message DropSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
}

message CloneInstanceRequest {
    enum CloneType {
        UNKNOWN = 0;
        READ_ONLY = 1;
        WRITABLE = 2;
        ROLLBACK = 3;
    }
    optional string from_snapshot_id = 1;
    optional string from_instance_id = 2;
    optional string new_instance_id = 3;
    optional string snapshot_name = 4;      // only used for clone
    optional CloneType clone_type = 5;
    optional string request_ip = 6;

    // Below fields are required for WRITABLE clone.
    optional ObjectStoreInfoPB obj_info = 7;
    optional StorageVaultPB storage_vault = 8;
}

message CloneInstanceResponse {
    optional MetaServiceResponseStatus status = 1;
    // The info of the object store where snapshot images stored
    optional ObjectStoreInfoPB obj_info = 2;
    // The URL of the snapshot image
    optional string image_url = 3;
}

message CompactSnapshotRequest {
    optional string instance_id = 1;
    optional string cloud_unique_id = 2;
    optional string request_ip = 3;
}

message CompactSnapshotResponse {
    optional MetaServiceResponseStatus status = 1;
}

message PackedSlicePB {
    optional string path = 1;
    optional int64 offset = 2;
    optional int64 size = 3;
    optional bool deleted = 4;
    optional int64 tablet_id = 5;
    optional string rowset_id = 6;
    optional int64 txn_id = 7;
    optional bool corrected = 8;
}

message PackedFileInfoPB {
    enum PackedFileState {
        NORMAL = 0;
        RECYCLING = 1;
    }
    optional int64 ref_cnt = 1;
    optional int64 total_slice_num = 2;
    optional int64 total_slice_bytes = 3;
    optional int64 remaining_slice_bytes = 4;
    optional int64 created_at_sec = 5;
    optional bool corrected = 6;
    optional PackedFileState state = 7 [default = NORMAL];
    repeated PackedSlicePB slices = 8;
    optional string resource_id = 9;
}

// Wrapper for packed file footer information. It keeps PackedFileInfoPB extensible for tools
// reading packed file trailers.
message PackedFileFooterPB {
    optional PackedFileInfoPB packed_file_info = 1;
}

message UpdatePackedFileInfoRequest {
    optional string cloud_unique_id = 1; // For auth
    optional string request_ip = 2;
    optional string packed_file_path = 3; // The path of the packed file
    optional PackedFileInfoPB packed_file_info = 4;
}

message UpdatePackedFileInfoResponse {
    optional MetaServiceResponseStatus status = 1;
}

service MetaService {
    rpc begin_txn(BeginTxnRequest) returns (BeginTxnResponse);
    rpc precommit_txn(PrecommitTxnRequest) returns (PrecommitTxnResponse);
    rpc commit_txn(CommitTxnRequest) returns (CommitTxnResponse);
    rpc abort_txn(AbortTxnRequest) returns (AbortTxnResponse);
    rpc get_txn(GetTxnRequest) returns (GetTxnResponse);
    rpc get_current_max_txn_id(GetCurrentMaxTxnRequest) returns (GetCurrentMaxTxnResponse);
    rpc create_meta_sync_point(CreateMetaSyncPointRequest) returns (CreateMetaSyncPointResponse);
    rpc check_txn_conflict(CheckTxnConflictRequest) returns (CheckTxnConflictResponse);
    rpc clean_txn_label(CleanTxnLabelRequest) returns (CleanTxnLabelResponse);
    rpc get_txn_id(GetTxnIdRequest) returns (GetTxnIdResponse);
    rpc begin_sub_txn(BeginSubTxnRequest) returns (BeginSubTxnResponse);
    rpc abort_sub_txn(AbortSubTxnRequest) returns (AbortSubTxnResponse);
    rpc abort_txn_with_coordinator(AbortTxnWithCoordinatorRequest) returns (AbortTxnWithCoordinatorResponse);
    rpc get_prepare_txn_by_coordinator(GetPrepareTxnByCoordinatorRequest) returns (GetPrepareTxnByCoordinatorResponse);

    rpc get_version(GetVersionRequest) returns (GetVersionResponse);
    rpc create_tablets(CreateTabletsRequest) returns (CreateTabletsResponse);
    rpc update_tablet(UpdateTabletRequest) returns (UpdateTabletResponse);

    rpc prepare_restore_job(RestoreJobRequest) returns (RestoreJobResponse);
    rpc commit_restore_job(RestoreJobRequest) returns (RestoreJobResponse);
    rpc finish_restore_job(RestoreJobRequest) returns (RestoreJobResponse);

    rpc get_tablet(GetTabletRequest) returns (GetTabletResponse);
    rpc prepare_rowset(CreateRowsetRequest) returns (CreateRowsetResponse);
    rpc commit_rowset(CreateRowsetRequest) returns (CreateRowsetResponse);
    rpc update_tmp_rowset(CreateRowsetRequest) returns (CreateRowsetResponse);
    rpc get_rowset(GetRowsetRequest) returns (GetRowsetResponse);
    rpc get_schema_dict(GetSchemaDictRequest) returns (GetSchemaDictResponse);
    rpc prepare_index(IndexRequest) returns (IndexResponse);
    rpc commit_index(IndexRequest) returns (IndexResponse);
    rpc drop_index(IndexRequest) returns (IndexResponse);
    rpc prepare_partition(PartitionRequest) returns (PartitionResponse);
    rpc commit_partition(PartitionRequest) returns (PartitionResponse);
    rpc drop_partition(PartitionRequest) returns (PartitionResponse);

    rpc start_tablet_job(StartTabletJobRequest) returns (StartTabletJobResponse);
    rpc finish_tablet_job(FinishTabletJobRequest) returns (FinishTabletJobResponse);

    rpc http(MetaServiceHttpRequest) returns (MetaServiceHttpResponse);

    rpc get_obj_store_info(GetObjStoreInfoRequest) returns (GetObjStoreInfoResponse);
    rpc alter_obj_store_info(AlterObjStoreInfoRequest) returns (AlterObjStoreInfoResponse);
    rpc alter_storage_vault(AlterObjStoreInfoRequest) returns (AlterObjStoreInfoResponse);
    rpc update_ak_sk(UpdateAkSkRequest) returns (UpdateAkSkResponse);
    rpc create_instance(CreateInstanceRequest) returns (CreateInstanceResponse);
    rpc alter_instance(AlterInstanceRequest) returns (AlterInstanceResponse);
    rpc get_instance(GetInstanceRequest) returns (GetInstanceResponse);
    rpc alter_cluster(AlterClusterRequest) returns (AlterClusterResponse);
    rpc get_cluster(GetClusterRequest) returns (GetClusterResponse);
    rpc get_cluster_status(GetClusterStatusRequest) returns(GetClusterStatusResponse);

    rpc get_tablet_stats(GetTabletStatsRequest) returns (GetTabletStatsResponse);

    // stage
    rpc create_stage(CreateStageRequest) returns (CreateStageResponse);
    rpc get_stage(GetStageRequest) returns (GetStageResponse);
    rpc drop_stage(DropStageRequest) returns (DropStageResponse);
    rpc get_iam(GetIamRequest) returns (GetIamResponse);
    rpc alter_iam(AlterIamRequest) returns (AlterIamResponse);
    rpc alter_ram_user(AlterRamUserRequest) returns (AlterRamUserResponse);
    // copy into
    rpc begin_copy(BeginCopyRequest) returns (BeginCopyResponse);
    rpc finish_copy(FinishCopyRequest) returns (FinishCopyResponse);
    rpc get_copy_job(GetCopyJobRequest) returns (GetCopyJobResponse);
    rpc get_copy_files(GetCopyFilesRequest) returns (GetCopyFilesResponse);
    rpc filter_copy_files(FilterCopyFilesRequest) returns (FilterCopyFilesResponse);

    // delete bitmap
    rpc update_delete_bitmap(UpdateDeleteBitmapRequest) returns(UpdateDeleteBitmapResponse);
    rpc get_delete_bitmap(GetDeleteBitmapRequest) returns(GetDeleteBitmapResponse);
    rpc get_delete_bitmap_update_lock(GetDeleteBitmapUpdateLockRequest) returns(GetDeleteBitmapUpdateLockResponse);
    rpc remove_delete_bitmap_update_lock(RemoveDeleteBitmapUpdateLockRequest) returns(RemoveDeleteBitmapUpdateLockResponse);
    rpc remove_delete_bitmap(RemoveDeleteBitmapRequest) returns(RemoveDeleteBitmapResponse);

    // routine load progress
    rpc get_rl_task_commit_attach(GetRLTaskCommitAttachRequest) returns (GetRLTaskCommitAttachResponse);
    rpc reset_rl_progress(ResetRLProgressRequest) returns (ResetRLProgressResponse);

    // streaming job meta
    rpc get_streaming_task_commit_attach(GetStreamingTaskCommitAttachRequest) returns (GetStreamingTaskCommitAttachResponse);
    rpc delete_streaming_job(DeleteStreamingJobRequest) returns (DeleteStreamingJobResponse);
    rpc reset_streaming_job_offset(ResetStreamingJobOffsetRequest) returns (ResetStreamingJobOffsetResponse);

    // check KV
    rpc check_kv(CheckKVRequest) returns (CheckKVResponse);

    // cluster snapshot related methods
    rpc begin_snapshot(BeginSnapshotRequest) returns (BeginSnapshotResponse);
    rpc update_snapshot(UpdateSnapshotRequest) returns (UpdateSnapshotResponse);
    rpc commit_snapshot(CommitSnapshotRequest) returns (CommitSnapshotResponse);
    rpc abort_snapshot(AbortSnapshotRequest) returns (AbortSnapshotResponse);
    rpc drop_snapshot(DropSnapshotRequest) returns (DropSnapshotResponse);
    rpc list_snapshot(ListSnapshotRequest) returns (ListSnapshotResponse);
    rpc clone_instance(CloneInstanceRequest) returns (CloneInstanceResponse);
    rpc compact_snapshot(CompactSnapshotRequest) returns (CompactSnapshotResponse);

    rpc update_packed_file_info(UpdatePackedFileInfoRequest) returns (UpdatePackedFileInfoResponse);
};

service RecyclerService {
    rpc recycle_instance(RecycleInstanceRequest) returns (RecycleInstanceResponse);
    rpc http(MetaServiceHttpRequest) returns (MetaServiceHttpResponse);
};

// vim: et ts=4 sw=4: