Skip to content

Support ScannedCount on DynamoDb Document Model #3751

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.

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 6 commits into from
Jun 2, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
11 changes: 11 additions & 0 deletions generator/.DevConfigs/778f8bc5-440c-4d7f-8f02-2224fbc2649d.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"services": [
{
"serviceName": "DynamoDBv2",
"type": "patch",
"changeLogMessages": [
"Exposed ScannedCount property on the Search class within the Document Model."
]
}
]
}
38 changes: 37 additions & 1 deletion sdk/src/Services/DynamoDBv2/Custom/DocumentModel/Search.cs
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,22 @@ public partial interface ISearch
/// </summary>
int Count { get; }

/// <summary>
/// Gets the total number of items evaluated, before any ScanFilter is applied.
/// <para>
/// The number of items evaluated, before any <c>ScanFilter</c> is applied. A high <c>ScannedCount</c>
/// value with few, or no, <c>Count</c> results indicates an inefficient <c>Scan</c> operation.
/// For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count">Count
/// and ScannedCount</a> in the <i>Amazon DynamoDB Developer Guide</i>.
/// </para>
///
/// <para>
/// If you did not use a filter in the request, then <c>ScannedCount</c> is the same as
/// <c>Count</c>.
/// </para>
/// </summary>
int ScannedCount { get; }

/// <summary>
/// Name of the index to query or scan against.
/// </summary>
Expand Down Expand Up @@ -258,7 +274,10 @@ internal set
public int Segment { get; set; }

/// <inheritdoc/>
public int Count { get { return GetCount(); } }
public int Count => GetCount();

/// <inheritdoc/>
public int ScannedCount => scannedCount;

/// <inheritdoc/>
public string IndexName { get; internal set; }
Expand Down Expand Up @@ -341,6 +360,7 @@ internal List<Document> GetNextSetHelper()
}
}
NextKey = scanResult.LastEvaluatedKey;
scannedCount = scanResult.ScannedCount.GetValueOrDefault();
if (NextKey == null || NextKey.Count == 0)
{
IsDone = true;
Expand Down Expand Up @@ -391,6 +411,7 @@ internal List<Document> GetNextSetHelper()
}
}
NextKey = queryResult.LastEvaluatedKey;
scannedCount = queryResult.ScannedCount.GetValueOrDefault();
if (NextKey == null || NextKey.Count == 0)
{
IsDone = true;
Expand Down Expand Up @@ -455,6 +476,8 @@ internal async Task<List<Document>> GetNextSetHelperAsync(CancellationToken canc
}
}
NextKey = scanResult.LastEvaluatedKey;
scannedCount = scanResult.ScannedCount.GetValueOrDefault();

if (NextKey == null || NextKey.Count == 0)
{
IsDone = true;
Expand Down Expand Up @@ -497,6 +520,8 @@ internal async Task<List<Document>> GetNextSetHelperAsync(CancellationToken canc
}
}
NextKey = queryResult.LastEvaluatedKey;
scannedCount = queryResult.ScannedCount.GetValueOrDefault();

