Struct QueryInput

#[non_exhaustive]
pub struct QueryInput {
    pub query_string: Option<String>,
    pub client_token: Option<String>,
    pub next_token: Option<String>,
    pub max_rows: Option<i32>,
    pub query_insights: Option<QueryInsights>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

query_string: Option<String>

The query to be run by Timestream.

client_token: Option<String>

Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:

• If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query is assumed to be a new query run.

• If the invocation contains NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned.

• After 4 hours, any request with the same ClientToken is treated as a new request.

next_token: Option<String>

A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query is assumed to be a new query run.

Note the following when using NextToken in a query:

• A pagination token can be used for up to five Query invocations, OR for a duration of up to 1 hour – whichever comes first.

• Using the same NextToken will return the same set of records. To keep paginating through the result set, you must to use the most recent nextToken.

• Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA is invalidated and cannot be reused.

• To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.

• The latest NextToken should be used to paginate until null is returned, at which point a new NextToken should be used.

• If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.

max_rows: Option<i32>

The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows value specified will return the result set of the query in two cases:

• The size of the result is less than 1MB.

• The number of rows in the result set is less than the value of maxRows.

Otherwise, the initial invocation of Query only returns a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken value in the subsequent command.

If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit.

query_insights: Option<QueryInsights>

Encapsulates settings for enabling QueryInsights.

Enabling QueryInsights returns insights and metrics in addition to query results for the query that you executed. You can use QueryInsights to tune your query performance.

Implementations

impl QueryInput

pub fn query_string(&self) -> Option<&str>

The query to be run by Timestream.

pub fn client_token(&self) -> Option<&str>

Unique, case-sensitive string of up to 64 ASCII characters specified when a Query request is made. Providing a ClientToken makes the call to Query idempotent. This means that running the same query repeatedly will produce the same result. In other words, making multiple identical Query requests has the same effect as making a single request. When using ClientToken in a query, note the following:

• If the Query API is instantiated without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• If the Query invocation only contains the ClientToken but does not include a NextToken, that invocation of Query is assumed to be a new query run.

• If the invocation contains NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to the Query API, and a result set is returned.

• After 4 hours, any request with the same ClientToken is treated as a new request.

pub fn next_token(&self) -> Option<&str>

A pagination token used to return a set of results. When the Query API is invoked using NextToken, that particular invocation is assumed to be a subsequent invocation of a prior call to Query, and a result set is returned. However, if the Query invocation only contains the ClientToken, that invocation of Query is assumed to be a new query run.

Note the following when using NextToken in a query:

• A pagination token can be used for up to five Query invocations, OR for a duration of up to 1 hour – whichever comes first.

• Using the same NextToken will return the same set of records. To keep paginating through the result set, you must to use the most recent nextToken.

• Suppose a Query invocation returns two NextToken values, TokenA and TokenB. If TokenB is used in a subsequent Query invocation, then TokenA is invalidated and cannot be reused.

• To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.

• The latest NextToken should be used to paginate until null is returned, at which point a new NextToken should be used.

• If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an Invalid pagination token error.

pub fn max_rows(&self) -> Option<i32>

The total number of rows to be returned in the Query output. The initial run of Query with a MaxRows value specified will return the result set of the query in two cases:

• The size of the result is less than 1MB.

• The number of rows in the result set is less than the value of maxRows.

Otherwise, the initial invocation of Query only returns a NextToken, which can then be used in subsequent calls to fetch the result set. To resume pagination, provide the NextToken value in the subsequent command.

If the row size is large (e.g. a row has many columns), Timestream may return fewer rows to keep the response size from exceeding the 1 MB limit. If MaxRows is not provided, Timestream will send the necessary number of rows to meet the 1 MB limit.

pub fn query_insights(&self) -> Option<&QueryInsights>

Encapsulates settings for enabling QueryInsights.

Enabling QueryInsights returns insights and metrics in addition to query results for the query that you executed. You can use QueryInsights to tune your query performance.

impl QueryInput

pub fn builder() -> QueryInputBuilder

Creates a new builder-style object to manufacture QueryInput.

Trait Implementations

impl Clone for QueryInput

fn clone(&self) -> QueryInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryInput

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

Formats the value using the given formatter.

impl PartialEq for QueryInput

fn eq(&self, other: &QueryInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 StructuralPartialEq for QueryInput