Struct ColumnDesc

pub struct ColumnDesc {
    pub column_type: Option<DataType>,
    pub column_id: i32,
    pub name: String,
    pub field_descs: Vec<ColumnDesc>,
    pub type_name: String,
    pub description: Option<String>,
    pub additional_column_type: i32,
    pub version: i32,
    pub additional_column: Option<AdditionalColumn>,
    pub generated_or_default_column: Option<GeneratedOrDefaultColumn>,
}

Fields

column_type: Option<DataType>

column_id: i32

name: String

we store the column name in column desc now just for debug, but in future we should store it in ColumnCatalog but not here

field_descs: Vec<ColumnDesc>

For STRUCT type.

type_name: String

The user-defined type’s name. Empty if the column type is a builtin type. For example, when the type is created from a protobuf schema file, this field will store the message name.

description: Option<String>

This field is used to store the description set by the comment on clause.

additional_column_type: i32

deprecated, use AdditionalColumn instead, keep for compatibility with v1.6.x

version: i32

additional_column: Option<AdditionalColumn>

generated_or_default_column: Option<GeneratedOrDefaultColumn>

Optional description for the generated column or default value.

Implementations

impl ColumnDesc

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn additional_column_type(&self) -> AdditionalColumnType

Returns the enum value of additional_column_type, or the default if the field is set to an invalid enum value.

pub fn set_additional_column_type(&mut self, value: AdditionalColumnType)

Sets additional_column_type to the provided enum value.

pub fn version(&self) -> ColumnDescVersion

Returns the enum value of version, or the default if the field is set to an invalid enum value.

pub fn set_version(&mut self, value: ColumnDescVersion)

Sets version to the provided enum value.

impl ColumnDesc

pub fn get_column_type(&self) -> Result<&DataType, PbFieldNotFound>

pub fn get_column_id(&self) -> i32

pub fn get_name(&self) -> &String

pub fn get_field_descs(&self) -> &Vec<ColumnDesc>

pub fn get_type_name(&self) -> &String

pub fn get_description(&self) -> Result<&String, PbFieldNotFound>

pub fn get_additional_column_type( &self, ) -> Result<AdditionalColumnType, PbFieldNotFound>

pub fn get_version(&self) -> Result<ColumnDescVersion, PbFieldNotFound>

pub fn get_additional_column( &self, ) -> Result<&AdditionalColumn, PbFieldNotFound>

pub fn get_generated_or_default_column( &self, ) -> Result<&GeneratedOrDefaultColumn, PbFieldNotFound>

Trait Implementations

impl Clone for ColumnDesc

fn clone(&self) -> ColumnDesc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ColumnDescTestExt for ColumnDesc

fn new_atomic(data_type: DataType, name: &str, column_id: i32) -> ColumnDesc

Create a ColumnDesc with the given name and type.

fn new_struct( name: &str, column_id: i32, type_name: &str, fields: Vec<ColumnDesc>, ) -> ColumnDesc

Create a ColumnDesc with Struct type.

impl Debug for ColumnDesc

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ColumnDesc

fn default() -> ColumnDesc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ColumnDesc

fn deserialize<D>( deserializer: D, ) -> Result<ColumnDesc, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ColumnDesc> for ColumnDesc

fn from(c: &ColumnDesc) -> ColumnDesc

Converts to this type from the input type.

impl Hash for ColumnDesc

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ColumnDesc

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ColumnDesc

fn eq(&self, other: &ColumnDesc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ColumnDesc

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ColumnDesc

impl StructuralPartialEq for ColumnDesc