if (NextKey == null || NextKey.Count == 0)
{
IsDone = true;
Expand All @@ -517,10 +542,12 @@ internal List<Document> GetRemainingHelper()

while (!IsDone)
{
var previousScannedCount = scannedCount;
foreach (Document doc in GetNextSetHelper())
{
ret.Add(doc);
}
scannedCount += previousScannedCount;
}

return ret;
Expand All @@ -533,10 +560,12 @@ internal async Task<List<Document>> GetRemainingHelperAsync(CancellationToken ca

while (!IsDone)
{
var previousScannedCount = scannedCount;
foreach (Document doc in await GetNextSetHelperAsync(cancellationToken).ConfigureAwait(false))
{
ret.Add(doc);
}
scannedCount += previousScannedCount;
}

return ret;
Expand All @@ -545,6 +574,8 @@ internal async Task<List<Document>> GetRemainingHelperAsync(CancellationToken ca

private int count;

private int scannedCount;

private SearchType SearchMethod { get; set; }

internal Table SourceTable { get; set; }
Expand Down Expand Up @@ -648,6 +679,8 @@ private int GetCount()

var scanResult = internalClient.Scan(scanReq);
count = Matches.Count + scanResult.Count.GetValueOrDefault();
scannedCount = scanResult.ScannedCount.GetValueOrDefault();

return count;
case SearchType.Query:
QueryRequest queryReq = new QueryRequest
Expand All @@ -673,6 +706,8 @@ private int GetCount()

var queryResult = internalClient.Query(queryReq);
count = Matches.Count + queryResult.Count.GetValueOrDefault();
scannedCount = queryResult.ScannedCount.GetValueOrDefault();

return count;
default:
throw new InvalidOperationException("Unknown Search Method");
Expand All @@ -687,6 +722,7 @@ private int GetCount()
internal void Reset()
{
count = -1;
scannedCount = 0;
IsDone = false;
NextKey = null;
Matches = new List<Document>();
Expand Down
1 change: 1 addition & 0 deletions sdk/src/Services/DynamoDBv2/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#else
#error Unknown platform constant - unable to set correct AssemblyDescription
#endif
[assembly: InternalsVisibleTo("AWSSDK.UnitTests.DynamoDBv2.NetFramework, PublicKey=0024000004800000940000000602000000240000525341310004000001000100db5f59f098d27276c7833875a6263a3cc74ab17ba9a9df0b52aedbe7252745db7274d5271fd79c1f08f668ecfa8eaab5626fa76adc811d3c8fc55859b0d09d3bc0a84eecd0ba891f2b8a2fc55141cdcc37c2053d53491e650a479967c3622762977900eddbf1252ed08a2413f00a28f3a0752a81203f03ccb7f684db373518b4")]

[assembly: AssemblyConfiguration("")]
[assembly: AssemblyProduct("Amazon Web Services SDK for .NET")]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<RunAnalyzersDuringBuild Condition="'$(RunAnalyzersDuringBuild)'==''">true</RunAnalyzersDuringBuild>
<TargetFramework>net472</TargetFramework>
Expand Down Expand Up @@ -34,11 +34,23 @@
<PropertyGroup Condition="'$(TargetFramework)' != 'net8.0'">
<LangVersion>9.0</LangVersion>
</PropertyGroup>
<Choose>
<When Condition=" '$(AWSKeyFile)' == '' ">
<PropertyGroup>
<AssemblyOriginatorKeyFile>..\..\..\..\awssdk.dll.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>
</When>
<Otherwise>
<PropertyGroup>
<AssemblyOriginatorKeyFile>$(AWSKeyFile)</AssemblyOriginatorKeyFile>
</PropertyGroup>
</Otherwise>
</Choose>
<ItemGroup>
<Compile Remove="**/obj/**"/>
<None Remove="**/obj/**" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="../../../../src/Core/AWSSDK.Core.NetFramework.csproj"/>
<ProjectReference Include="../../../Common/AWSSDK.CommonTest.csproj"/>
Expand Down
10 changes: 8 additions & 2 deletions sdk/test/Services/DynamoDBv2/UnitTests/Custom/MockingTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,18 @@ public async Task TestMockingTableClient_ScanAsync()
{
var mockClient = new Mock<IAmazonDynamoDB>();
mockClient.Setup(x => x.ScanAsync(It.IsAny<ScanRequest>(), It.IsAny<CancellationToken>()))
.ReturnsAsync(new ScanResponse { Items = new() });
.ReturnsAsync(new ScanResponse
{
Items = new(),
ScannedCount = 2
});

var table = new TableBuilder(mockClient.Object, "TestTable").AddHashKey("Id", DynamoDBEntryType.String).Build();

var search = table.Scan(new ScanFilter());
// This calls the low-level ScanAsync, which should be valid on the mocked client
await table.Scan(new ScanOperationConfig()).GetNextSetAsync();
await search.GetNextSetAsync();
Assert.AreEqual(2,search.ScannedCount);
}

[TestMethod]
Expand Down
145 changes: 145 additions & 0 deletions sdk/test/Services/DynamoDBv2/UnitTests/Custom/SearchTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
using System.Collections.Generic;
using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DocumentModel;
using Amazon.DynamoDBv2.Model;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Moq;

namespace AWSSDK_DotNet.UnitTests
{
[TestClass]
public class SearchTests
{
private readonly Table _mockTable;
private readonly Mock<IAmazonDynamoDB> _mockDynamoDBClient;
private readonly Search _search;

public SearchTests()
{
_mockDynamoDBClient = new Mock<IAmazonDynamoDB>();
_mockTable = new TableBuilder(_mockDynamoDBClient.Object, "TestTable")
.AddHashKey("Id", DynamoDBEntryType.String).Build();

// Initialize Search with mocked dependencies
_search = new Search
{
SourceTable = _mockTable,
TableName = "TestTable",
CollectResults = true,
Filter = new Filter()
};
}

[TestMethod]
[TestCategory("DynamoDBv2")]
public void Reset_ShouldResetSearchState()
{
// Arrange
_search.Matches.Add(new Document());

// Act
_search.Reset();

// Assert
Assert.AreEqual(0,_search.Matches.Count);
Assert.IsFalse(_search.IsDone);
Assert.IsNull(_search.NextKey);
Assert.IsTrue(_search.CollectResults);
}

[TestMethod]
[TestCategory("DynamoDBv2")]
public void GetNextSetHelper_ShouldReturnDocuments()
{
// Arrange
var mockDocument = new Document();
var mockScanResponse = new ScanResponse
{
Items = new List<Dictionary<string, AttributeValue>> { new Dictionary<string, AttributeValue>() },
LastEvaluatedKey = null,
ScannedCount = 10,
};

_mockDynamoDBClient
.Setup(client => client.Scan(It.IsAny<ScanRequest>()))
.Returns(mockScanResponse);

// Act
var result = _search.GetNextSetHelper();

// Assert
Assert.AreEqual(1,result.Count);
Assert.AreEqual(mockDocument, result[0]);
Assert.IsTrue(_search.IsDone);
Assert.AreEqual(10, _search.ScannedCount);
}

[TestMethod]
[TestCategory("DynamoDBv2")]
public void GetRemainingHelper_ShouldReturnAllDocuments()
{
// Arrange
var mockDocument = new Document();
var mockScanResponse = new ScanResponse
{
Items = new List<Dictionary<string, AttributeValue>> { new Dictionary<string, AttributeValue>() },
LastEvaluatedKey = new Dictionary<string, AttributeValue>()
{
{"test",new AttributeValue("test")}
},
ScannedCount = 10,
};

var mockLastScanResponse = new ScanResponse
{
Items = new List<Dictionary<string, AttributeValue>> { new Dictionary<string, AttributeValue>() },
LastEvaluatedKey = null,
ScannedCount = 20,
};

_mockDynamoDBClient
.Setup(client => client.Scan(It.Is<ScanRequest>(x=> x.ExclusiveStartKey==null)))
.Returns(mockScanResponse);

_mockDynamoDBClient
.Setup(client => client.Scan(It.Is<ScanRequest>(x=> x.ExclusiveStartKey != null && x.ExclusiveStartKey.Count==1)))
.Returns(mockLastScanResponse);


// Act
var result = _search.GetRemainingHelper();

// Assert
Assert.AreEqual(2, result.Count);
Assert.AreEqual(mockDocument, result[0]);
Assert.IsTrue(_search.IsDone);
Assert.AreEqual(30, _search.ScannedCount);
}

[TestMethod]
[TestCategory("DynamoDBv2")]
public void GetCount_ShouldReturnCorrectCount()
{
// Arrange// Arrange
var mockScanResponse = new ScanResponse
{
Items = new List<Dictionary<string, AttributeValue>> { new(), new() },
LastEvaluatedKey = null,
Count = 2,
ScannedCount = 10,
};

_mockDynamoDBClient
.Setup(client => client.Scan(It.IsAny<ScanRequest>()))
.Returns(mockScanResponse);
_search.Reset();
// Act
var count = _search.Count;

// Assert
Assert.AreEqual(2, count);
}


}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,21 @@
<GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
<GenerateAssemblyFileVersionAttribute>false</GenerateAssemblyFileVersionAttribute>
<GenerateAssemblyDescriptionAttribute>false</GenerateAssemblyDescriptionAttribute>

<SignAssembly>true</SignAssembly>
<NoWarn>CS1591</NoWarn>
</PropertyGroup>

<Choose>
<When Condition=" '$(AWSKeyFile)' == '' ">
<PropertyGroup>
<AssemblyOriginatorKeyFile>..\..\..\awssdk.dll.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>
</When>
<Otherwise>
<PropertyGroup>
<AssemblyOriginatorKeyFile>$(AWSKeyFile)</AssemblyOriginatorKeyFile>
</PropertyGroup>
</Otherwise>
</Choose>
<ItemGroup>
<Compile Remove="**\**" />
<Compile Include="EndpointsStandardLibraryTests.cs" />
Expand Down