Struct aws_sdk_dynamodb::operation::query::QueryOutput
source · #[non_exhaustive]pub struct QueryOutput {
pub items: Option<Vec<HashMap<String, AttributeValue>>>,
pub count: i32,
pub scanned_count: i32,
pub last_evaluated_key: Option<HashMap<String, AttributeValue>>,
pub consumed_capacity: Option<ConsumedCapacity>,
/* private fields */
}
Expand description
Represents the output of a Query
operation.
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.items: Option<Vec<HashMap<String, AttributeValue>>>
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
count: i32
The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items returned after the filter was applied, and ScannedCount
is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the same.
scanned_count: i32
The number of items evaluated, before any QueryFilter
is applied. A high ScannedCount
value with few, or no, Count
results indicates an inefficient Query
operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as Count
.
last_evaluated_key: Option<HashMap<String, AttributeValue>>
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
consumed_capacity: Option<ConsumedCapacity>
The capacity units consumed by the Query
operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
Implementations§
source§impl QueryOutput
impl QueryOutput
sourcepub fn items(&self) -> &[HashMap<String, AttributeValue>]
pub fn items(&self) -> &[HashMap<String, AttributeValue>]
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .items.is_none()
.
sourcepub fn count(&self) -> i32
pub fn count(&self) -> i32
The number of items in the response.
If you used a QueryFilter
in the request, then Count
is the number of items returned after the filter was applied, and ScannedCount
is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count
and ScannedCount
are the same.
sourcepub fn scanned_count(&self) -> i32
pub fn scanned_count(&self) -> i32
The number of items evaluated, before any QueryFilter
is applied. A high ScannedCount
value with few, or no, Count
results indicates an inefficient Query
operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount
is the same as Count
.
sourcepub fn last_evaluated_key(&self) -> Option<&HashMap<String, AttributeValue>>
pub fn last_evaluated_key(&self) -> Option<&HashMap<String, AttributeValue>>
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.
If LastEvaluatedKey
is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey
is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
is empty.
sourcepub fn consumed_capacity(&self) -> Option<&ConsumedCapacity>
pub fn consumed_capacity(&self) -> Option<&ConsumedCapacity>
The capacity units consumed by the Query
operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity
is only returned if the ReturnConsumedCapacity
parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
source§impl QueryOutput
impl QueryOutput
sourcepub fn builder() -> QueryOutputBuilder
pub fn builder() -> QueryOutputBuilder
Creates a new builder-style object to manufacture QueryOutput
.
Trait Implementations§
source§impl Clone for QueryOutput
impl Clone for QueryOutput
source§fn clone(&self) -> QueryOutput
fn clone(&self) -> QueryOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for QueryOutput
impl Debug for QueryOutput
source§impl PartialEq for QueryOutput
impl PartialEq for QueryOutput
source§fn eq(&self, other: &QueryOutput) -> bool
fn eq(&self, other: &QueryOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for QueryOutput
impl RequestId for QueryOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.