Struct ColumnType

pub struct ColumnType {
    pub typ: SqlType,
    pub nullable: bool,
    pub precision: Option<i64>,
    pub scale: Option<i64>,
    pub component: Option<Box<ColumnType>>,
    pub fields: Option<Vec<Field>>,
    pub key: Option<Box<ColumnType>>,
    pub value: Option<Box<ColumnType>>,
}

A SQL column type description.

Matches the Calcite JSON format.

Fields

typ: SqlType

Identifier for the type (e.g., VARCHAR, BIGINT, ARRAY etc.)

nullable: bool

Does the type accept NULL values?

precision: Option<i64>

Precision of the type.

Examples

• VARCHAR sets precision to -1.
• VARCHAR(255) sets precision to 255.
• BIGINT, DATE, FLOAT, DOUBLE, GEOMETRY, etc. sets precision to None
• TIME, TIMESTAMP set precision to 0.

scale: Option<i64>

The scale of the type.

Example

• DECIMAL(1,2) sets scale to 2.

component: Option<Box<ColumnType>>

A component of the type (if available).

This is in a Box because it makes it a recursive types.

For example, this would specify the VARCHAR(20) in the VARCHAR(20) ARRAY type.

fields: Option<Vec<Field>>

The fields of the type (if available).

For example this would specify the fields of a CREATE TYPE construct.

CREATE TYPE person_typ AS (
  firstname       VARCHAR(30),
  lastname        VARCHAR(30),
  address         ADDRESS_TYP
);

Would lead to the following fields value:

[
 ColumnType { name: "firstname, ... },
 ColumnType { name: "lastname", ... },
 ColumnType { name: "address", fields: [ ... ] }
]

key: Option<Box<ColumnType>>

Key type; must be set when type == "MAP".

value: Option<Box<ColumnType>>

Value type; must be set when type == "MAP".

Implementations

impl ColumnType

pub fn boolean(nullable: bool) -> Self

pub fn tinyint(nullable: bool) -> Self

pub fn smallint(nullable: bool) -> Self

pub fn int(nullable: bool) -> Self

pub fn bigint(nullable: bool) -> Self

pub fn double(nullable: bool) -> Self

pub fn real(nullable: bool) -> Self

pub fn decimal(precision: i64, scale: i64, nullable: bool) -> Self

pub fn varchar(nullable: bool) -> Self

pub fn varbinary(nullable: bool) -> Self

pub fn fixed(width: i64, nullable: bool) -> Self

pub fn date(nullable: bool) -> Self

pub fn time(nullable: bool) -> Self

pub fn timestamp(nullable: bool) -> Self

pub fn variant(nullable: bool) -> Self

pub fn array(nullable: bool, element: ColumnType) -> Self

pub fn structure(nullable: bool, fields: &[Field]) -> Self

pub fn map(nullable: bool, key: ColumnType, val: ColumnType) -> Self

pub fn is_integral_type(&self) -> bool

pub fn is_fp_type(&self) -> bool

pub fn is_decimal_type(&self) -> bool

pub fn is_numeric_type(&self) -> bool

Trait Implementations

impl Clone for ColumnType

fn clone(&self) -> ColumnType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColumnType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ColumnType

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for ColumnType

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for ColumnType

impl StructuralPartialEq for ColumnType