Skip to content

Remove the Context/Operation Config Hierarchy, and Remove Table-level Configurations from DynamoDBOperationConfig #3422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 14, 2024
Merged

Remove the Context/Operation Config Hierarchy, and Remove Table-level Configurations from DynamoDBOperationConfig #3422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c1d7b5
fix: Honor an OverrideTableName and DisableFetchingTableMetadata when…
ashovlin Aug 5, 2024
e11b6e5
Separate DynamoDBContextConfig and DynamoDBOperationConfig, clean up …
ashovlin Aug 10, 2024
cd2e44a
Remove table caching properties from operation specific configs.
ashovlin Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions sdk/src/Services/DynamoDBv2/Custom/DataModel/BaseOperationConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,30 +41,6 @@ public abstract class BaseOperationConfig
/// </summary>
public string TableNamePrefix { get; set; }

/// <summary>
/// The object persistence model API relies on an internal cache of the DynamoDB table's metadata to
/// construct and validate requests. This controls how the cache key is derived, which influences
/// when the SDK will call DescribeTable internally to populate the cache.
/// </summary>
/// <remarks>
/// For <see cref="MetadataCachingMode.Default"/> the cache key will be a combination of the table name, credentials, region and service URL.
/// For <see cref="MetadataCachingMode.TableNameOnly"/> the cache key will only consist of the table name. This reduces cache misses in contexts
/// where you are accessing tables with identical structure but using different credentials or endpoints (such as a multi-tenant application).
/// </remarks>
public MetadataCachingMode? MetadataCachingMode { get; set; }

/// <summary>
/// If true disables fetching table metadata automatically from DynamoDB. Table metadata must be
/// defined by <see cref="DynamoDBAttribute"/> attributes and/or in <see cref = "AWSConfigsDynamoDB"/>.
/// </summary>
/// <remarks>
/// Setting this to true can avoid latency and thread starvation due to blocking asynchronous
/// DescribeTable calls that are used to populate the SDK's cache of table metadata.
/// It requires that the table's index schema be accurately described via the above methods,
/// otherwise exceptions may be thrown and/or the results of certain DynamoDB operations may change.
/// </remarks>
public bool? DisableFetchingTableMetadata { get; set; }

/// <summary>
/// Specification which controls the conversion between .NET and DynamoDB types.
/// </summary>
Expand All @@ -91,8 +67,6 @@ internal virtual DynamoDBOperationConfig ToDynamoDBOperationConfig()
{
OverrideTableName = OverrideTableName,
TableNamePrefix = TableNamePrefix,
MetadataCachingMode = MetadataCachingMode,
DisableFetchingTableMetadata = DisableFetchingTableMetadata,
Conversion = Conversion,
IsEmptyStringValueEnabled = IsEmptyStringValueEnabled
};
Expand Down
151 changes: 116 additions & 35 deletions sdk/src/Services/DynamoDBv2/Custom/DataModel/Configs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,10 @@
* permissions and limitations under the License.
*/

using System;
using System.Collections.Generic;

using Amazon.DynamoDBv2.DocumentModel;
using Amazon.DynamoDBv2.Model;
using System.Globalization;
using Amazon.Util;
using System;
using System.Collections.Generic;

namespace Amazon.DynamoDBv2.DataModel
{
Expand Down Expand Up @@ -48,8 +45,8 @@ public interface IPropertyConverter
}

/// <summary>
/// Configuration object for setting options on the DynamoDBContext.
/// and individual operations.
/// Configuration object for setting options on the <see cref="DynamoDBContext"/> that
/// will apply to all operations that use the context object.
/// </summary>
#if NET8_0_OR_GREATER
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode(Amazon.DynamoDBv2.Custom.Internal.InternalConstants.RequiresUnreferencedCodeMessage)]
Expand All @@ -69,20 +66,24 @@ public DynamoDBContextConfig()
}

/// <summary>
/// Property that directs DynamoDBContext to use consistent reads.
/// Property that directs <see cref="DynamoDBContext"/> to use consistent reads.
/// If property is not set, behavior defaults to non-consistent reads.
/// </summary>
/// <remarks>
/// Refer to the <see href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
/// Read Consistency</see> topic in the DynamoDB Developer Guide for more information.
/// </remarks>
public bool? ConsistentRead { get; set; }

/// <summary>
/// Property that directs DynamoDBContext to skip version checks
/// Property that directs <see cref="DynamoDBContext"/> to skip version checks
/// when saving or deleting an object with a version attribute.
/// If property is not set, version checks are performed.
/// </summary>
public bool? SkipVersionCheck { get; set; }

/// <summary>
/// Property that directs DynamoDBContext to prefix all table names
/// Property that directs <see cref="DynamoDBContext"/> to prefix all table names
/// with a specific string.
/// If property is null or empty, no prefix is used and default
/// table names are used.
Expand All @@ -102,15 +103,15 @@ public DynamoDBContextConfig()
public MetadataCachingMode? MetadataCachingMode { get; set; }

