ArxDynamoReadOptions

Definition

Namespace

ARX.SDK.DynamoDb.Services

Package

ARX.SDK.DynamoDb

public sealed class ArxDynamoReadOptions

Properties

• bool ConsistentRead { get; init; }

  True (the default): reads of the table see every write before them. False: the cheaper eventually consistent read. Index reads are always eventually consistent.

• string? IndexName { get; init; }

  The global secondary index to query; null lets ARX pick the one whose keys the criteria give.

• bool AllowScan { get; init; }

  False (the default): a query without its partition key is refused (ARX8001), because DynamoDB can only answer it by reading the whole table. True: such a query is a Scan, which reads and bills every item.

• bool CaseSensitivePatterns { get; init; }

  False (the default): Contains and BeginsWith are refused (ARX8001), because ARX's are case-insensitive and DynamoDB's contains and begins_with aren't. True: they run case-sensitively.

Usage

var found = await service.RetrieveMultipleAsync(query, new ArxDynamoReadOptions { IndexName = "GSI1", ConsistentRead = false });

Orders by status, through an index, scenario 1

Used in:

• Orders by status, through an indexRetrieveMultiple
• Catch an injection attemptRetrieveMultiple
• Scan when you mustRetrieveMultiple