import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient"; import type { QueryInput, QueryOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link QueryCommand}. */ export interface QueryCommandInput extends QueryInput { } /** * @public * * The output of {@link QueryCommand}. */ export interface QueryCommandOutput extends QueryOutput, __MetadataBearer { } declare const QueryCommand_base: { new (input: QueryCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: QueryCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

You must provide the name of the partition key attribute and a single value for that * attribute. Query returns all items with that partition key value. * Optionally, you can provide a sort key attribute and use a comparison operator to refine * the search results.

*

Use the KeyConditionExpression parameter to provide a specific value for * the partition key. The Query operation will return all of the items from * the table or index with that partition key value. You can optionally narrow the scope of * the Query operation by specifying a sort key value and a comparison * operator in KeyConditionExpression. To further refine the * Query results, you can optionally provide a * FilterExpression. A FilterExpression determines which * items within the results should be returned to you. All of the other results are * discarded.

*

A Query operation always returns a result set. If no matching items are * found, the result set will be empty. Queries that do not return results consume the * minimum number of read capacity units for that type of read operation.

* *

DynamoDB calculates the number of read capacity units consumed based on item * size, not on the amount of data that is returned to an application. The number of * capacity units consumed will be the same whether you request all of the attributes * (the default behavior) or just some of them (using a projection expression). The * number will also be the same whether or not you use a FilterExpression. *

* *

* Query results are always sorted by the sort key value. If the data type of * the sort key is Number, the results are returned in numeric order; otherwise, the * results are returned in order of UTF-8 bytes. By default, the sort order is ascending. * To reverse the order, set the ScanIndexForward parameter to false.

*

A single Query operation will read up to the maximum number of items set * (if using the Limit parameter) or a maximum of 1 MB of data and then apply * any filtering to the results using FilterExpression. If * LastEvaluatedKey is present in the response, you will need to paginate * the result set. For more information, see Paginating * the Results in the Amazon DynamoDB Developer Guide.

*

* FilterExpression is applied after a Query finishes, but before * the results are returned. A FilterExpression cannot contain partition key * or sort key attributes. You need to specify those attributes in the * KeyConditionExpression.

* *

A Query operation can return an empty result set and a * LastEvaluatedKey if all the items read for the page of results are * filtered out.

* *

