Struct FieldDefinition 

pub struct FieldDefinition {
    pub name: String,
    pub field_type: FieldType,
    pub assertion: Option<String>,
    pub default: Option<String>,
    pub value: Option<String>,
    pub permissions: Option<BTreeMap<String, String>>,
    pub readonly: bool,
    pub flexible: bool,
}

Immutable field definition for table schemas.

Represents a single field in a SurrealDB table schema along with its constraints, defaults, and permissions.

Examples

use surql::schema::{FieldDefinition, FieldType};

let email = FieldDefinition::new("email", FieldType::String);
assert_eq!(email.to_surql("user"), "DEFINE FIELD email ON TABLE user TYPE string;");

Fields

name: String

Field name (supports dot notation for nested fields).

field_type: FieldType

Field type.

assertion: Option<String>

Optional SurrealQL assertion expression.

default: Option<String>

Optional default value expression.

value: Option<String>

Optional computed-value expression.

permissions: Option<BTreeMap<String, String>>

Optional per-action permission rules keyed by action name.

readonly: bool

Whether the field is read-only after creation.

flexible: bool

Whether the field allows flexible schema.

Implementations

impl FieldDefinition

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

Construct a new FieldDefinition with only the required members.

Other members default to empty/false and can be set via chainable with_* setters.

pub fn with_assertion(self, assertion: impl Into<String>) -> Self

Set the assertion expression.

pub fn with_default(self, default: impl Into<String>) -> Self

Set the default value expression.

pub fn with_value(self, value: impl Into<String>) -> Self

Set the computed-value expression.

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

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

Attach per-action permissions.

pub fn readonly(self, readonly: bool) -> Self

Mark the field as read-only.

pub fn flexible(self, flexible: bool) -> Self

Mark the field as flexible.

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

Validate the field definition against SurrealDB identifier rules.

Returns SurqlError::Validation for an empty name, empty segments, or segments that contain invalid characters.

pub fn to_surql(&self, table: &str) -> String

Render the DEFINE FIELD statement for this field on the given table.

Examples

use surql::schema::{FieldDefinition, FieldType};

let f = FieldDefinition::new("email", FieldType::String)
    .with_assertion("string::is::email($value)");
assert_eq!(
    f.to_surql("user"),
    "DEFINE FIELD email ON TABLE user TYPE string ASSERT string::is::email($value);",
);

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

Render with optional IF NOT EXISTS clause.

Trait Implementations

impl Clone for FieldDefinition

fn clone(&self) -> FieldDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldDefinition

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

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 FieldDefinition

impl StructuralPartialEq for FieldDefinition