@aws-sdk/client-dynamodb
Version:
AWS SDK for JavaScript Dynamodb Client for Node.js, Browser and React Native
110 lines • 6.3 kB
JavaScript
import { __extends } from "tslib";
import { QueryInput, QueryOutput } from "../models/models_0";
import { deserializeAws_json1_0QueryCommand, serializeAws_json1_0QueryCommand } from "../protocols/Aws_json1_0";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { Command as $Command } from "@aws-sdk/smithy-client";
/**
* <p>The <code>Query</code> operation finds items based on primary key values.
* You can query any table or secondary index that has a composite primary key (a partition
* key and a sort key).
* </p>
* <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value
* for the partition key. The <code>Query</code> 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 <code>Query</code> operation by specifying a sort key value and a
* comparison operator in <code>KeyConditionExpression</code>. To further refine the <code>Query</code> results,
* you can optionally provide a <code>FilterExpression</code>. A <code>FilterExpression</code> determines which items
* within the results should be returned to you. All of the other results are discarded.
* </p>
* <p>
* A <code>Query</code> 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.
* </p>
* <note>
* <p>
* 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 <code>FilterExpression</code>.
* </p>
* </note>
* <p>
* <code>Query</code> 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 <code>ScanIndexForward</code> parameter
* to false.
* </p>
* <p> A single <code>Query</code> operation will read up to the maximum number of items
* set (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then
* apply any filtering to the results using <code>FilterExpression</code>. If
* <code>LastEvaluatedKey</code> is present in the response, you will need to paginate
* the result set. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination">Paginating
* the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>
* <p>
* <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before
* the results are returned.
* A <code>FilterExpression</code> cannot contain partition key or sort key attributes.
* You need to specify those attributes in the <code>KeyConditionExpression</code>.
* </p>
* <note>
* <p>
* A <code>Query</code> operation can return an empty result set and a <code>LastEvaluatedKey</code>
* if all the items read for the page of results are filtered out.
* </p>
* </note>
* <p>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
* <code>ConsistentRead</code> parameter to <code>true</code> and obtain a
* strongly consistent result. Global secondary indexes support eventually consistent reads
* only, so do not specify <code>ConsistentRead</code> when querying a global
* secondary index.</p>
*/
var QueryCommand = /** @class */ (function (_super) {
__extends(QueryCommand, _super);
// Start section: command_properties
// End section: command_properties
function QueryCommand(input) {
var _this =
// Start section: command_constructor
_super.call(this) || this;
_this.input = input;
_this.resolved = false;
return _this;
// End section: command_constructor
}
/**
* @internal
*/
QueryCommand.prototype.resolveMiddleware = function (clientStack, configuration, options) {
if (!this.resolved) {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.resolved = true;
}
var stack = clientStack.concat(this.middlewareStack);
var logger = configuration.logger;
var clientName = "DynamoDBClient";
var commandName = "QueryCommand";
var handlerExecutionContext = {
logger: logger,
clientName: clientName,
commandName: commandName,
inputFilterSensitiveLog: QueryInput.filterSensitiveLog,
outputFilterSensitiveLog: QueryOutput.filterSensitiveLog,
};
var requestHandler = configuration.requestHandler;
return stack.resolve(function (request) {
return requestHandler.handle(request.request, options || {});
}, handlerExecutionContext);
};
QueryCommand.prototype.serialize = function (input, context) {
return serializeAws_json1_0QueryCommand(input, context);
};
QueryCommand.prototype.deserialize = function (output, context) {
return deserializeAws_json1_0QueryCommand(output, context);
};
return QueryCommand;
}($Command));
export { QueryCommand };
//# sourceMappingURL=QueryCommand.js.map