Struct TableDefinition 

pub struct TableDefinition {
    pub name: String,
    pub mode: TableMode,
    pub fields: Vec<FieldDefinition>,
    pub indexes: Vec<IndexDefinition>,
    pub events: Vec<EventDefinition>,
    pub permissions: Option<BTreeMap<String, String>>,
    pub drop: bool,
}

Immutable table schema.

Fields

name: String

Table name.

mode: TableMode

Schema mode.

fields: Vec<FieldDefinition>

Field definitions.

indexes: Vec<IndexDefinition>

Index definitions.

events: Vec<EventDefinition>

Event definitions.

permissions: Option<BTreeMap<String, String>>

Per-action permissions map.

drop: bool

Whether this table is marked for deletion.

Implementations

impl TableDefinition

pub fn new(name: impl Into<String>) -> Self

Construct a new TableDefinition in SCHEMAFULL mode.

pub fn with_mode(self, mode: TableMode) -> Self

Set the schema mode.

pub fn with_fields<I>(self, fields: I) -> Self

where I: IntoIterator<Item = FieldDefinition>,

Append field definitions.

pub fn with_indexes<I>(self, indexes: I) -> Self

where I: IntoIterator<Item = IndexDefinition>,

Append index definitions.

pub fn with_events<I>(self, events: I) -> Self

where I: IntoIterator<Item = EventDefinition>,

Append event definitions.

pub fn with_permissions<I, K, V>(self, permissions: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Replace per-action permissions.

pub fn with_drop(self, drop: bool) -> Self

Mark the table for deletion.

pub fn validate(&self) -> Result<()>

Validate the table and its contained definitions.

pub fn to_surql(&self) -> String

Render just the DEFINE TABLE statement.

pub fn to_surql_with_options(&self, if_not_exists: bool) -> String

Render the DEFINE TABLE statement with optional IF NOT EXISTS.

pub fn to_surql_all(&self) -> Vec<String>

Render every statement required to create this table.

Returns the DEFINE TABLE line followed by each contained field, index, event, and permission statement.

pub fn to_surql_all_with_options(&self, if_not_exists: bool) -> Vec<String>

Render every statement with optional IF NOT EXISTS.

Trait Implementations

impl Clone for TableDefinition

fn clone(&self) -> TableDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TableDefinition

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TableDefinition

impl StructuralPartialEq for TableDefinition