Struct SchemaField 

pub struct SchemaField {
    pub name: String,
    pub data_type: KalamDataType,
    pub index: usize,
    pub flags: Option<BTreeSet<FieldFlag>>,
}

A field in the result schema returned by SQL queries

Contains all the information a client needs to properly interpret column data, including the name, data type, and index.

Example (JSON representation)

{
  "name": "user_id",
  "data_type": "BigInt",
  "index": 0,
  "flags": ["pk", "nn", "uq"]
}

Example (with parameterized type)

{
  "name": "vector",
  "data_type": { "Embedding": 384 },
  "index": 5
}

Fields

name: String

Column name

data_type: KalamDataType

Data type using KalamDB’s unified type system

index: usize

Column position (0-indexed) in the result set

flags: Option<BTreeSet<FieldFlag>>

Structured field flags (e.g. [“pk”, “nn”, “uq”]).

Omitted when there are no notable flags to reduce response size.

Implementations

impl SchemaField

pub fn new( name: impl Into<String>, data_type: KalamDataType, index: usize, ) -> SchemaField

Create a new schema field

pub fn from_column_definition( column: &ColumnDefinition, index: usize, ) -> SchemaField

pub fn with_flags(self, flags: BTreeSet<FieldFlag>) -> SchemaField

pub fn flags_for_column( is_primary_key: bool, is_nullable: bool, ) -> Option<BTreeSet<FieldFlag>>

Trait Implementations

impl Clone for SchemaField

fn clone(&self) -> SchemaField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SchemaField

fn deserialize<__D>( __deserializer: __D, ) -> Result<SchemaField, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SchemaField

impl PartialEq for SchemaField

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

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 StructuralPartialEq for SchemaField