You can query a table, a local secondary index, or a global secondary index. For a * query on a table or on a local secondary index, you can set the * ConsistentRead parameter to true and obtain a strongly * consistent result. Global secondary indexes support eventually consistent reads only, so * do not specify ConsistentRead when querying a global secondary * index.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DynamoDBClient, QueryCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import * // const { DynamoDBClient, QueryCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import * // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"; * const config = {}; // type is DynamoDBClientConfig * const client = new DynamoDBClient(config); * const input = { // QueryInput * TableName: "STRING_VALUE", // required * IndexName: "STRING_VALUE", * Select: "ALL_ATTRIBUTES" || "ALL_PROJECTED_ATTRIBUTES" || "SPECIFIC_ATTRIBUTES" || "COUNT", * AttributesToGet: [ // AttributeNameList * "STRING_VALUE", * ], * Limit: Number("int"), * ConsistentRead: true || false, * KeyConditions: { // KeyConditions * "": { // Condition * AttributeValueList: [ // AttributeValueList * { // AttributeValue Union: only one key present * S: "STRING_VALUE", * N: "STRING_VALUE", * B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * SS: [ // StringSetAttributeValue * "STRING_VALUE", * ], * NS: [ // NumberSetAttributeValue * "STRING_VALUE", * ], * BS: [ // BinarySetAttributeValue * new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * ], * M: { // MapAttributeValue * "": {// Union: only one key present * S: "STRING_VALUE", * N: "STRING_VALUE", * B: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * SS: [ * "STRING_VALUE", * ], * NS: [ * "STRING_VALUE", * ], * BS: [ * new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") * ], * M: { * "": "", * }, * L: [ // ListAttributeValue * "", * ], * NULL: true || false, * BOOL: true || false, * }, * }, * L: [ * "", * ], * NULL: true || false, * BOOL: true || false, * }, * ], * ComparisonOperator: "EQ" || "NE" || "IN" || "LE" || "LT" || "GE" || "GT" || "BETWEEN" || "NOT_NULL" || "NULL" || "CONTAINS" || "NOT_CONTAINS" || "BEGINS_WITH", // required * }, * }, * QueryFilter: { // FilterConditionMap * "": { * AttributeValueList: [ * "", * ], * ComparisonOperator: "EQ" || "NE" || "IN" || "LE" || "LT" || "GE" || "GT" || "BETWEEN" || "NOT_NULL" || "NULL" || "CONTAINS" || "NOT_CONTAINS" || "BEGINS_WITH", // required * }, * }, * ConditionalOperator: "AND" || "OR", * ScanIndexForward: true || false, * ExclusiveStartKey: { // Key * "": "", * }, * ReturnConsumedCapacity: "INDEXES" || "TOTAL" || "NONE", * ProjectionExpression: "STRING_VALUE", * FilterExpression: "STRING_VALUE", * KeyConditionExpression: "STRING_VALUE", * ExpressionAttributeNames: { // ExpressionAttributeNameMap * "": "STRING_VALUE", * }, * ExpressionAttributeValues: { // ExpressionAttributeValueMap * "": "", * }, * }; * const command = new QueryCommand(input); * const response = await client.send(command); * // { // QueryOutput * // Items: [ // ItemList * // { // AttributeMap * // "": { // AttributeValue Union: only one key present * // S: "STRING_VALUE", * // N: "STRING_VALUE", * // B: new Uint8Array(), * // SS: [ // StringSetAttributeValue * // "STRING_VALUE", * // ], * // NS: [ // NumberSetAttributeValue * // "STRING_VALUE", * // ], * // BS: [ // BinarySetAttributeValue * // new Uint8Array(), * // ], * // M: { // MapAttributeValue * // "": {// Union: only one key present * // S: "STRING_VALUE", * // N: "STRING_VALUE", * // B: new Uint8Array(), * // SS: [ * // "STRING_VALUE", * // ], * // NS: [ * // "STRING_VALUE", * // ], * // BS: [ * // new Uint8Array(), * // ], * // M: { * // "": "", * // }, * // L: [ // ListAttributeValue * // "", * // ], * // NULL: true || false, * // BOOL: true || false, * // }, * // }, * // L: [ * // "", * // ], * // NULL: true || false, * // BOOL: true || false, * // }, * // }, * // ], * // Count: Number("int"), * // ScannedCount: Number("int"), * // LastEvaluatedKey: { // Key * // "": "", * // }, * // ConsumedCapacity: { // ConsumedCapacity * // TableName: "STRING_VALUE", * // CapacityUnits: Number("double"), * // ReadCapacityUnits: Number("double"), * // WriteCapacityUnits: Number("double"), * // Table: { // Capacity * // ReadCapacityUnits: Number("double"), * // WriteCapacityUnits: Number("double"), * // CapacityUnits: Number("double"), * // }, * // LocalSecondaryIndexes: { // SecondaryIndexesCapacityMap * // "": { * // ReadCapacityUnits: Number("double"), * // WriteCapacityUnits: Number("double"), * // CapacityUnits: Number("double"), * // }, * // }, * // GlobalSecondaryIndexes: { * // "": { * // ReadCapacityUnits: Number("double"), * // WriteCapacityUnits: Number("double"), * // CapacityUnits: Number("double"), * // }, * // }, * // }, * // }; * * ``` * * @param QueryCommandInput - {@link QueryCommandInput} * @returns {@link QueryCommandOutput} * @see {@link QueryCommandInput} for command's `input` shape. * @see {@link QueryCommandOutput} for command's `response` shape. * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidEndpointException} (client fault) * * @throws {@link ProvisionedThroughputExceededException} (client fault) *

The request was denied due to request throttling. For detailed information about * why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. The Amazon Web Services * SDKs for DynamoDB automatically retry requests that receive this exception. * Your request is eventually successful, unless your retry queue is too large to finish. * Reduce the frequency of requests and use exponential backoff. For more information, go * to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

* * @throws {@link RequestLimitExceeded} (client fault) *

Throughput exceeds the current throughput quota for your account. For detailed * information about why the request was throttled and the ARN of the impacted resource, * find the ThrottlingReason field in the returned exception. Contact Amazon Web Services Support to request a quota * increase.

* * @throws {@link ResourceNotFoundException} (client fault) *

The operation tried to access a nonexistent table or index. The resource might not * be specified correctly, or its status might not be ACTIVE.

* * @throws {@link ThrottlingException} (client fault) *

The request was denied due to request throttling. For detailed information about why * the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception.

* * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

* * * @example To query an item * ```javascript * // This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know". * const input = { * ExpressionAttributeValues: { * :v1: { * S: "No One You Know" * } * }, * KeyConditionExpression: "Artist = :v1", * ProjectionExpression: "SongTitle", * TableName: "Music" * }; * const command = new QueryCommand(input); * const response = await client.send(command); * /* response is * { * ConsumedCapacity: { /* empty *\/ }, * Count: 2, * Items: [ * { * SongTitle: { * S: "Call Me Today" * } * } * ], * ScannedCount: 2 * } * *\/ * ``` * * @public */ export declare class QueryCommand extends QueryCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: QueryInput; output: QueryOutput; }; sdk: { input: QueryCommandInput; output: QueryCommandOutput; }; }; }