Enum DataType

pub enum DataType {
    Boolean,
    Int16,
    Int32,
    Int64,
    Float32,
    Float64,
    Decimal,
    Date,
    Varchar,
    Time,
    Timestamp,
    Timestamptz,
    Interval,
    Struct(StructType),
    List(Box<DataType>),
    Bytea,
    Jsonb,
    Serial,
    Int256,
    Map(MapType),
}

The set of datatypes that are supported in RisingWave.

Trait implementations

• EnumDiscriminants generates DataTypeName enum with the same variants, but without data fields.
• FromStr is only used internally for tests. The generated implementation isn’t efficient, and doesn’t handle whitespaces, etc.

Variants

Boolean

Int16

Int32

Int64

Float32

Float64

Decimal

Date

Varchar

Time

Timestamp

Timestamptz

Interval

Struct(StructType)

List(Box<DataType>)

Bytea

Jsonb

Serial

Int256

Map(MapType)

Implementations

impl DataType

Get type information compatible with Postgres type, such as oid, type length.

pub fn type_len(&self) -> i16

For a fixed-size type, typlen is the number of bytes in the internal representation of the type. But for a variable-length type, typlen is negative. -1 indicates a “varlena” type (one that has a length word), -2 indicates a null-terminated C string.

https://www.postgresql.org/docs/15/catalog-pg-type.html#:~:text=of%20the%20type-,typlen,-int2

pub fn from_oid(oid: i32) -> Result<Self, UnsupportedOid>

pub fn to_oid(&self) -> i32

Refer to Self::from_oid

pub fn pg_name(&self) -> &'static str

pub fn to_pg_type(&self) -> PgType

impl DataType

pub fn create_array_builder(&self, capacity: usize) -> ArrayBuilderImpl

pub fn type_name(&self) -> DataTypeName

pub fn prost_type_name(&self) -> PbTypeName

pub fn to_protobuf(&self) -> PbDataType

pub fn is_numeric(&self) -> bool

pub fn is_simple(&self) -> bool

Returns whether the data type does not have inner fields.

pub fn is_composite(&self) -> bool

Returns whether the data type has inner fields.

pub fn is_array(&self) -> bool

pub fn is_struct(&self) -> bool

pub fn is_map(&self) -> bool

pub fn is_int(&self) -> bool

pub fn window_of(input: &DataType) -> Option<DataType>

Returns the output type of time window function on a given input type.

pub fn as_struct(&self) -> &StructType

pub fn as_map(&self) -> &MapType

pub fn into_map(self) -> MapType

pub fn as_list(&self) -> &DataType

Returns the inner element’s type of a list type.

Panics

Panics if the type is not a list type.

pub fn unnest_list(&self) -> &Self

Return a new type that removes the outer list, and get the innermost element type.

Use DataType::as_list if you only want the element type of a list.

use risingwave_common::types::DataType::*;
assert_eq!(List(Box::new(Int32)).unnest_list(), &Int32);
assert_eq!(List(Box::new(List(Box::new(Int32)))).unnest_list(), &Int32);

pub fn array_ndims(&self) -> usize

Return the number of dimensions of this array/list type. Return 0 when this type is not an array/list.

pub fn equals_datatype(&self, other: &DataType) -> bool

Compares the datatype with another, ignoring nested field names and ids.

pub fn can_alter(&self) -> Option<bool>

Whether a column with this data type can be altered to a new data type. This determines the encoding of the column data.

Returns…

• None, if the data type is simple or does not contain a struct type.
• Some(true), if the data type contains a struct type with field ids (StructType::has_ids).
• Some(false), if the data type contains a struct type without field ids.

Trait Implementations

impl Clone for DataType

fn clone(&self) -> DataType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataType

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

Formats the value using the given formatter.

impl Display for DataType

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

Formats the value using the given formatter.

impl From<&DataType> for DataType

fn from(proto: &PbDataType) -> DataType

Converts to this type from the input type.

impl<'_enum> From<&'_enum DataType> for DataTypeName

fn from(val: &'_enum DataType) -> DataTypeName

Converts to this type from the input type.

impl From<DataType> for PbDataType

fn from(data_type: DataType) -> Self

Converts to this type from the input type.

impl From<DataType> for DataTypeName

fn from(val: DataType) -> DataTypeName

Converts to this type from the input type.

impl From<MapType> for DataType

fn from(value: MapType) -> Self

Converts to this type from the input type.

impl From<StructType> for DataType

fn from(value: StructType) -> Self

Converts to this type from the input type.

impl FromStr for Box<DataType>

type Err = Box<dyn Error + Send + Sync>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromStr for DataType

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DataType

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

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 IntoDiscriminant for DataType

type Discriminant = DataTypeName

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant

impl Ord for DataType

fn cmp(&self, other: &DataType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DataType

fn eq(&self, other: &DataType) -> 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 PartialOrd for DataType

fn partial_cmp(&self, other: &DataType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<DataTypeName> for DataType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(type_name: DataTypeName) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DataType

impl StructuralPartialEq for DataType

impl ZeroHeapSize for DataType