gensrc/proto/descriptors.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;
option java_package = "org.apache.doris.proto";

import "types.proto";
import "olap_file.proto";

message PSlotDescriptor {
    required int32 id = 1;
    required int32 parent = 2; // tuple id which this slot is belong to
    required PTypeDesc slot_type = 3;
    required int32 column_pos = 4;   // in originating table
    required int32 byte_offset = 5;  // // deprecated
    required int32 null_indicator_byte = 6;
    required int32 null_indicator_bit = 7;
    required string col_name = 8;
    required int32 slot_idx = 9;
    optional bool is_materialized = 10;
    optional int32 col_unique_id = 11;
    optional bool is_key = 12;
    optional bool is_auto_increment = 13;
    optional int32 col_type = 14 [default = 0];
    repeated string column_paths = 15;
};

message PTupleDescriptor {
    required int32 id = 1;
    required int32 byte_size = 2; // deprecated
    required int32 num_null_bytes = 3; // deprecated
    optional int64 table_id = 4;
    optional int32 num_null_slots = 5; // deprecated
};

message POlapTableIndexSchema {
    required int64 id = 1;
    repeated string columns = 2;
    required int32 schema_hash = 3;
    repeated ColumnPB columns_desc = 4;
    repeated TabletIndexPB indexes_desc = 5;
};

message POlapTableSchemaParam {
    required int64 db_id = 1;
    required int64 table_id = 2;
    required int64 version = 3;

    // Logical columns, contain all column that in logical table
    repeated PSlotDescriptor slot_descs = 4;
    required PTupleDescriptor tuple_desc = 5;
    repeated POlapTableIndexSchema indexes = 6;
    optional bool partial_update = 7 [default = false]; // deprecated, use unique_key_update_mode
    repeated string partial_update_input_columns = 8;
    optional bool is_strict_mode = 9 [default = false];
    optional string auto_increment_column = 10;
    optional int64 timestamp_ms = 11 [default = 0];
    optional string timezone = 12;
    optional int32 auto_increment_column_unique_id = 13 [default = -1];
    optional int32 nano_seconds = 14 [default = 0];
    optional UniqueKeyUpdateModePB unique_key_update_mode = 15 [default = UPSERT];
    optional int32 sequence_map_col_unique_id = 16 [default = -1];
    optional PartialUpdateNewRowPolicyPB partial_update_new_key_policy = 17 [default = APPEND];
};