/// <summary>
/// Property that directs DynamoDBContext to ignore null values
/// Property that directs <see cref="DynamoDBContext"/> to ignore null values
/// on attributes during a Save operation.
/// If the property is false (or not set), null values will be
/// interpreted as directives to delete the specific attribute.
/// </summary>
public bool? IgnoreNullValues { get; set; }

/// <summary>
/// Property that directs DynamoDBContext to enable empty string values
/// Property that directs <see cref="DynamoDBContext"/> to enable empty string values
/// on attributes during a Save operation.
/// If the property is false (or not set), empty string values will be
/// interpreted as null values.
Expand Down Expand Up @@ -138,7 +139,9 @@ public DynamoDBContextConfig()
/// <summary>
/// If true, all <see cref="DateTime"/> properties are retrieved in UTC timezone while reading data from DynamoDB. Else, the local timezone is used.
/// </summary>
/// <remarks>This setting is only applicable to the high-level library. Service calls made via <see cref="AmazonDynamoDBClient"/> will always return <see cref="DateTime"/> attributes in UTC.</remarks>
/// <remarks>This setting is only applicable to the high-level library.
/// Service calls made via <see cref="AmazonDynamoDBClient"/> will always return
/// <see cref="DateTime"/> attributes in UTC.</remarks>
public bool? RetrieveDateTimeInUtc { get; set; }
}

Expand All @@ -150,17 +153,77 @@ public DynamoDBContextConfig()
#if NET8_0_OR_GREATER
[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode(Amazon.DynamoDBv2.Custom.Internal.InternalConstants.RequiresUnreferencedCodeMessage)]
#endif
public class DynamoDBOperationConfig : DynamoDBContextConfig
public class DynamoDBOperationConfig
{
/// <summary>
/// Property that indicates the table to save an object to overriding the DynamoDBTable attribute
/// declared for the type.
/// Property that directs <see cref="DynamoDBContext"/> to use consistent reads.
/// If property is not set, behavior defaults to non-consistent reads.
/// </summary>
/// <remarks>
/// Refer to the <see href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">
/// Read Consistency</see> topic in the DynamoDB Developer Guide for more information.
/// </remarks>
public bool? ConsistentRead { get; set; }

/// <summary>
/// Property that directs <see cref="DynamoDBContext"/> to skip version checks
/// when saving or deleting an object with a version attribute.
/// If property is not set, version checks are performed.
/// </summary>
public bool? SkipVersionCheck { get; set; }

/// <summary>
/// Indicates which DynamoDB table to use. This overrides the table specified
/// by the <see cref="DynamoDBTableAttribute"/> on the .NET objects that you're saving or loading.
/// </summary>
/// <remarks>
/// If you want to specify this globally instead of for each operation, you can use
/// the <see cref="TableAlias"/> or <see cref="TypeMapping"/> collections
/// on <see cref="AWSConfigsDynamoDB.Context"/>.
/// </remarks>
Comment on lines +180 to +183
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New note the suggests an alternative to the operation-level override.

public string OverrideTableName { get; set; }

/// <summary>
/// Property that indicates a query should traverse the index backward.
/// If the property is false (or not set), traversal shall be forward.
/// Property that directs <see cref="DynamoDBContext"/> to prefix all table names
/// with a specific string.
/// If property is null or empty, no prefix is used and default
/// table names are used.
/// </summary>
public string TableNamePrefix { get; set; }

/// <summary>
/// Property that directs <see cref="DynamoDBContext"/> to ignore null values
/// on attributes during a Save operation.
/// If the property is false (or not set), null values will be
/// interpreted as directives to delete the specific attribute.
/// </summary>
public bool? IgnoreNullValues { get; set; }

/// <summary>
/// Property that directs <see cref="DynamoDBContext"/> to enable empty string values
/// on attributes during a Save operation.
/// If the property is false (or not set), empty string values will be
/// interpreted as null values.
/// </summary>
public bool? IsEmptyStringValueEnabled { get; set; }

/// <summary>
/// Conversion specification which controls how conversion between
/// .NET and DynamoDB types happens.
/// </summary>
public DynamoDBEntryConversion Conversion { get; set; }

/// <summary>
/// If true, all <see cref="DateTime"/> properties are retrieved in UTC timezone while reading data from DynamoDB. Else, the local timezone is used.
/// </summary>
/// <remarks>This setting is only applicable to the high-level library.
/// Service calls made via <see cref="AmazonDynamoDBClient"/> will always return
/// <see cref="DateTime"/> attributes in UTC.</remarks>
public bool? RetrieveDateTimeInUtc { get; set; }

/// <summary>
/// Indicates whether a query should traverse the index backwards in descending order by range key value.
/// If the property is false (or not set), traversal shall be in ascending order.
/// </summary>
public bool? BackwardQuery { get; set; }

Expand All @@ -171,20 +234,31 @@ public class DynamoDBOperationConfig : DynamoDBContextConfig
public string IndexName { get; set; }

/// <summary>
/// A logical operator to apply to the filter conditions:
/// AND - If all of the conditions evaluate to true, then the entire filter evaluates to true.
/// OR - If at least one of the conditions evaluate to true, then the entire filter evaluates to true.
///
/// Default value is AND.
/// The logical operator to apply to the filter conditions.
/// </summary>
/// <remarks>
/// <list type="bullet">
/// <item>
/// <term><see cref="ConditionalOperatorValues.And" /></term>
/// <definition>If all of the conditions evaluate to true, then the entire filter evaluates to true.</definition>
/// </item>
/// <item>
/// <term><see cref="ConditionalOperatorValues.Or" /></term>
/// <definition>If at least one of the conditions evaluate to true, then the entire filter evaluates to true.</definition>
/// </item>
/// </list>
/// The default value is <see cref="ConditionalOperatorValues.And" />.
/// </remarks>
public ConditionalOperatorValues ConditionalOperator { get; set; }

/// <summary>
/// Query filter for the Query operation operation. Evaluates the query results and returns only
/// Query filter for the Query operation. Evaluates the query results and returns only
/// the matching values. If you specify more than one condition, then by default all of the
/// conditions must evaluate to true. To match only some conditions, set ConditionalOperator to Or.
/// Note: Conditions must be against non-key properties.
/// conditions must evaluate to true. To match only some conditions, set <see cref="ConditionalOperator"/> to <see cref="ConditionalOperatorValues.Or" />.
/// </summary>
/// <remarks>
/// Note: Conditions must be against non-key properties.
/// </remarks>
public List<ScanCondition> QueryFilter { get; set; }

/// <summary>
Expand All @@ -195,7 +269,9 @@ public DynamoDBOperationConfig()
QueryFilter = new List<ScanCondition>();
}

