Struct GlobalSecondaryIndex 

pub struct GlobalSecondaryIndex {
    pub name: String,
    pub partition_key_attribute: String,
    pub sort_key_attribute: Option<String>,
    pub projection: IndexProjection,
}

Global Secondary Index definition (Phase 3.2+)

GSI can use different partition key and sort key from the base table.

Fields

name: String

Index name (unique per table)

partition_key_attribute: String

Attribute name to use as partition key

sort_key_attribute: Option<String>

Optional attribute name to use as sort key

projection: IndexProjection

Which attributes to project into the index

Implementations

impl GlobalSecondaryIndex

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

Create a new GSI with partition key only

pub fn with_sort_key( name: impl Into<String>, partition_key_attribute: impl Into<String>, sort_key_attribute: impl Into<String>, ) -> Self

Create a new GSI with partition key and sort key

pub fn keys_only(self) -> Self

Set projection to keys only

pub fn include(self, attributes: Vec<String>) -> Self

Set projection to include specific attributes

Trait Implementations

impl Clone for GlobalSecondaryIndex

fn clone(&self) -> GlobalSecondaryIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalSecondaryIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GlobalSecondaryIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GlobalSecondaryIndex

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

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 GlobalSecondaryIndex

impl StructuralPartialEq for GlobalSecondaryIndex