Struct aws_sdk_dynamodb::model::KeySchemaElement
source · [−]#[non_exhaustive]pub struct KeySchemaElement { /* private fields */ }
Expand description
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement
represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement
(for the partition key). A composite primary key would require one KeySchemaElement
for the partition key, and another KeySchemaElement
for the sort key.
A KeySchemaElement
must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
Implementations
sourceimpl KeySchemaElement
impl KeySchemaElement
sourcepub fn attribute_name(&self) -> Option<&str>
pub fn attribute_name(&self) -> Option<&str>
The name of a key attribute.
sourcepub fn key_type(&self) -> Option<&KeyType>
pub fn key_type(&self) -> Option<&KeyType>
The role that this key attribute will assume:
-
HASH
- partition key -
RANGE
- sort key
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
sourceimpl KeySchemaElement
impl KeySchemaElement
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture KeySchemaElement
.
Trait Implementations
sourceimpl Clone for KeySchemaElement
impl Clone for KeySchemaElement
sourcefn clone(&self) -> KeySchemaElement
fn clone(&self) -> KeySchemaElement
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more