// Checks if the IndexName is set on the config
/// <summary>
/// Checks if the IndexName is set on the config
/// </summary>
internal bool IsIndexOperation { get { return !string.IsNullOrEmpty(IndexName); } }
}

Expand Down Expand Up @@ -325,8 +401,7 @@ internal class DynamoDBFlatConfig
IndexName = null,
ConditionalOperator = ConditionalOperatorValues.And,
Conversion = null,
IsEmptyStringValueEnabled = null,
MetadataCachingMode = null
IsEmptyStringValueEnabled = null
};
private static DynamoDBContextConfig _emptyContextConfig = new DynamoDBContextConfig
{
Expand All @@ -346,25 +421,31 @@ public DynamoDBFlatConfig(DynamoDBOperationConfig operationConfig, DynamoDBConte
if (contextConfig == null)
contextConfig = _emptyContextConfig;

// These properties can be set at either the operation or context levels
bool consistentRead = operationConfig.ConsistentRead ?? contextConfig.ConsistentRead ?? false;
bool skipVersionCheck = operationConfig.SkipVersionCheck ?? contextConfig.SkipVersionCheck ?? false;
bool ignoreNullValues = operationConfig.IgnoreNullValues ?? contextConfig.IgnoreNullValues ?? false;
bool disableFetchingTableMetadata = contextConfig.DisableFetchingTableMetadata ?? false;
bool retrieveDateTimeInUtc = operationConfig.RetrieveDateTimeInUtc ?? contextConfig.RetrieveDateTimeInUtc ?? false;

bool isEmptyStringValueEnabled = operationConfig.IsEmptyStringValueEnabled ?? contextConfig.IsEmptyStringValueEnabled ?? false;
string overrideTableName =
!string.IsNullOrEmpty(operationConfig.OverrideTableName) ? operationConfig.OverrideTableName : string.Empty;
DynamoDBEntryConversion conversion = operationConfig.Conversion ?? contextConfig.Conversion ?? DynamoDBEntryConversion.CurrentConversion;
string tableNamePrefix =
!string.IsNullOrEmpty(operationConfig.TableNamePrefix) ? operationConfig.TableNamePrefix :
!string.IsNullOrEmpty(contextConfig.TableNamePrefix) ? contextConfig.TableNamePrefix : string.Empty;

// These properties can only be set at the operation level
bool disableFetchingTableMetadata = contextConfig.DisableFetchingTableMetadata ?? false;
MetadataCachingMode metadataCachingMode = contextConfig.MetadataCachingMode ?? DynamoDBv2.MetadataCachingMode.Default;

// We don't support overriding the table name at the context level, since a context object can be used with multiple tables.
string overrideTableName =
!string.IsNullOrEmpty(operationConfig.OverrideTableName) ? operationConfig.OverrideTableName : string.Empty;

// The rest are related to querying or scanning, so only operation level
bool backwardQuery = operationConfig.BackwardQuery ?? false;
string indexName =
!string.IsNullOrEmpty(operationConfig.IndexName) ? operationConfig.IndexName : DefaultIndexName;
List<ScanCondition> queryFilter = operationConfig.QueryFilter ?? new List<ScanCondition>();
ConditionalOperatorValues conditionalOperator = operationConfig.ConditionalOperator;
DynamoDBEntryConversion conversion = operationConfig.Conversion ?? contextConfig.Conversion ?? DynamoDBEntryConversion.CurrentConversion;
MetadataCachingMode metadataCachingMode = operationConfig.MetadataCachingMode ?? contextConfig.MetadataCachingMode ?? DynamoDBv2.MetadataCachingMode.Default;

ConsistentRead = consistentRead;
SkipVersionCheck = skipVersionCheck;
Expand Down
Loading