Struct aws_sdk_dynamodb::model::KeySchemaElement
source · [−]#[non_exhaustive]pub struct KeySchemaElement {
pub attribute_name: Option<String>,
pub key_type: Option<KeyType>,
}
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.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.attribute_name: Option<String>
The name of a key attribute.
key_type: 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.
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
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for KeySchemaElement
impl Debug for KeySchemaElement
sourceimpl PartialEq<KeySchemaElement> for KeySchemaElement
impl PartialEq<KeySchemaElement> for KeySchemaElement
sourcefn eq(&self, other: &KeySchemaElement) -> bool
fn eq(&self, other: &KeySchemaElement) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &KeySchemaElement) -> bool
fn ne(&self, other: &KeySchemaElement) -> bool
This method tests for !=
.
impl StructuralPartialEq for KeySchemaElement
Auto Trait Implementations
impl RefUnwindSafe for KeySchemaElement
impl Send for KeySchemaElement
impl Sync for KeySchemaElement
impl Unpin for KeySchemaElement
impl UnwindSafe for KeySchemaElement
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more