diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/AsyncSearch.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/AsyncSearch.cs
index e08008c8dc50..159c1281be09 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/AsyncSearch.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/AsyncSearch.cs
@@ -13,18 +13,38 @@
* permissions and limitations under the License.
*/
-using Amazon.DynamoDBv2.DataModel;
using Amazon.DynamoDBv2.DocumentModel;
namespace Amazon.DynamoDBv2.DataModel
{
+ ///
+ /// Interface retrieving search results (Query or Scan)
+ /// from DynamoDB.
+ ///
+ public partial interface IAsyncSearch
+ {
+ ///
+ /// Flag that, if true, indicates that the search is done
+ ///
+ bool IsDone { get; }
+
+ ///
+ /// Pagination token corresponding to the item where the search operation stopped,
+ /// inclusive of the previous result set. Use this value to start a new
+ /// operation to resume search from the next item.
+ ///
+ string PaginationToken { get; }
+ }
+
///
/// A strongly-typed object for retrieving search results (Query or Scan)
/// from DynamoDB.
///
- public partial class AsyncSearch
+ public partial class AsyncSearch : IAsyncSearch
{
- #region Constructor
+ private Search _documentSearch { get; set; }
+ private DynamoDBContext _sourceContext { get; set; }
+ private DynamoDBFlatConfig _config { get; set; }
///
/// This constructor is used for mocking. Users that want to mock AsyncSearch can create a subclass of AsyncSearch and make a public parameterless constructor.
@@ -36,47 +56,27 @@ protected AsyncSearch()
internal AsyncSearch(DynamoDBContext source, DynamoDBContext.ContextSearch contextSearch)
{
- SourceContext = source;
- DocumentSearch = contextSearch.Search;
- Config = contextSearch.FlatConfig;
+ _sourceContext = source;
+ _documentSearch = contextSearch.Search;
+ _config = contextSearch.FlatConfig;
}
- #endregion
-
- #region Private members
-
- private Search DocumentSearch { get; set; }
- private DynamoDBContext SourceContext { get; set; }
- private DynamoDBFlatConfig Config { get; set; }
-
- #endregion
-
- #region Public properties
-
- ///
- /// Flag that, if true, indicates that the search is done
- ///
+ ///
- /// Pagination token corresponding to the item where the search operation stopped,
- /// inclusive of the previous result set. Use this value to start a new
- /// operation to resume search from the next item.
- ///
+ ///
- /// Represents a non-generic object for retrieving a batch of items
+ /// Represents a non-generic interface for retrieving a batch of items
/// from a single DynamoDB table
///
- public abstract partial class BatchGet
+ public partial interface IBatchGet
{
- #region Internal/protected properties
-
///
- /// Gets and sets the UntypedResults property.
+ /// Returns the total number of keys associated with this Batch request.
///
- protected List UntypedResults { get; set; }
- internal DynamoDBContext Context { get; set; }
- internal DynamoDBFlatConfig Config { get; set; }
- internal List Keys { get; set; }
- internal DocumentBatchGet DocumentBatch { get; set; }
- internal ItemStorageConfig ItemStorageConfig { get; set; }
-
- #endregion
-
-
- #region Constructor
-
- internal BatchGet(DynamoDBContext context, DynamoDBFlatConfig config)
- {
- Context = context;
- Config = config;
- Keys = new List();
- }
-
- #endregion
-
-
- #region Public properties
+ public int TotalKeys { get; }
///
- /// List of results retrieved from DynamoDB.
- /// Populated after Execute is called.
+ /// List of non-generic results retrieved from DynamoDB.
///
- public List Results { get { return UntypedResults; } }
+ ///
+ /// This is only populated after a call to Execute.
+ ///
+ List UntypedResults { get; }
///
/// If set to true, a consistent read is issued. Otherwise eventually-consistent is used.
///
- public bool ConsistentRead { get; set; }
-
- #endregion
+ ///
+ /// Refer to the
+ /// Read Consistency topic in the DynamoDB Developer Guide for more information.
+ ///
+ bool ConsistentRead { get; set; }
+ }
+ ///
+ /// Represents a generic interface for retrieving a batch of items
+ /// from a single DynamoDB table
+ ///
+ public interface IBatchGet : IBatchGet
+ {
+ ///
+ /// List of generic results retrieved from DynamoDB.
+ ///
+ ///
+ /// This is only populated after a call to Execute.
+ ///
+ List Results { get; }
- #region Protected methods
+ ///
+ /// Add a single item to get, identified by its hash primary key.
+ ///
+ ///
- /// Executes a server call to batch-get the items requested.
- /// Populates Results with the retrieved items.
+ /// Add a single item to get, identified by its hash-and-range primary key.
///
- internal protected abstract void ExecuteHelper();
+ ///
- /// Executes an asynchronous server call to batch-get the items requested.
- /// Populates Results with the retrieved items.
+ /// Add a single item to get.
///
- internal protected abstract Task ExecuteHelperAsync(CancellationToken cancellationToken);
-#endif
- #endregion
+ ///
+ /// Creates a MultiTableBatchGet object that is a combination
+ /// of the current BatchGet and the specified BatchGets
+ ///
+ ///
+ /// An interface with the ability to perform MultiTableBatchGet operations.
+ ///
+ IMultiTableBatchGet Combine(params IBatchGet[] otherBatches);
+ }
- #region Internal methods
+ ///
+ /// Represents a non-generic object for retrieving a batch of items
+ /// from a single DynamoDB table
+ ///
+ public abstract partial class BatchGet : IBatchGet
+ {
+ internal DocumentBatchGet DocumentBatch { get; set; }
internal abstract void CreateDocumentBatch();
+
internal abstract void PopulateResults(List items);
- #endregion
+ /// UntypedResults { get; } = new();
+
+ ///
/// Represents a strongly-typed object for retrieving a batch of items
/// from a single DynamoDB table
///
- public class BatchGet : BatchGet
+ public partial class BatchGet : BatchGet, IBatchGet
{
- #region Public properties
+ private readonly DynamoDBContext _context;
+ private readonly DynamoDBFlatConfig _config;
+ private readonly ItemStorageConfig _itemStorageConfig;
+ private readonly List _keys = new();
- ///
- /// List of results retrieved from DynamoDB.
- /// Populated after Execute is called.
- ///
- new public List Results { get { return TypedResults; } }
+ /// Results { get; } = new();
-
- #region Public methods
-
- ///
- /// Add a single item to get, identified by its hash primary key.
- ///
- ///
- /// Add a single item to get, identified by its hash-and-range primary key.
- ///
- ///
- /// Add a single item to get.
- ///
- ///
- /// Creates a MultiTableBatchGet object that is a combination
- /// of the current BatchGet and the specified BatchGets
- ///
- ///
- /// MultiTableBatchGet consisting of the multiple BatchGet objects:
- /// the current batch and the passed-in batches.
- ///
- public MultiTableBatchGet Combine(params BatchGet[] otherBatches)
+ /// (config);
+ _context = context;
+ _config = config;
+ _itemStorageConfig = context.StorageConfigCache.GetConfig(config);
}
- #endregion
-
-
- #region Internal/protected/private members
-
- ///
- /// Executes the batch get
- ///
- internal protected override void ExecuteHelper()
+ private void ExecuteHelper()
{
CreateDocumentBatch();
DocumentBatch.ExecuteHelper();
@@ -191,10 +177,7 @@ internal protected override void ExecuteHelper()
}
#if AWS_ASYNC_API
- ///
- /// Executes the batch get asynchronously
- ///
- internal protected override async Task ExecuteHelperAsync(CancellationToken cancellationToken)
+ private async Task ExecuteHelperAsync(CancellationToken cancellationToken)
{
CreateDocumentBatch();
await DocumentBatch.ExecuteHelperAsync(cancellationToken).ConfigureAwait(false);
@@ -202,80 +185,78 @@ internal protected override async Task ExecuteHelperAsync(CancellationToken canc
}
#endif
- ///
- /// Gets and sets the TypedResults property.
- ///
- protected List TypedResults { get; set; }
internal override void CreateDocumentBatch()
{
- var storageConfig = Context.StorageConfigCache.GetConfig(Config);
- var table = Context.GetTargetTable(storageConfig, Config);
+ var table = _context.GetTargetTable(_itemStorageConfig, _config);
DocumentBatchGet docBatch = new DocumentBatchGet(table)
{
- AttributesToGet = storageConfig.AttributesToGet,
- ConsistentRead = this.ConsistentRead
+ AttributesToGet = _itemStorageConfig.AttributesToGet,
+ ConsistentRead = ConsistentRead
};
- docBatch.Keys.AddRange(Keys);
+ docBatch.Keys.AddRange(_keys);
DocumentBatch = docBatch;
}
+
internal override void PopulateResults(List items)
{
- UntypedResults = new List();
- TypedResults = new List();
+ UntypedResults.Clear();
+ Results.Clear();
foreach (var doc in items)
{
- var item = Context.FromDocumentHelper(doc, Config);
- TypedResults.Add(item);
+ var item = _context.FromDocumentHelper(doc, _config);
+ Results.Add(item);
UntypedResults.Add(item);
}
}
-
- #endregion
}
///
- /// Class for retrieving a batch of items from multiple DynamoDB tables,
+ /// Interface for retrieving a batch of items from multiple DynamoDB tables,
/// using multiple strongly-typed BatchGet objects
///
- public partial class MultiTableBatchGet
+ public partial interface IMultiTableBatchGet
{
- #region Private members
-
- private List allBatches = new List();
-
- #endregion
+ ///
+ /// Gets the total number of primary keys to be loaded from DynamoDB,
+ /// across all batches
+ ///
+ int TotalKeys { get; }
+ ///
+ /// Add a BatchGet object to the multi-table batch request
+ ///
+ ///
+ /// Class for retrieving a batch of items from multiple DynamoDB tables,
+ /// using multiple strongly-typed BatchGet objects
+ ///
+ public partial class MultiTableBatchGet : IMultiTableBatchGet
+ {
+ private List allBatches = new List();
///
/// Constructs a MultiTableBatchGet object from a number of
/// BatchGet objects
///
/// (batches);
+ allBatches = new List(batches);
}
- internal MultiTableBatchGet(BatchGet first, params BatchGet[] rest)
+ internal MultiTableBatchGet(IBatchGet first, params IBatchGet[] rest)
{
- allBatches = new List();
+ allBatches = new List();
allBatches.Add(first);
allBatches.AddRange(rest);
}
- #endregion
-
-
- #region Public properties
-
- ///
- /// Gets the total number of primary keys to be loaded from DynamoDB,
- /// across all batches
- ///
+ ///
- /// Add a BatchGet object to the multi-table batch request
- ///
- ///
- /// Represents a non-generic object for writing/deleting a batch of items
+ /// Represents a non-generic interface for writing/deleting a batch of items
/// in a single DynamoDB table
///
- public abstract partial class BatchWrite
+ public partial interface IBatchWrite
{
- #region Internal/protected properties
-
- internal DynamoDBContext Context { get; set; }
- internal DynamoDBFlatConfig Config { get; set; }
- internal DocumentBatchWrite DocumentBatch { get; set; }
-
- #endregion
-
-
- #region Constructor
-
- internal BatchWrite(DynamoDBContext context, DynamoDBFlatConfig config)
- {
- Context = context;
- Config = config;
- }
-
- #endregion
-
-
- #region Protected methods
-
- ///
- /// Executes a server call to batch-write/delete the items requested.
- ///
- internal protected abstract void ExecuteHelper();
-
-#if AWS_ASYNC_API
- ///
- /// Executes an asynchronous server call to batch-write/delete the items requested.
- ///
- internal protected abstract Task ExecuteHelperAsync(CancellationToken cancellationToken);
-#endif
-
- #endregion
}
///
- /// Represents a strongly-typed object for writing/deleting a batch of items
+ /// Represents a generic interface for writing/deleting a batch of items
/// in a single DynamoDB table
///
- public class BatchWrite : BatchWrite
+ public interface IBatchWrite : IBatchWrite
{
- #region Public combine methods
-
///
/// Creates a MultiTableBatchWrite object that is a combination
/// of the current BatchWrite and the specified BatchWrites
@@ -87,84 +47,38 @@ public class BatchWrite : BatchWrite
/// MultiTableBatchWrite consisting of the multiple BatchWrite objects:
/// the current batch and the passed-in batches.
///
- public MultiTableBatchWrite Combine(params BatchWrite[] otherBatches)
- {
- return new MultiTableBatchWrite(this, otherBatches);
- }
-
- #endregion
-
-
- #region Public Put methods
+ IMultiTableBatchWrite Combine(params IBatchWrite[] otherBatches);
///
/// Add a number of items to be put in the current batch operation
///
/// values)
- {
- if (values == null) return;
-
- foreach (T item in values)
- {
- AddPutItem(item);
- }
- }
+ void AddPutItems(IEnumerable values);
///
/// Add a single item to be put in the current batch operation
///
///
/// Add a number of items to be deleted in the current batch operation
///
/// values)
- {
- if (values == null) return;
-
- foreach (T item in values)
- {
- AddDeleteItem(item);
- }
- }
+ void AddDeleteItems(IEnumerable values);
///
/// Add a single item to be deleted in the current batch operation.
///
///
/// Add a single item to be deleted in the current batch operation.
/// Item is identified by its hash primary key.
///
///
/// Add a single item to be deleted in the current batch operation.
@@ -172,15 +86,27 @@ public void AddDeleteKey(object hashKey)
///
///
+ /// Represents a non-generic object for writing/deleting a batch of items
+ /// in a single DynamoDB table
+ ///
+ public abstract partial class BatchWrite : IBatchWrite
+ {
+ internal DocumentBatchWrite DocumentBatch { get; set; }
+ }
- #region Constructor
+ ///
+ /// Represents a strongly-typed object for writing/deleting a batch of items
+ /// in a single DynamoDB table
+ ///
+ public partial class BatchWrite : BatchWrite, IBatchWrite
+ {
+ private readonly DynamoDBContext _context;
+ private readonly DynamoDBFlatConfig _config;
+ private readonly ItemStorageConfig _storageConfig;
internal BatchWrite(DynamoDBContext context, DynamoDBFlatConfig config)
: this(context, typeof(T), config)
@@ -188,118 +114,167 @@ internal BatchWrite(DynamoDBContext context, DynamoDBFlatConfig config)
}
internal BatchWrite(DynamoDBContext context, Type valuesType, DynamoDBFlatConfig config)
- : base(context, config)
{
- StorageConfig = context.StorageConfigCache.GetConfig(valuesType, config);
+ _context = context;
+ _config = config;
+ _storageConfig = context.StorageConfigCache.GetConfig(valuesType, config);
- if (StorageConfig.HasVersion)
+ if (_storageConfig.HasVersion)
{
- if (!Config.SkipVersionCheck.GetValueOrDefault(false))
+ if (!_config.SkipVersionCheck.GetValueOrDefault(false))
throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture,
"Object {0} has a versioning field, which is not supported for this operation. To ignore versioning, use the DynamoDBContextConfig.SkipVersionCheck property.",
valuesType.Name));
}
- Table table = Context.GetTargetTable(StorageConfig, Config);
- DocumentBatch = table.CreateBatchWrite();
+ Table table = _context.GetTargetTable(_storageConfig, _config);
+
+ // Table.CreateBatchWrite() returns the IDocumentBatchWrite interface.
+ // But since we rely on the internal behavior of DocumentBatchWrite, we instantiate it via the constructor.
+ DocumentBatch = new DocumentBatchWrite(table);
}
- #endregion
+ /// values)
+ {
+ if (values == null) return;
- #region Internal/protected/private members
+ foreach (T item in values)
+ {
+ AddPutItem(item);
+ }
+ }
- internal ItemStorageConfig StorageConfig { get; set; }
+ ///
- /// Execute the batch write.
- ///
- internal protected override void ExecuteHelper()
+ ItemStorage storage = _context.ObjectToItemStorageHelper(item, _storageConfig, _config, keysOnly: false, ignoreNullValues: true);
+ if (storage == null) return;
+ DocumentBatch.AddDocumentToPut(storage.Document);
+ }
+
+ /// values)
+ {
+ if (values == null) return;
+
+ foreach (T item in values)
+ {
+ AddDeleteItem(item);
+ }
+ }
+
+ ///
- /// Execute the batch write asynchronously.
- ///
- internal protected override Task ExecuteHelperAsync(CancellationToken cancellationToken)
+ private Task ExecuteHelperAsync(CancellationToken cancellationToken)
{
return DocumentBatch.ExecuteHelperAsync(cancellationToken);
}
#endif
+ }
- #endregion
+ ///
+ /// Interface for writing/deleting a batch of items in multiple DynamoDB tables,
+ /// using multiple strongly-typed BatchWrite objects
+ ///
+ public partial interface IMultiTableBatchWrite
+ {
+ ///
+ /// Add a BatchWrite object to the multi-table batch request
+ ///
+ ///
/// Class for writing/deleting a batch of items in multiple DynamoDB tables,
/// using multiple strongly-typed BatchWrite objects
///
- public partial class MultiTableBatchWrite
+ public partial class MultiTableBatchWrite : IMultiTableBatchWrite
{
- #region Private members
-
- private List allBatches = new List();
-
- #endregion
-
-
- #region Constructor
+ private List allBatches = new();
///
/// Constructs a MultiTableBatchWrite object from a number of
/// BatchWrite objects
///
/// (batches);
+ allBatches = new List(batches);
}
- internal MultiTableBatchWrite(BatchWrite first, params BatchWrite[] rest)
+ internal MultiTableBatchWrite(IBatchWrite first, params IBatchWrite[] rest)
{
- allBatches = new List();
+ allBatches = new List();
allBatches.Add(first);
allBatches.AddRange(rest);
}
- #endregion
-
-
- #region Public methods
-
- ///
- /// Add a BatchWrite object to the multi-table batch request
- ///
- ///
- /// Creates a strongly-typed BatchGet object, allowing
- /// a batch-get operation against DynamoDB.
- ///
- /// Type of objects to get
- /// Empty strongly-typed BatchGet object
- public BatchGet CreateBatchGet()
+ /// CreateBatchGet()
{
return CreateBatchGet((BatchGetConfig)null);
}
- ///
- /// Creates a strongly-typed BatchGet object, allowing
- /// a batch-get operation against DynamoDB.
- ///
- /// Type of objects to get
- /// Empty strongly-typed BatchGet object
+ /// CreateBatchGet(DynamoDBOperationConfig operationConfig)
+ public IBatchGet CreateBatchGet(DynamoDBOperationConfig operationConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(operationConfig, this.Config);
return new BatchGet(this, config);
}
- ///
- /// Creates a strongly-typed BatchGet object, allowing
- /// a batch-get operation against DynamoDB.
- ///
- /// Type of objects to get
- /// Empty strongly-typed BatchGet object
- public BatchGet CreateBatchGet(BatchGetConfig batchGetConfig)
+ /// CreateBatchGet(BatchGetConfig batchGetConfig)
{
return new BatchGet(this, new DynamoDBFlatConfig(batchGetConfig?.ToDynamoDBOperationConfig(), Config));
}
- ///
- /// Creates a MultiTableBatchGet object, composed of multiple
- /// individual BatchGet objects.
- ///
- /// Composite MultiTableBatchGet object
- public MultiTableBatchGet CreateMultiTableBatchGet(params BatchGet[] batches)
+ ///
- /// Creates a strongly-typed BatchWrite object, allowing
- /// a batch-write operation against DynamoDB.
- ///
- /// Type of objects to write
- /// Empty strongly-typed BatchWrite object
- public BatchWrite CreateBatchWrite()
+ /// CreateBatchWrite()
{
return CreateBatchWrite((BatchWriteConfig)null);
}
- ///
- /// Creates a strongly-typed BatchWrite object, allowing
- /// a batch-write operation against DynamoDB.
- ///
- /// Type of objects to write
- /// Empty strongly-typed BatchWrite object
+ /// CreateBatchWrite(DynamoDBOperationConfig operationConfig)
+ public IBatchWrite CreateBatchWrite(DynamoDBOperationConfig operationConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(operationConfig, this.Config);
return new BatchWrite(this, config);
}
- ///
- /// Creates a strongly-typed BatchWrite object, allowing
- /// a batch-write operation against DynamoDB.
- ///
- /// This is intended for use only when the valuesType is not known at compile-time, for example,
- /// when hooking into EF's ChangeTracker to record audit logs from EF into DynamoDB.
- ///
- /// In scenarios when the valuesType is known at compile-time, the
- /// Empty strongly-typed BatchWrite object
- public BatchWrite CreateBatchWrite(Type valuesType)
+ /// CreateBatchWrite(Type valuesType)
{
return CreateBatchWrite(valuesType, (BatchWriteConfig)null);
}
- ///
- /// Creates a strongly-typed BatchWrite object, allowing
- /// a batch-write operation against DynamoDB.
- ///
- /// This is intended for use only when the valuesType is not known at compile-time, for example,
- /// when hooking into EF's ChangeTracker to record audit logs from EF into DynamoDB.
- ///
- /// In scenarios when the valuesType is known at compile-time, the
- ///
- /// Empty strongly-typed BatchWrite object
+ /// CreateBatchWrite(Type valuesType, DynamoDBOperationConfig operationConfig)
+ public IBatchWrite CreateBatchWrite(Type valuesType, DynamoDBOperationConfig operationConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(operationConfig, this.Config);
return new BatchWrite(this, valuesType, config);
}
- ///
- /// Creates a strongly-typed BatchWrite object, allowing
- /// a batch-write operation against DynamoDB.
- ///
- /// Type of objects to write
- /// Empty strongly-typed BatchWrite object
- public BatchWrite CreateBatchWrite(BatchWriteConfig batchWriteConfig)
+ /// CreateBatchWrite(BatchWriteConfig batchWriteConfig)
{
return new BatchWrite(this, new DynamoDBFlatConfig(batchWriteConfig?.ToDynamoDBOperationConfig(), Config));
}
- ///
- /// Creates a strongly-typed BatchWrite object, allowing
- /// a batch-write operation against DynamoDB.
- ///
- /// This is intended for use only when the valuesType is not known at compile-time, for example,
- /// when hooking into EF's ChangeTracker to record audit logs from EF into DynamoDB.
- ///
- /// In scenarios when the valuesType is known at compile-time, the
- ///
- /// Empty strongly-typed BatchWrite object
- public BatchWrite CreateBatchWrite(Type valuesType, BatchWriteConfig batchWriteConfig)
+ /// CreateBatchWrite(Type valuesType, BatchWriteConfig batchWriteConfig)
{
return new BatchWrite(this, valuesType, new DynamoDBFlatConfig(batchWriteConfig.ToDynamoDBOperationConfig(), Config));
}
- ///
- /// Creates a MultiTableBatchWrite object, composed of multiple
- /// individual BatchWrite objects.
- ///
- /// Composite MultiTableBatchWrite object
- public MultiTableBatchWrite CreateMultiTableBatchWrite(params BatchWrite[] batches)
+ ///
- /// Creates a strongly-typed TransactGet object, allowing
- /// a transactional get operation against DynamoDB.
- ///
- /// Type of objects to get.
- /// Empty strongly-typed TransactGet object.
- public TransactGet CreateTransactGet()
+ /// CreateTransactGet()
{
return CreateTransactGet((TransactGetConfig)null);
}
- ///
- /// Creates a strongly-typed TransactGet object, allowing
- /// a transactional get operation against DynamoDB.
- ///
- /// Type of objects to get.
- /// Empty strongly-typed TransactGet object.
+ /// CreateTransactGet(DynamoDBOperationConfig operationConfig)
+ public ITransactGet CreateTransactGet(DynamoDBOperationConfig operationConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(operationConfig, this.Config);
return new TransactGet(this, config);
}
- ///
- /// Creates a strongly-typed TransactGet object, allowing
- /// a transactional get operation against DynamoDB.
- ///
- /// Type of objects to get.
- /// Empty strongly-typed TransactGet object.
- public TransactGet CreateTransactGet(TransactGetConfig transactGetConfig)
+ /// CreateTransactGet(TransactGetConfig transactGetConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(transactGetConfig?.ToDynamoDBOperationConfig(), this.Config);
return new TransactGet(this, config);
}
- ///
- /// Creates a MultiTableTransactGet object, composed of multiple
- /// individual TransactGet objects.
- ///
- /// Composite MultiTableTransactGet object.
- public MultiTableTransactGet CreateMultiTableTransactGet(params TransactGet[] transactionParts)
+ ///
- /// Creates a strongly-typed TransactWrite object, allowing
- /// a transactional write operation against DynamoDB.
- ///
- /// Type of objects to write.
- /// Empty strongly-typed TransactWrite object.
- public TransactWrite CreateTransactWrite()
+ /// CreateTransactWrite()
{
return CreateTransactWrite((TransactWriteConfig)null);
}
- ///
- /// Creates a strongly-typed TransactWrite object, allowing
- /// a transactional write operation against DynamoDB.
- ///
- /// Type of objects to write.
- /// Empty strongly-typed TransactWrite object.
+ /// CreateTransactWrite(DynamoDBOperationConfig operationConfig)
+ public ITransactWrite CreateTransactWrite(DynamoDBOperationConfig operationConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(operationConfig, this.Config);
return new TransactWrite(this, config);
}
- ///
- /// Creates a strongly-typed TransactWrite object, allowing
- /// a transactional write operation against DynamoDB.
- ///
- /// Type of objects to write.
- /// Empty strongly-typed TransactWrite object.
- public TransactWrite CreateTransactWrite(TransactWriteConfig transactWriteConfig)
+ /// CreateTransactWrite(TransactWriteConfig transactWriteConfig)
{
DynamoDBFlatConfig config = new DynamoDBFlatConfig(transactWriteConfig?.ToDynamoDBOperationConfig(), this.Config);
return new TransactWrite(this, config);
}
- ///
- /// Creates a MultiTableTransactWrite object, composed of multiple
- /// individual TransactWrite objects.
- ///
- /// Composite MultiTableTransactWrite object.
- public MultiTableTransactWrite CreateMultiTableTransactWrite(params TransactWrite[] transactionParts)
+ /// (IEnumerable conditions, Dyna
IndexName = flatConfig.IndexName,
ConsistentRead = flatConfig.ConsistentRead.GetValueOrDefault(false)
};
- Search scan = table.Scan(scanConfig);
+
+ // table.Scan() returns the ISearch interface but we explicitly cast it to a Search object since we rely on its internal behavior
+ Search scan = table.Scan(scanConfig) as Search;
return new ContextSearch(scan, flatConfig);
}
@@ -1192,7 +1194,9 @@ private ContextSearch ConvertFromScan(ScanOperationConfig scanConfig, DynamoD
DynamoDBFlatConfig flatConfig = new DynamoDBFlatConfig(operationConfig, Config);
ItemStorageConfig storageConfig = StorageConfigCache.GetConfig(flatConfig);
Table table = GetTargetTable(storageConfig, flatConfig);
- Search search = table.Scan(scanConfig);
+
+ // table.Scan() returns the ISearch interface but we explicitly cast it to a Search object since we rely on its internal behavior
+ Search search = table.Scan(scanConfig) as Search;
return new ContextSearch(search, flatConfig);
}
@@ -1201,7 +1205,9 @@ private ContextSearch ConvertFromQuery(QueryOperationConfig queryConfig, Dyna
DynamoDBFlatConfig flatConfig = new DynamoDBFlatConfig(operationConfig, Config);
ItemStorageConfig storageConfig = StorageConfigCache.GetConfig(flatConfig);
Table table = GetTargetTable(storageConfig, flatConfig);
- Search search = table.Query(queryConfig);
+
+ // table.Query() returns the ISearch interface but we explicitly cast it to a Search object since we rely on its internal behavior
+ Search search = table.Query(queryConfig) as Search;
return new ContextSearch(search, flatConfig);
}
@@ -1246,7 +1252,9 @@ private ContextSearch ConvertQueryHelper(DynamoDBFlatConfig currentConfig, It
{
queryConfig.Select = SelectValues.AllProjectedAttributes;
}
- Search query = table.Query(queryConfig);
+
+ // table.Query() returns the ISearch interface but we explicitly cast it to a Search object since we rely on its internal behavior
+ Search query = table.Query(queryConfig) as Search;
return new ContextSearch(query, currentConfig);
}
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/IDynamoDBContext.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/IDynamoDBContext.cs
index 19081d794dd5..c9941d2bc5b4 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/IDynamoDBContext.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/IDynamoDBContext.cs
@@ -17,7 +17,6 @@
using System.Collections.Generic;
using Amazon.DynamoDBv2.DocumentModel;
-using Amazon.DynamoDBv2.Model;
namespace Amazon.DynamoDBv2.DataModel
{
@@ -154,7 +153,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Type of objects to get
/// Empty strongly-typed BatchGet object
- BatchGet CreateBatchGet();
+ IBatchGet CreateBatchGet();
///
/// Creates a strongly-typed BatchGet object, allowing
@@ -162,9 +161,9 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Type of objects to get
/// Empty strongly-typed BatchGet object
+ /// A BatchGet object using this context's configuration, which can be used to prepare and execute a BatchGet request
[Obsolete("Use the CreateBatchGet overload that takes BatchGetConfig instead, since DynamoDBOperationConfig contains properties that are not applicable to BatchGet.")]
- BatchGet CreateBatchGet(DynamoDBOperationConfig operationConfig = null);
+ IBatchGet CreateBatchGet(DynamoDBOperationConfig operationConfig = null);
///
/// Creates a strongly-typed BatchGet object, allowing
@@ -172,16 +171,16 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Type of objects to get
/// Empty strongly-typed BatchGet object
- public BatchGet CreateBatchGet(BatchGetConfig batchGetConfig);
+ /// A BatchGet object based on the provided
+ IBatchGet CreateBatchGet(BatchGetConfig batchGetConfig);
///
/// Creates a MultiTableBatchGet object, composed of multiple
/// individual BatchGet objects.
///
/// Composite MultiTableBatchGet object
- MultiTableBatchGet CreateMultiTableBatchGet(params BatchGet[] batches);
+ /// A MultiTableBatchGet object using this context's configuration, which can be used to prepare and execute a MultiTableBatchGet request
+ IMultiTableBatchGet CreateMultiTableBatchGet(params IBatchGet[] batches);
#endregion
@@ -193,7 +192,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Type of objects to write
/// Empty strongly-typed BatchWrite object
- BatchWrite CreateBatchWrite();
+ IBatchWrite CreateBatchWrite();
///
/// Creates a strongly-typed BatchWrite object, allowing
@@ -204,7 +203,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Empty strongly-typed BatchWrite object
[Obsolete("Use the CreateBatchWrite overload that takes BatchWriteConfig instead, since DynamoDBOperationConfig contains properties that are not applicable to BatchWrite.")]
- BatchWrite CreateBatchWrite(DynamoDBOperationConfig operationConfig = null);
+ IBatchWrite CreateBatchWrite(DynamoDBOperationConfig operationConfig = null);
///
/// Creates a strongly-typed BatchWrite object, allowing
@@ -218,7 +217,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Empty strongly-typed BatchWrite object
- BatchWrite CreateBatchWrite(Type valuesType);
+ IBatchWrite CreateBatchWrite(Type valuesType);
///
/// Creates a strongly-typed BatchWrite object, allowing
@@ -234,7 +233,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Empty strongly-typed BatchWrite object
[Obsolete("Use the CreateBatchWrite overload that takes BatchWriteConfig instead, since DynamoDBOperationConfig contains properties that are not applicable to BatchWrite.")]
- BatchWrite CreateBatchWrite(Type valuesType, DynamoDBOperationConfig operationConfig = null);
+ IBatchWrite CreateBatchWrite(Type valuesType, DynamoDBOperationConfig operationConfig = null);
///
/// Creates a strongly-typed BatchWrite object, allowing
@@ -243,7 +242,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Type of objects to write
/// Empty strongly-typed BatchWrite object
- BatchWrite CreateBatchWrite(BatchWriteConfig batchWriteConfig);
+ IBatchWrite CreateBatchWrite(BatchWriteConfig batchWriteConfig);
///
/// Creates a strongly-typed BatchWrite object, allowing
@@ -258,7 +257,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Empty strongly-typed BatchWrite object
- BatchWrite CreateBatchWrite(Type valuesType, BatchWriteConfig batchWriteConfig);
+ IBatchWrite CreateBatchWrite(Type valuesType, BatchWriteConfig batchWriteConfig);
///
/// Creates a MultiTableBatchWrite object, composed of multiple
@@ -266,7 +265,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Composite MultiTableBatchWrite object
- MultiTableBatchWrite CreateMultiTableBatchWrite(params BatchWrite[] batches);
+ IMultiTableBatchWrite CreateMultiTableBatchWrite(params IBatchWrite[] batches);
#endregion
@@ -278,7 +277,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Type of objects to get.
/// Empty strongly-typed TransactGet object.
- TransactGet CreateTransactGet();
+ ITransactGet CreateTransactGet();
///
/// Creates a strongly-typed TransactGet object, allowing
@@ -288,7 +287,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Empty strongly-typed TransactGet object.
[Obsolete("Use the CreateTransactGet overload that takes TransactGetConfig instead, since DynamoDBOperationConfig contains properties that are not applicable to BatchGet.")]
- TransactGet CreateTransactGet(DynamoDBOperationConfig operationConfig = null);
+ ITransactGet CreateTransactGet(DynamoDBOperationConfig operationConfig = null);
///
/// Creates a strongly-typed TransactGet object, allowing
@@ -297,7 +296,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Type of objects to get.
/// Empty strongly-typed TransactGet object.
- TransactGet CreateTransactGet(TransactGetConfig transactGetConfig);
+ ITransactGet CreateTransactGet(TransactGetConfig transactGetConfig);
///
/// Creates a MultiTableTransactGet object, composed of multiple
@@ -305,7 +304,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Composite MultiTableTransactGet object.
- MultiTableTransactGet CreateMultiTableTransactGet(params TransactGet[] transactionParts);
+ IMultiTableTransactGet CreateMultiTableTransactGet(params ITransactGet[] transactionParts);
#endregion
@@ -317,7 +316,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Type of objects to write.
/// Empty strongly-typed TransactWrite object.
- TransactWrite CreateTransactWrite();
+ ITransactWrite CreateTransactWrite();
///
/// Creates a strongly-typed TransactWrite object, allowing
@@ -327,7 +326,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Empty strongly-typed TransactWrite object.
[Obsolete("Use the CreateTransactWrite overload that takes TransactWriteConfig instead, since DynamoDBOperationConfig contains properties that are not applicable to CreateTransactWrite.")]
- TransactWrite CreateTransactWrite(DynamoDBOperationConfig operationConfig = null);
+ ITransactWrite CreateTransactWrite(DynamoDBOperationConfig operationConfig = null);
///
/// Creates a strongly-typed TransactWrite object, allowing
@@ -336,7 +335,7 @@ public partial interface IDynamoDBContext : IDisposable
/// Type of objects to write.
/// Empty strongly-typed TransactWrite object.
- TransactWrite CreateTransactWrite(TransactWriteConfig transactWriteConfig);
+ ITransactWrite CreateTransactWrite(TransactWriteConfig transactWriteConfig);
///
/// Creates a MultiTableTransactWrite object, composed of multiple
@@ -344,7 +343,7 @@ public partial interface IDynamoDBContext : IDisposable
///
/// Composite MultiTableTransactWrite object.
- MultiTableTransactWrite CreateMultiTableTransactWrite(params TransactWrite[] transactionParts);
+ IMultiTableTransactWrite CreateMultiTableTransactWrite(params ITransactWrite[] transactionParts);
#endregion
}
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/TransactGet.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/TransactGet.cs
index 369e6fbb54fe..7daa14368bb6 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/TransactGet.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/TransactGet.cs
@@ -13,6 +13,7 @@
* permissions and limitations under the License.
*/
+using System;
using System.Collections.Generic;
#if AWS_ASYNC_API
using System.Threading;
@@ -23,124 +24,119 @@
namespace Amazon.DynamoDBv2.DataModel
{
///
- /// Represents a non-generic object for retrieving multiple items
+ /// Represents a non-generic interface for retrieving multiple items
/// from a single DynamoDB table in a transaction.
///
- public abstract partial class TransactGet
+ public partial interface ITransactGet
{
- #region Internal/protected properties
-
///
- /// Gets and sets the UntypedResults property.
+ /// List of non-generic results retrieved from DynamoDB.
///
- protected List UntypedResults { get; set; }
- internal DynamoDBContext Context { get; set; }
- internal DynamoDBFlatConfig Config { get; set; }
- internal DocumentTransactGet DocumentTransaction { get; set; }
-
- #endregion
-
-
- #region Public properties
+ ///
+ /// This is only populated after a call to Execute.
+ ///
+ List UntypedResults { get; }
+ }
+ ///
+ /// Represents a generic interface for retrieving multiple items
+ /// from a single DynamoDB table in a transaction.
+ ///
+ public interface ITransactGet : ITransactGet
+ {
///
- /// List of results retrieved from DynamoDB.
- /// Populated after Execute is called.
+ /// List of generic results retrieved from DynamoDB.
///
- public List Results => UntypedResults;
-
- #endregion
-
-
- #region Constructor
-
- internal TransactGet(DynamoDBContext context, DynamoDBFlatConfig config)
- {
- Context = context;
- Config = config;
- }
-
- #endregion
+ ///
+ /// This is only populated after a call to Execute.
+ ///
+ List Results { get; }
+ ///
+ /// Add a single item to get, identified by its hash primary key.
+ ///
+ ///
+ /// Add a single item to get, identified by its hash-and-range primary key.
+ ///
+ ///
- /// Executes a server call to get the items requested in a transaction.
- /// Populates Results with the retrieved items.
+ /// Add a single item to get.
///
- protected internal abstract void ExecuteHelper();
+ ///
- /// Executes an asynchronous server call to get the items requested in a transaction.
- /// Populates Results with the retrieved items.
+ /// Add multiple items to get.
///
- protected internal abstract Task ExecuteHelperAsync(CancellationToken cancellationToken);
-#endif
- #endregion
+ /// keyObjects);
+ ///
+ /// Creates a MultiTableTransactGet object that is a combination
+ /// of the current TransactGet and the specified TransactGets.
+ ///
+ ///
+ /// MultiTableTransactGet consisting of the multiple TransactGet objects:
+ /// the current TransactGet object and the passed-in TransactGet objects.
+ ///
+ IMultiTableTransactGet Combine(params ITransactGet[] otherTransactionParts);
+ }
- #region Internal methods
+ ///
+ /// Represents a non-generic object for retrieving multiple items
+ /// from a single DynamoDB table in a transaction.
+ ///
+ public abstract partial class TransactGet : ITransactGet
+ {
+ internal DocumentTransactGet DocumentTransaction { get; set; }
internal abstract void PopulateResults();
- #endregion
+ /// UntypedResults { get; } = new();
}
///
/// Represents a strongly-typed object for retrieving multiple items
/// from a single DynamoDB table in a transaction.
///
- public class TransactGet : TransactGet
+ public partial class TransactGet : TransactGet, ITransactGet
{
- #region Public properties
-
- ///
- /// List of results retrieved from DynamoDB.
- /// Populated after Execute is called.
- ///
- public new List Results { get { return TypedResults; } }
-
- #endregion
+ private readonly DynamoDBContext _context;
+ private readonly DynamoDBFlatConfig _config;
+ private readonly ItemStorageConfig _storageConfig;
+ /// Results { get; } = new();
- #region Public methods
-
- ///
- /// Add a single item to get, identified by its hash primary key.
- ///
- ///
- /// Add a single item to get, identified by its hash-and-range primary key.
- ///
- ///
- /// Add a single item to get.
- ///
- ///
- /// Add multiple items to get.
- ///
- /// keyObjects)
{
foreach (var keyObject in keyObjects)
@@ -149,61 +145,32 @@ public void AddKeys(IEnumerable keyObjects)
}
}
- ///
- /// Creates a MultiTableTransactGet object that is a combination
- /// of the current TransactGet and the specified TransactGets.
- ///
- ///
- /// MultiTableTransactGet consisting of the multiple TransactGet objects:
- /// the current TransactGet object and the passed-in TransactGet objects.
- ///
- public MultiTableTransactGet Combine(params TransactGet[] otherTransactionParts)
+ /// (config);
- Table table = Context.GetTargetTable(StorageConfig, Config);
- DocumentTransaction = table.CreateTransactGet();
+ _context = context;
+ _config = config;
+ _storageConfig = context.StorageConfigCache.GetConfig(config);
+ var table = context.GetTargetTable(_storageConfig, config);
+
+ // Table.CreateTransactGet() returns the IDocumentTransactGet interface.
+ // But since we rely on the internal behavior of DocumentTransactGet, we instantiate it via the constructor.
+ DocumentTransaction = new DocumentTransactGet(table);
}
- #endregion
-
-
- #region Internal/protected/private members
-
- ///
- /// Gets and sets the TypedResults property.
- ///
- protected List TypedResults { get; set; }
-
- internal ItemStorageConfig StorageConfig { get; set; }
-
- ///
- /// Executes a server call to get the items requested in a transaction.
- /// Populates Results with the retrieved items.
- ///
- protected internal override void ExecuteHelper()
+ private void ExecuteHelper()
{
DocumentTransaction.ExecuteHelper();
PopulateResults();
}
#if AWS_ASYNC_API
- ///
- /// Executes an asynchronous server call to get the items requested in a transaction.
- /// Populates Results with the retrieved items.
- ///
- protected internal override async Task ExecuteHelperAsync(CancellationToken cancellationToken)
+ private async Task ExecuteHelperAsync(CancellationToken cancellationToken)
{
await DocumentTransaction.ExecuteHelperAsync(cancellationToken).ConfigureAwait(false);
PopulateResults();
@@ -212,96 +179,95 @@ protected internal override async Task ExecuteHelperAsync(CancellationToken canc
internal override void PopulateResults()
{
- UntypedResults = new List();
- TypedResults = new List();
+ UntypedResults.Clear();
+ Results.Clear();
foreach (var doc in DocumentTransaction.Results)
{
- var result = Context.FromDocumentHelper(doc, Config);
- TypedResults.Add(result);
+ var result = _context.FromDocumentHelper(doc, _config);
UntypedResults.Add(result);
+ Results.Add(result);
}
}
+ }
- #endregion
+ ///
+ /// Interface for retrieving multiple items from multiple DynamoDB tables,
+ /// using multiple strongly-typed TransactGet objects.
+ ///
+ public partial interface IMultiTableTransactGet
+ {
+ ///
+ /// Add a TransactGet object to the multi-table transaction request.
+ ///
+ ///
/// Class for retrieving multiple items from multiple DynamoDB tables,
/// using multiple strongly-typed TransactGet objects.
///
- public partial class MultiTableTransactGet
+ public partial class MultiTableTransactGet : IMultiTableTransactGet
{
- #region Private members
-
- private readonly List allTransactionParts;
-
- #endregion
-
-
- #region Constructor
+ private readonly List allTransactionParts;
///
/// Constructs a MultiTableTransactGet object from a number of
/// TransactGet objects.
///
/// (transactionParts);
+ allTransactionParts = new List(transactionParts);
}
- internal MultiTableTransactGet(TransactGet first, params TransactGet[] rest)
+ internal MultiTableTransactGet(ITransactGet first, params ITransactGet[] rest)
{
- allTransactionParts = new List();
+ allTransactionParts = new List();
allTransactionParts.Add(first);
allTransactionParts.AddRange(rest);
}
- #endregion
-
-
- #region Public methods
-
- ///
- /// Add a TransactGet object to the multi-table transaction request.
- ///
- ///
- /// Represents a non-generic object for writing/deleting/version-checking multiple items
+ /// Represents a non-generic interface for writing/deleting/version-checking multiple items
/// in a single DynamoDB table in a transaction.
///
- public abstract partial class TransactWrite
+ public partial interface ITransactWrite
{
- #region Internal/protected properties
+ }
- internal DynamoDBContext Context { get; set; }
- internal DynamoDBFlatConfig Config { get; set; }
- internal DocumentTransactWrite DocumentTransaction { get; set; }
+ ///
+ /// Represents a generic interface for writing/deleting/version-checking multiple items
+ /// in a single DynamoDB table in a transaction.
+ ///
+ public interface ITransactWrite : ITransactWrite
+ {
+ ///
+ /// Creates a MultiTableTransactWrite object that is a combination
+ /// of the current TransactWrite and the specified TransactWrites.
+ ///
+ ///
+ /// MultiTableTransactWrite consisting of the multiple TransactWrite objects:
+ /// the current TransactWrite object and the passed-in TransactWrite objects.
+ ///
+ MultiTableTransactWrite Combine(params TransactWrite[] otherTransactionParts);
- #endregion
+ ///
+ /// Add a number of items to be saved in the current transaction operation.
+ ///
+ /// values);
+ ///
+ /// Add a single item to be saved in the current transaction operation.
+ ///
+ ///
+ /// Add a single item to be saved in the current transaction operation.
+ /// Item is identified by its hash primary key and will be updated using the update expression provided.
+ ///
+ ///
+ /// Add a single item to be saved in the current transaction operation.
+ /// Item is identified by its hash-and-range primary key and will be updated using the update expression provided.
+ ///
+ ///
+ /// Add a number of items to be deleted in the current transaction operation.
+ ///
+ /// values);
+ ///
+ /// Add a single item to be deleted in the current transaction operation.
+ ///
+ ///
+ /// Add a single item to be deleted in the current transaction operation.
+ /// Item is identified by its hash primary key.
+ ///
+ ///
- /// Executes a server call to write/delete/version-check the items requested in a transaction.
+ /// Add a single item to be deleted in the current transaction operation.
+ /// Item is identified by its hash primary key.
///
- protected internal abstract void ExecuteHelper();
+ ///
- /// Executes an asynchronous server call to write/delete/version-check the items requested in a transaction.
+ /// Add a single item to be deleted in the current transaction operation.
+ /// Item is identified by its hash-and-range primary key.
///
- protected internal abstract Task ExecuteHelperAsync(CancellationToken cancellationToken);
-#endif
- #endregion
+ ///
+ /// Add a single item to be deleted in the current transaction operation.
+ /// Item is identified by its hash-and-range primary key.
+ ///
+ ///
+ /// Add a single item to be version checked in the current transaction operation.
+ /// The item must have a single property marked with the DynamoDBVersionAttribute.
+ ///
+ ///
+ /// Add a number of items to be version checked in the current transaction operation.
+ /// All items must have a single property marked with the DynamoDBVersionAttribute.
+ ///
+ /// items);
- #endregion
+ ///
+ /// Add a single item to be version checked in the current transaction operation.
+ /// Item is identified by its hash primary key.
+ ///
+ ///
+ /// Add a single item to be version checked in the current transaction operation.
+ /// Item is identified by its hash-and-range primary key.
+ ///
+ ///
+ /// Represents a non-generic object for writing/deleting/version-checking multiple items
+ /// in a single DynamoDB table in a transaction.
+ ///
+ public abstract partial class TransactWrite : ITransactWrite
+ {
+ internal DocumentTransactWrite DocumentTransaction { get; set; }
+
+ internal abstract void PopulateObjects();
}
///
@@ -80,33 +175,32 @@ internal TransactWrite(DynamoDBContext context, DynamoDBFlatConfig config)
#if NET8_0_OR_GREATER
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode(Amazon.DynamoDBv2.Custom.Internal.InternalConstants.RequiresUnreferencedCodeMessage)]
#endif
- public class TransactWrite : TransactWrite
+ public partial class TransactWrite : TransactWrite, ITransactWrite
{
- #region Public Combine methods
+ private readonly DynamoDBContext _context;
+ private readonly DynamoDBFlatConfig _config;
+ private readonly ItemStorageConfig _storageConfig;
+ private readonly List _objectItems = new();
- ///
- /// Creates a MultiTableTransactWrite object that is a combination
- /// of the current TransactWrite and the specified TransactWrites.
- ///
- ///
- /// MultiTableTransactWrite consisting of the multiple TransactWrite objects:
- /// the current TransactWrite object and the passed-in TransactWrite objects.
- ///
+ internal TransactWrite(DynamoDBContext context, DynamoDBFlatConfig config)
+ {
+ _context = context;
+ _config = config;
+ _storageConfig = context.StorageConfigCache.GetConfig(config);
+ Table table = _context.GetTargetTable(_storageConfig, _config);
+
+ // table.CreateTransactWrite() return the IDocumentTransactWrite interface.
+ // But since we rely on the internal behavior of DocumentTransactWrite, we instatiate it via the constructor.
+ DocumentTransaction = new DocumentTransactWrite(table);
+ }
+
+ ///
- /// Add a number of items to be saved in the current transaction operation.
- ///
- /// values)
{
if (values == null) return;
@@ -117,15 +211,12 @@ public void AddSaveItems(IEnumerable values)
}
}
- ///
- /// Add a single item to be saved in the current transaction operation.
- ///
- ///
- /// Add a single item to be saved in the current transaction operation.
- /// Item is identified by its hash primary key and will be updated using the update expression provided.
- ///
- ///
- /// Add a single item to be saved in the current transaction operation.
- /// Item is identified by its hash-and-range primary key and will be updated using the update expression provided.
- ///
- ///
- /// Add a number of items to be deleted in the current transaction operation.
- ///
- /// values)
{
if (values == null) return;
@@ -195,15 +265,12 @@ public void AddDeleteItems(IEnumerable values)
}
}
- ///
- /// Add a single item to be deleted in the current transaction operation.
- ///
- ///
- /// Add a single item to be deleted in the current transaction operation.
- /// Item is identified by its hash primary key.
- ///
- ///
- /// Add a single item to be deleted in the current transaction operation.
- /// Item is identified by its hash primary key.
- ///
- ///
- /// Add a single item to be deleted in the current transaction operation.
- /// Item is identified by its hash-and-range primary key.
- ///
- ///
- /// Add a single item to be deleted in the current transaction operation.
- /// Item is identified by its hash-and-range primary key.
- ///
- ///
- /// Add a single item to be version checked in the current transaction operation.
- /// The item must have a single property marked with the DynamoDBVersionAttribute.
- ///
- ///
- /// Add a number of items to be version checked in the current transaction operation.
- /// All items must have a single property marked with the DynamoDBVersionAttribute.
- ///
- /// items)
{
foreach (var item in items)
@@ -306,40 +340,29 @@ public void AddVersionCheckItems(IEnumerable items)
}
}
- ///
- /// Add a single item to be version checked in the current transaction operation.
- /// Item is identified by its hash primary key.
- ///
- ///
- /// Add a single item to be version checked in the current transaction operation.
- /// Item is identified by its hash-and-range primary key.
- ///
- /// (config);
- Table table = Context.GetTargetTable(StorageConfig, Config);
- DocumentTransaction = table.CreateTransactWrite();
- }
-
- #endregion
-
-
- #region Internal/protected/private members
-
- private readonly List objectItems = new List();
-
- internal ItemStorageConfig StorageConfig { get; set; }
-
- ///
- /// Executes a server call to write/delete/version-check the items requested in a transaction.
- ///
- protected internal override void ExecuteHelper()
+ private void ExecuteHelper()
{
DocumentTransaction.ExecuteHelper();
PopulateObjects();
}
#if AWS_ASYNC_API
- ///
- /// Executes an asynchronous server call to write/delete/version-check the items requested in a transaction.
- ///
- protected internal override async Task ExecuteHelperAsync(CancellationToken cancellationToken)
+ private async Task ExecuteHelperAsync(CancellationToken cancellationToken)
{
await DocumentTransaction.ExecuteHelperAsync(cancellationToken).ConfigureAwait(false);
PopulateObjects();
@@ -397,27 +392,27 @@ protected internal override async Task ExecuteHelperAsync(CancellationToken canc
internal override void PopulateObjects()
{
- foreach (var objectItem in objectItems)
+ foreach (var objectItem in _objectItems)
{
- objectItem.PopulateObject(Context, Config);
+ objectItem.PopulateObject(_context, _config);
}
}
private bool ShouldUseVersioning()
{
- var skipVersionCheck = Config.SkipVersionCheck ?? false;
- return !skipVersionCheck && StorageConfig.HasVersion;
+ var skipVersionCheck = _config.SkipVersionCheck ?? false;
+ return !skipVersionCheck && _storageConfig.HasVersion;
}
private void CheckUseVersioning()
{
- if (Config.SkipVersionCheck == true)
+ if (_config.SkipVersionCheck == true)
{
throw new InvalidOperationException(
"Using DynamoDBContextConfig.SkipVersionCheck property with true value is not supported for this operation.");
}
- if (!StorageConfig.HasVersion)
+ if (!_storageConfig.HasVersion)
{
throw new InvalidOperationException(string.Format(CultureInfo.InvariantCulture,
"Object {0} does not have a versioning field, which is not supported for this operation.",
@@ -439,86 +434,86 @@ private void SetNewVersion(ItemStorage storage)
if (!ShouldUseVersioning()) return;
DynamoDBContext.SetNewVersion(storage);
}
+ }
- #endregion
+ ///
+ /// Interface for writing/deleting/version-checking multiple items in multiple DynamoDB tables,
+ /// using multiple strongly-typed TransactWrite objects.
+ ///
+ public partial interface IMultiTableTransactWrite
+ {
+ ///
+ /// Add a TransactWrite object to the multi-table transaction request.
+ ///
+ ///
/// Class for writing/deleting/version-checking multiple items in multiple DynamoDB tables,
/// using multiple strongly-typed TransactWrite objects.
///
- public partial class MultiTableTransactWrite
+ public partial class MultiTableTransactWrite : IMultiTableTransactWrite
{
- #region Private members
-
- private readonly List allTransactionParts;
-
- #endregion
-
-
- #region Constructor
+ private readonly List allTransactionParts;
///
/// Constructs a MultiTableTransactWrite object from a number of
/// TransactWrite objects
///
/// (transactionParts);
+ allTransactionParts = new List(transactionParts);
}
- internal MultiTableTransactWrite(TransactWrite first, params TransactWrite[] rest)
+ internal MultiTableTransactWrite(ITransactWrite first, params ITransactWrite[] rest)
{
- allTransactionParts = new List();
+ allTransactionParts = new List();
allTransactionParts.Add(first);
allTransactionParts.AddRange(rest);
}
- #endregion
-
-
- #region Public methods
-
- ///
- /// Add a TransactWrite object to the multi-table transaction request.
- ///
- ///
- /// A strongly-typed object for retrieving search results (Query or Scan)
- /// from DynamoDB.
- ///
- ///
+ public partial interface IAsyncSearch
{
- #region Async public
-
///
/// Initiates the asynchronous execution to get the next set of results from DynamoDB.
///
@@ -45,12 +34,7 @@ public partial class AsyncSearch
/// A Task that can be used to poll or wait for results, or both.
/// Results will include the next set of result items from DynamoDB.
///
- public virtual async Task> GetNextSetAsync(CancellationToken cancellationToken = default(CancellationToken))
- {
- var documents = await DocumentSearch.GetNextSetHelperAsync(cancellationToken).ConfigureAwait(false);
- List items = SourceContext.FromDocumentsHelper(documents, this.Config).ToList();
- return items;
- }
+ Task> GetNextSetAsync(CancellationToken cancellationToken = default(CancellationToken));
///
/// Initiates the asynchronous execution to get all the remaining results from DynamoDB.
@@ -60,13 +44,25 @@ public partial class AsyncSearch
/// A Task that can be used to poll or wait for results, or both.
/// Results will include the remaining result items from DynamoDB.
///
- public virtual async Task> GetRemainingAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task> GetRemainingAsync(CancellationToken cancellationToken = default(CancellationToken));
+ }
+
+ public partial class AsyncSearch : IAsyncSearch
+ {
+ /// > GetNextSetAsync(CancellationToken cancellationToken = default(CancellationToken))
{
- var documents = await DocumentSearch.GetRemainingHelperAsync(cancellationToken).ConfigureAwait(false);
- List items = SourceContext.FromDocumentsHelper(documents, this.Config).ToList();
+ var documents = await _documentSearch.GetNextSetHelperAsync(cancellationToken).ConfigureAwait(false);
+ List items = _sourceContext.FromDocumentsHelper(documents, this._config).ToList();
return items;
}
- #endregion
+ /// > GetRemainingAsync(CancellationToken cancellationToken = default(CancellationToken))
+ {
+ var documents = await _documentSearch.GetRemainingHelperAsync(cancellationToken).ConfigureAwait(false);
+ List items = _sourceContext.FromDocumentsHelper(documents, this._config).ToList();
+ return items;
+ }
}
}
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/BatchGet.Async.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/BatchGet.Async.cs
index b40710792c17..561e70161b56 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/BatchGet.Async.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/BatchGet.Async.cs
@@ -14,48 +14,39 @@
*/
#pragma warning disable 1574
-using System;
-using System.Collections;
-using System.Collections.Generic;
-using System.Reflection;
-using Amazon.DynamoDBv2.Model;
-using Amazon.DynamoDBv2.DocumentModel;
using System.Threading;
using System.Threading.Tasks;
-using Amazon.Runtime.Internal;
namespace Amazon.DynamoDBv2.DataModel
{
- ///
- /// Represents a non-generic object for retrieving a batch of items
- /// from a single DynamoDB table
- ///
- public abstract partial class BatchGet
+ public partial interface IBatchGet
{
- #region Public methods
-
///
/// Executes a server call to batch-get the items requested.
///
/// A Task that can be used to poll or wait for results, or both.
- public Task ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken));
+ }
+
+ public abstract partial class BatchGet
+ {
+ /// : BatchGet, IBatchGet
+ {
+ ///
- /// Class for retrieving a batch of items from multiple DynamoDB tables,
- /// using multiple strongly-typed BatchGet objects
- ///
- public partial class MultiTableBatchGet
+ public partial interface IMultiTableBatchGet
{
- #region Public methods
-
///
/// Executes a multi-table batch request against all configured batches.
/// Results are stored in the respective BatchGet objects.
@@ -63,11 +54,15 @@ public partial class MultiTableBatchGet
/// A Task that can be used to poll or wait for results, or both.
+ Task ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken));
+ }
+
+ public partial class MultiTableBatchGet : IMultiTableBatchGet
+ {
+ ///
- /// Represents a non-generic object for writing/deleting a batch of items
- /// in a single DynamoDB table
- ///
- public abstract partial class BatchWrite
+ public partial interface IBatchWrite
{
- #region Public methods
-
///
/// Executes a server call to batch-write/delete the items requested.
///
@@ -43,22 +30,26 @@ public abstract partial class BatchWrite
/// A Task that can be used to poll or wait for results, or both.
- public Task ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken))
+ Task ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken));
+ }
+
+ public abstract partial class BatchWrite : IBatchWrite
+ {
+ /// : BatchWrite, IBatchWrite
+ {
+ ///
- /// Class for writing/deleting a batch of items in multiple DynamoDB tables,
- /// using multiple strongly-typed BatchWrite objects
- ///
- public partial class MultiTableBatchWrite
+ public partial interface IMultiTableBatchWrite
{
- #region Public methods
-
///
/// Executes a multi-table batch request against all configured batches.
///
@@ -68,11 +59,15 @@ public partial class MultiTableBatchWrite
/// A Task that can be used to poll or wait for results, or both.
+ Task ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken));
+ }
+
+ public partial class MultiTableBatchWrite : IMultiTableBatchWrite
+ {
+ /// (object hashKey, object rangeKey, DeleteConfig deleteC
#region BatchGet async
- ///
- /// Issues a batch-get request with multiple batches.
- ///
- /// Results are stored in the individual batches.
- ///
- ///
- /// Issues a batch-get request with multiple batches.
- ///
- /// Results are stored in the individual batches.
- ///
- ///
- /// Issues a batch-write request with multiple batches.
- ///
- ///
- /// Issues a transactional get request with multiple TransactGet objects.
- /// Results are stored in the individual TransactGet objects.
- ///
- /// A Task that can be used to poll or wait for results, or both.
- public Task ExecuteTransactGetAsync(TransactGet[] transactionParts, CancellationToken cancellationToken = default(CancellationToken))
+ ///
- /// Issues a transactional write request with multiple TransactWrite objects.
- ///
- /// A Task that can be used to poll or wait for results, or both.
- public Task ExecuteTransactWriteAsync(TransactWrite[] transactionParts, CancellationToken cancellationToken = default(CancellationToken))
+ /// ScanAsync(IEnumerable conditions)
+ public IAsyncSearch ScanAsync(IEnumerable conditions)
{
var scan = ConvertScan(conditions, null);
return FromSearchAsync(scan);
@@ -292,21 +253,21 @@ public AsyncSearch ScanAsync(IEnumerable conditions)
/// ScanAsync(IEnumerable conditions, DynamoDBOperationConfig operationConfig = null)
+ public IAsyncSearch ScanAsync(IEnumerable conditions, DynamoDBOperationConfig operationConfig = null)
{
var scan = ConvertScan(conditions, operationConfig);
return FromSearchAsync(scan);
}
/// ScanAsync(IEnumerable conditions, ScanConfig scanConfig)
+ public IAsyncSearch ScanAsync(IEnumerable conditions, ScanConfig scanConfig)
{
var scan = ConvertScan(conditions, scanConfig?.ToDynamoDBOperationConfig());
return FromSearchAsync(scan);
}
/// FromScanAsync(ScanOperationConfig scanConfig)
+ public IAsyncSearch FromScanAsync(ScanOperationConfig scanConfig)
{
if (scanConfig == null) throw new ArgumentNullException("scanConfig");
@@ -316,7 +277,7 @@ public AsyncSearch FromScanAsync(ScanOperationConfig scanConfig)
/// FromScanAsync(ScanOperationConfig scanConfig, DynamoDBOperationConfig operationConfig = null)
+ public IAsyncSearch FromScanAsync(ScanOperationConfig scanConfig, DynamoDBOperationConfig operationConfig = null)
{
if (scanConfig == null) throw new ArgumentNullException("scanConfig");
@@ -325,7 +286,7 @@ public AsyncSearch FromScanAsync(ScanOperationConfig scanConfig, DynamoDBO
}
/// FromScanAsync(ScanOperationConfig scanConfig, FromScanConfig fromScanConfig)
+ public IAsyncSearch FromScanAsync(ScanOperationConfig scanConfig, FromScanConfig fromScanConfig)
{
if (scanConfig == null) throw new ArgumentNullException("scanConfig");
@@ -338,7 +299,7 @@ public AsyncSearch FromScanAsync(ScanOperationConfig scanConfig, FromScanC
#region Query async
/// QueryAsync(object hashKeyValue)
+ public IAsyncSearch QueryAsync(object hashKeyValue)
{
var query = ConvertQueryByValue(hashKeyValue, null, null);
return FromSearchAsync(query);
@@ -346,21 +307,21 @@ public AsyncSearch QueryAsync(object hashKeyValue)
/// QueryAsync(object hashKeyValue, DynamoDBOperationConfig operationConfig = null)
+ public IAsyncSearch QueryAsync(object hashKeyValue, DynamoDBOperationConfig operationConfig = null)
{
var query = ConvertQueryByValue(hashKeyValue, null, operationConfig);
return FromSearchAsync(query);
}
/// QueryAsync(object hashKeyValue, QueryConfig queryConfig)
+ public IAsyncSearch QueryAsync(object hashKeyValue, QueryConfig queryConfig)
{
var query = ConvertQueryByValue(hashKeyValue, null, queryConfig?.ToDynamoDBOperationConfig());
return FromSearchAsync(query);
}
/// QueryAsync(object hashKeyValue, QueryOperator op, IEnumerable values)
+ public IAsyncSearch QueryAsync(object hashKeyValue, QueryOperator op, IEnumerable values)
{
if (values == null)
throw new ArgumentNullException("values");
@@ -371,7 +332,7 @@ public AsyncSearch QueryAsync(object hashKeyValue, QueryOperator op, IEnum
/// QueryAsync(object hashKeyValue, QueryOperator op, IEnumerable values, DynamoDBOperationConfig operationConfig = null)
+ public IAsyncSearch QueryAsync(object hashKeyValue, QueryOperator op, IEnumerable values, DynamoDBOperationConfig operationConfig = null)
{
if (values == null)
throw new ArgumentNullException("values");
@@ -381,7 +342,7 @@ public AsyncSearch QueryAsync(object hashKeyValue, QueryOperator op, IEnum
}
/// QueryAsync(object hashKeyValue, QueryOperator op, IEnumerable values, QueryConfig queryConfig)
+ public IAsyncSearch QueryAsync(object hashKeyValue, QueryOperator op, IEnumerable values, QueryConfig queryConfig)
{
if (values == null)
throw new ArgumentNullException("values");
@@ -391,7 +352,7 @@ public AsyncSearch QueryAsync(object hashKeyValue, QueryOperator op, IEnum
}
/// FromQueryAsync(QueryOperationConfig queryConfig)
+ public IAsyncSearch FromQueryAsync(QueryOperationConfig queryConfig)
{
if (queryConfig == null) throw new ArgumentNullException("queryConfig");
@@ -401,7 +362,7 @@ public AsyncSearch FromQueryAsync(QueryOperationConfig queryConfig)
/// FromQueryAsync(QueryOperationConfig queryConfig, DynamoDBOperationConfig operationConfig = null)
+ public IAsyncSearch FromQueryAsync(QueryOperationConfig queryConfig, DynamoDBOperationConfig operationConfig = null)
{
if (queryConfig == null) throw new ArgumentNullException("queryConfig");
@@ -410,7 +371,7 @@ public AsyncSearch FromQueryAsync(QueryOperationConfig queryConfig, Dynamo
}
/// FromQueryAsync(QueryOperationConfig queryConfig, FromQueryConfig fromQueryConfig)
+ public IAsyncSearch FromQueryAsync(QueryOperationConfig queryConfig, FromQueryConfig fromQueryConfig)
{
if (queryConfig == null) throw new ArgumentNullException("queryConfig");
diff --git a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
index 7f10ebfa10c7..98a1bee4674d 100644
--- a/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
+++ b/sdk/src/Services/DynamoDBv2/Custom/DataModel/_async/IDynamoDBContext.Async.cs
@@ -407,6 +407,17 @@ partial interface IDynamoDBContext
#region BatchGet async
+ ///
+ /// Issues a batch-get request with multiple batches.
+ ///
+ /// Results are stored in the individual batches.
+ ///
+ /// A Task that can be used to poll or wait for results, or both.
+ Task ExecuteBatchGetAsync(params IBatchGet[] batches);
+
///
/// Issues a batch-get request with multiple batches.
///
@@ -417,7 +428,7 @@ partial interface IDynamoDBContext
///
/// A Task that can be used to poll or wait for results, or both.
- Task ExecuteBatchGetAsync(BatchGet[] batches, CancellationToken cancellationToken = default(CancellationToken));
+ Task ExecuteBatchGetAsync(IBatchGet[] batches, CancellationToken cancellationToken = default(CancellationToken));
#endregion
@@ -431,7 +442,7 @@ partial interface IDynamoDBContext
///
/// A Task that can be used to poll or wait for results, or both.
- Task ExecuteBatchWriteAsync(BatchWrite[] batches, CancellationToken cancellationToken = default(CancellationToken));
+ Task ExecuteBatchWriteAsync(IBatchWrite[] batches, CancellationToken cancellationToken = default(CancellationToken));
#endregion
@@ -444,7 +455,7 @@ partial interface IDynamoDBContext
/// A Task that can be used to poll or wait for results, or both.
- Task ExecuteTransactGetAsync(TransactGet[] transactionParts, CancellationToken cancellationToken = default(CancellationToken));
+ Task ExecuteTransactGetAsync(ITransactGet[] transactionParts, CancellationToken cancellationToken = default(CancellationToken));
#endregion
@@ -456,7 +467,7 @@ partial interface IDynamoDBContext
/// A Task that can be used to poll or wait for results, or both.
- Task ExecuteTransactWriteAsync(TransactWrite[] transactionParts, CancellationToken cancellationToken = default(CancellationToken));
+ Task ExecuteTransactWriteAsync(ITransactWrite[] transactionParts, CancellationToken cancellationToken = default(CancellationToken));
#endregion
@@ -471,7 +482,7 @@ partial interface IDynamoDBContext
/// Conditions that the results should meet.
///
/// AsyncSearch which can be used to retrieve DynamoDB data.
- AsyncSearch ScanAsync(IEnumerable conditions);
+ IAsyncSearch ScanAsync(IEnumerable conditions);
///
/// Configures an async Scan operation against DynamoDB, finding items
@@ -485,7 +496,7 @@ partial interface IDynamoDBContext
/// AsyncSearch which can be used to retrieve DynamoDB data.
[Obsolete("Use the ScanAsync overload that takes ScanConfig instead, since DynamoDBOperationConfig contains properties that are not applicable to ScanAsync.")]
- AsyncSearch ScanAsync(IEnumerable conditions, DynamoDBOperationConfig operationConfig = null);
+ IAsyncSearch ScanAsync(IEnumerable conditions, DynamoDBOperationConfig operationConfig = null);
///
/// Configures an async Scan operation against DynamoDB, finding items
@@ -497,7 +508,7 @@ partial interface IDynamoDBContext
///
/// AsyncSearch which can be used to retrieve DynamoDB data.
- AsyncSearch ScanAsync(IEnumerable conditions, ScanConfig scanConfig);
+ IAsyncSearch ScanAsync(IEnumerable