AWSDynamoDBQueryExpression

@interface AWSDynamoDBQueryExpression : NSObject

A query expression.

  • The index name.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *indexName;

    Swift

    var indexName: String? { get set }
  • The condition that specifies the key value(s) for items to be retrieved by the Query action. For more information, see [AWSDynamoDBQueryInput keyConditionExpression]

    For example, you may set keyConditionExpression to hashAttributeName = :hashVal AND rangeAttributeName = :rangeVal where hashAttributeName and rangeAttributeName is the attribute name of the hash key and range key respectively. Then you can set expressionAttributeValues to @{@":hashVal" : @"myHashValue", @":rangeVal" : @100}.

    See

    [AWSDynamoDBQueryInput keyConditionExpression]

    See

    expressionAttributeNames

    See

    expressionAttributeValues

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSString *keyConditionExpression;

    Swift

    var keyConditionExpression: String? { get set }
  • A string that contains conditions DynamoDB applies after the Query operation, but before the data is returned. For more information, see [AWSDynamoDBQueryInput filterExpression]

    See

    [AWSDynamoDBQueryInput filterExpression]

    See

    expressionAttributeNames

    See

    expressionAttributeValues

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *filterExpression;

    Swift

    var filterExpression: String? { get set }
  • A string that identifies one or more attributes to retrieve from the table. If no attribute names are specified, all attributes will be returned.

    See

    [AWSDynamoDBQueryInput projectionExpression]

    See

    expressionAttributeNames

    See

    expressionAttributeValues

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSString *projectionExpression;

    Swift

    var projectionExpression: String? { get set }
  • One or more values that can be substituted in an expression.

    See

    [AWSDynamoDBQueryInput expressionAttributeValues]

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSDictionary<NSString *, id> *expressionAttributeValues;

    Swift

    var expressionAttributeValues: [String : Any]? { get set }
  • One or more substitution tokens for attribute names in an expression.

    See

    [AWSDynamoDBQueryInput expressionAttributeNames]

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSDictionary<NSString *, NSString *> *expressionAttributeNames;

    Swift

    var expressionAttributeNames: [String : String]? { get set }
  • The limit.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSNumber *limit;

    Swift

    var limit: NSNumber? { get set }
  • When set to @YES, AWSDynamoDBObjectMapper scans the index forward. When set to @NO, it scans the other direction.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSNumber *scanIndexForward;

    Swift

    var scanIndexForward: NSNumber? { get set }
  • The exclusive start key.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        NSDictionary<NSString *, AWSDynamoDBAttributeValue *> *exclusiveStartKey;

    Swift

    var exclusiveStartKey: [String : AWSDynamoDBAttributeValue]? { get set }
  • Deprecated

    Use ‘keyConditionExpression’ and ‘expressionAttributeValues’ instead.

    Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *hashKeyAttribute

    Swift

    var hashKeyAttribute: String? { get set }
  • Deprecated

    Use ‘keyConditionExpression’ and ‘expressionAttributeValues’ instead.

    Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) id hashKeyValues

    Swift

    var hashKeyValues: Any? { get set }
  • Deprecated

    Use ‘keyConditionExpression’ instead.

    Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *rangeKeyConditionExpression

    Swift

    var rangeKeyConditionExpression: String? { get set }