Struct TableSchemaSnapshot 

pub struct TableSchemaSnapshot {
    pub version: u8,
    pub name: String,
    pub primary_key: String,
    pub alignment: u32,
    pub columns: Vec<ColumnSnapshot>,
    pub indexes: Vec<IndexSnapshot>,
}

Frozen, comparable view of a TableSchema used for migration detection.

A snapshot captures the structural shape of a table at a point in time so that two versions can be diffed to derive the migration steps required to bring the on-disk representation up to date with the current schema definition.

Fields

version: u8

Version tag of the snapshot binary layout, see [SCHEMA_SNAPSHOT_VERSION].

name: String

Name of the table this snapshot was taken from.

primary_key: String

Name of the column declared as primary key.

alignment: u32

Record alignment, in bytes, used for on-disk layout.

columns: Vec<ColumnSnapshot>

Snapshots of every column in declaration order.

indexes: Vec<IndexSnapshot>

Snapshots of every secondary index defined on the table.

Implementations

impl TableSchemaSnapshot

pub fn latest_version() -> u8

Returns the latest version of the snapshot format.

Trait Implementations

impl CandidType for TableSchemaSnapshot

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

fn idl_serialize<__S>( &self, __serializer: __S, ) -> Result<(), <__S as Serializer>::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for TableSchemaSnapshot

fn clone(&self) -> TableSchemaSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableSchemaSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableSchemaSnapshot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for TableSchemaSnapshot

const ALIGNMENT: u16 = 32

The alignment requirement in bytes for the data type.

const SIZE: DataSize = DataSize::Dynamic

The size characteristic of the data type.

fn size(&self) -> u16

Returns the size in bytes of the encoded data type.

fn encode(&self) -> Cow<'_, [u8]>

Encodes the data type into a vector of bytes.

fn decode(data: Cow<'_, [u8]>) -> Result<TableSchemaSnapshot, MemoryError>

where TableSchemaSnapshot: Sized,

Decodes the data type from a slice of bytes.

impl PartialEq for TableSchemaSnapshot

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

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 Eq for TableSchemaSnapshot

impl StructuralPartialEq for TableSchemaSnapshot