Enum OperationSpec 

pub enum OperationSpec {
    DefineSchema {
        schema: SchemaInfo,
    },
    AddAttribute {
        attribute: AttributeSchemaEntry,
    },
    RemoveAttribute {
        attr_name: String,
    },
    AddEntity {
        entity: EntitySchemaEntry,
    },
    RemoveEntity {
        type_name: String,
    },
    AddRelation {
        relation: RelationSchemaEntry,
    },
    RemoveRelation {
        type_name: String,
    },
    AddOwnership {
        owner_type: String,
        attribute: OwnedAttributeEntry,
    },
    RemoveOwnership {
        owner_type: String,
        attr_name: String,
    },
    ModifyOwnership {
        owner_type: String,
        attr_name: String,
        old_annotations: String,
        new_annotations: String,
    },
    ModifyTypeAnnotations {
        type_name: String,
        old_doc: Option<String>,
        new_doc: Option<String>,
        old_meta: BTreeMap<String, String>,
        new_meta: BTreeMap<String, String>,
    },
    ModifyRoleAnnotations {
        relation_type: String,
        role_name: String,
        old_doc: Option<String>,
        new_doc: Option<String>,
        old_meta: BTreeMap<String, String>,
        new_meta: BTreeMap<String, String>,
    },
    AddRole {
        relation_type: String,
        role: RoleEntry,
    },
    RemoveRole {
        relation_type: String,
        role_name: String,
    },
    AddRolePlayer {
        relation_type: String,
        role_name: String,
        player_type_name: String,
    },
    RemoveRolePlayer {
        relation_type: String,
        role_name: String,
        player_type_name: String,
    },
    RunTypeql {
        forward: String,
        reverse: Option<String>,
    },
    RenameAttribute {
        old_name: String,
        new_name: String,
        value_type: String,
    },
    CopyAttribute {
        owner: Option<String>,
        source: Option<String>,
        dest: Option<String>,
        filter: Option<String>,
        forward: Option<String>,
        reverse: Option<String>,
    },
}

Operation variants covering the frozen Python ops.* authoring surface.

Variants

DefineSchema

Define the complete schema for a model-based initial migration.

Fields

schema: SchemaInfo

Complete model schema.

AddAttribute

Add a standalone attribute type.

Fields

attribute: AttributeSchemaEntry

Attribute schema payload.

RemoveAttribute

Remove a standalone attribute type.

Fields

attr_name: String

Attribute type name.

AddEntity

Add an entity type.

Fields

entity: EntitySchemaEntry

Entity schema payload.

RemoveEntity

Remove an entity type.

Fields

type_name: String

Entity type name.

AddRelation

Add a relation type.

Fields

relation: RelationSchemaEntry

Relation schema payload.

RemoveRelation

Remove a relation type.

Fields

type_name: String

Relation type name.

AddOwnership

Add attribute ownership to an entity or relation.

Fields

owner_type: String

Owning entity or relation type name.

attribute: OwnedAttributeEntry

Owned attribute payload.

RemoveOwnership

Remove attribute ownership from an entity or relation.

Fields

owner_type: String

Owning entity or relation type name.

attr_name: String

Attribute type name.

ModifyOwnership

Modify ownership annotations.

Fields

owner_type: String

Owning entity or relation type name.

attr_name: String

Attribute type name.

old_annotations: String

Previous annotations as authored by Python.

new_annotations: String

New annotations as authored by Python.

ModifyTypeAnnotations

Modify @doc/@meta annotations on an entity, relation, or attribute type (TypeDB 3.12+).

Fields

type_name: String

Type name (entity, relation, or attribute type).

old_doc: Option<String>

Previous @doc value.

new_doc: Option<String>

New @doc value.

old_meta: BTreeMap<String, String>

Previous @meta annotations, keyed by meta key.

new_meta: BTreeMap<String, String>

New @meta annotations, keyed by meta key.

ModifyRoleAnnotations

Modify @doc/@meta annotations on a relation role (TypeDB 3.12+).

Fields

relation_type: String

Relation type name.

role_name: String

Role name.

old_doc: Option<String>

Previous @doc value.

new_doc: Option<String>

New @doc value.

old_meta: BTreeMap<String, String>

Previous @meta annotations, keyed by meta key.

new_meta: BTreeMap<String, String>

New @meta annotations, keyed by meta key.

AddRole

Add a role to a relation.

Fields

relation_type: String

Relation type name.

role: RoleEntry

Role payload.

RemoveRole

Remove a role from a relation.

Fields

relation_type: String

Relation type name.

role_name: String

Role name.

AddRolePlayer

Add a player type to a role.

Fields

relation_type: String

Relation type name.

role_name: String

Role name.

player_type_name: String

Player type name.

RemoveRolePlayer

Remove a player type from a role.

Fields

relation_type: String

Relation type name.

role_name: String

Role name.

player_type_name: String

Player type name.

RunTypeql

Execute authored TypeQL without interpreting it in this sub-plan.

Fields

forward: String

Forward TypeQL text.

reverse: Option<String>

Optional rollback TypeQL text.

RenameAttribute

Rename an attribute type.

Fields

old_name: String

Previous attribute type name.

new_name: String

New attribute type name.

value_type: String

TypeDB value type.

CopyAttribute

Copy an attribute from source to dest on every instance of the owner type.

This is a DML (write-typed) backfill operation — it inserts attribute values, not schema. The forward TypeQL is an insert-if-absent backfill; the reverse deletes the destination attribute.

Two wire forms exist. The lowered form carries only forward/reverse TypeQL (what .py execution lowers to); the structured form carries owner/source/dest(/filter) and lets the authoring core synthesize the TypeQL via copy_attribute_typeql and render a faithful ops.CopyAttribute(...) in the generated .py. Sidecars written by the authoring core always carry the synthesized strings, so the executor keeps running carried TypeQL.

Fields

owner: Option<String>

Owner type label (structured portable form).

source: Option<String>

Source attribute label (structured portable form).

dest: Option<String>

Destination attribute label (structured portable form).

filter: Option<String>

Optional extra match constraint line (structured portable form).

forward: Option<String>

Forward backfill TypeQL. Absent only in the structured form before normalization; the executor derives its count queries from this string’s match clause.

reverse: Option<String>

Reverse (rollback) TypeQL from to_rollback_typeql(), or None when the migration is irreversible.

Implementations

impl OperationSpec

pub fn normalized(self) -> Result<OperationSpec>

Return the operation with any structured copy_attribute filled in with its synthesized executable TypeQL. Other variants pass through.

Errors

crate::error::MigrationError::AuthoringInput when a copy_attribute carries neither TypeQL nor the structured fields.

Trait Implementations

impl Clone for OperationSpec

fn clone(&self) -> OperationSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OperationSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OperationSpec

fn eq(&self, other: &OperationSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OperationSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OperationSpec