TableSchema

Struct TableSchema 

Source
pub struct TableSchema {
    pub local_indexes: Vec<LocalSecondaryIndex>,
    pub global_indexes: Vec<GlobalSecondaryIndex>,
    pub ttl_attribute_name: Option<String>,
    pub stream_config: StreamConfig,
}
Expand description

Table schema with index definitions

Fields§

§local_indexes: Vec<LocalSecondaryIndex>

Local secondary indexes

§global_indexes: Vec<GlobalSecondaryIndex>

Global secondary indexes (Phase 3.2+)

§ttl_attribute_name: Option<String>

TTL attribute name (Phase 3.3+) When set, items with this attribute containing a timestamp in the past are considered expired

§stream_config: StreamConfig

Stream configuration (Phase 3.4+)

Implementations§

Source§

impl TableSchema

Source

pub fn new() -> Self

Create an empty schema

Source

pub fn add_local_index(self, index: LocalSecondaryIndex) -> Self

Add a local secondary index

Source

pub fn get_local_index(&self, name: &str) -> Option<&LocalSecondaryIndex>

Get LSI by name

Source

pub fn add_global_index(self, index: GlobalSecondaryIndex) -> Self

Add a global secondary index (Phase 3.2+)

Source

pub fn get_global_index(&self, name: &str) -> Option<&GlobalSecondaryIndex>

Get GSI by name (Phase 3.2+)

Source

pub fn with_ttl(self, attribute_name: impl Into<String>) -> Self

Enable TTL (Time To Live) with the specified attribute name (Phase 3.3+)

Items with this attribute containing a Unix timestamp (seconds since epoch) in the past will be considered expired and automatically deleted.

Source

pub fn with_stream(self, config: StreamConfig) -> Self

Enable streams (Change Data Capture) with the specified configuration (Phase 3.4+)

Streams capture all item-level modifications (INSERT, MODIFY, REMOVE) and make them available for processing.

Source

pub fn is_expired(&self, item: &Item) -> bool

Check if an item is expired based on TTL (Phase 3.3+)

Returns true if:

  • TTL is enabled AND
  • Item has the TTL attribute AND
  • The TTL timestamp is in the past

Trait Implementations§

Source§

impl Clone for TableSchema

Source§

fn clone(&self) -> TableSchema

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TableSchema

Source§

fn default() -> TableSchema

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TableSchema

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TableSchema

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,