Struct OnchainDataColumnSchema 

pub struct OnchainDataColumnSchema {
    pub description: Option<Description>,
    pub index_order: Option<i64>,
    pub name: Option<String>,
    pub nullable: Option<bool>,
    pub type_: Option<String>,
}

Schema definition for a table column.

JSON schema

{
 "description": "Schema definition for a table column.",
 "examples": [
   {
     "description": "The signature of the decoded event log.",
     "indexOrder": 0,
     "name": "event_signature",
     "nullable": false,
     "type": "String"
   }
 ],
 "type": "object",
 "properties": {
   "description": {
     "description": "Human-readable description of the column.",
     "examples": [
       "The signature of the decoded event log."
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/Description"
       }
     ]
   },
   "indexOrder": {
     "description": "The order of the column in the index. A lower number means the column is more important for the index and should be first in the query.",
     "examples": [
       0
     ],
     "type": "integer"
   },
   "name": {
     "description": "Column name.",
     "examples": [
       "event_signature"
     ],
     "type": "string"
   },
   "nullable": {
     "description": "Whether this column can contain NULL values.",
     "examples": [
       false
     ],
     "type": "boolean"
   },
   "type": {
     "description": "Column data type.",
     "examples": [
       "String"
     ],
     "type": "string"
   }
 }
}

Fields

description: Option<Description>

Human-readable description of the column.

index_order: Option<i64>

The order of the column in the index. A lower number means the column is more important for the index and should be first in the query.

name: Option<String>

Column name.

nullable: Option<bool>

Whether this column can contain NULL values.

type_: Option<String>

Column data type.

Implementations

impl OnchainDataColumnSchema

pub fn builder() -> OnchainDataColumnSchema

Trait Implementations

impl Clone for OnchainDataColumnSchema

fn clone(&self) -> OnchainDataColumnSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnchainDataColumnSchema

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

Formats the value using the given formatter.

impl Default for OnchainDataColumnSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OnchainDataColumnSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OnchainDataColumnSchema> for OnchainDataColumnSchema

fn from(value: &OnchainDataColumnSchema) -> Self

Converts to this type from the input type.

impl From<OnchainDataColumnSchema> for OnchainDataColumnSchema

fn from(value: OnchainDataColumnSchema) -> Self

Converts to this type from the input type.

impl Serialize for OnchainDataColumnSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<OnchainDataColumnSchema> for OnchainDataColumnSchema

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: OnchainDataColumnSchema) -> Result<Self, ConversionError>

Performs the conversion.