Allowed keys to be read from index

Author: TechLiam

Examples/IntegrationTestApp/Program.cs

@@ -119,7 +119,18 @@ private static async Task Main()
                     logger.LogInformation($"Year of birth: {data.YearOfBirth}");
                     logger.LogInformation($"Phone number: {data.PhoneNumber}");
                 }
-
+                
+                var indexKeys = dataManager.ReadIndexKeys<TestIndexData, string>(x => x.PhoneNumber);
+                logger.LogInformation("Read keys from index");
+                await foreach (var indexKey in indexKeys)
+                {
+                    logger.LogInformation($"Key: {indexKey.Value}");
+                    foreach (var id in indexKey.Ids)
+                    {
+                        logger.LogInformation($"Id: {id}");
+                    }
+                }
+                
                 write = await dataManager.Write(new TestUniqueIndexData
                 {
                     Id = 2,

Examples/IntegrationTestApp/TestNestedData.cs

@@ -1,8 +1,10 @@
+using System.Diagnostics.CodeAnalysis;
 using MessagePack;
 using PackDB.Core.Data;
 
 namespace IntegrationTestApp
 {
+    [ExcludeFromCodeCoverage]
     public class TestNestedData : DataEntity
     {
         [Key(2)]

Examples/IntegrationTestApp/TestWithNestedData.cs

@@ -1,9 +1,11 @@
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using MessagePack;
 using PackDB.Core.Data;
 
 namespace IntegrationTestApp
 {
+    [ExcludeFromCodeCoverage]
     public class TestWithNestedData : DataEntity
     {
         [Key(2)]

PackDB.FileSystem.Tests/IndexWorkerTester.cs

@@ -233,7 +233,43 @@ public async Task GetIdsFromIndexWhenReadDataFromStreamReturnsAnIndexWithTheKeyA
             Assert.AreEqual(ExpectedIds.Count(), result.Count());
             for (var i = 0; i < ExpectedIds.Count(); i++) Assert.IsTrue(result.Contains(ExpectedIds[i]));
         }
+        
+        [Test(Author = "PackDB Creator")]
+        public async Task GetKeysFromIndexWhenReadDataFromStreamReturnsAnEmptyIndex()
+        {
+            MockFileStreamer
+                .Setup(x => x.ReadDataFromStream<Index<string>>("Data\\IndexableData\\IndexValue1.index"))
+                .ReturnsAsync(new Index<string>());
+            var data = FileIndexWorker.GetKeysFromIndex<IndexableData, string>("IndexValue1");
+            var result = new List<IndexKey<string>>();
+            await foreach (var d in data) result.Add(d);
+            Assert.IsEmpty(result);
+        }
+
+        [Test(Author = "PackDB Creator")]
+        public async Task GetKeysFromIndexWhenReadDataFromStreamReturnsAnIndexWithNoKeys()
+        {
+            MockFileStreamer
+                .Setup(x => x.ReadDataFromStream<Index<string>>("Data\\IndexableData\\IndexValue1.index"))
+                .ReturnsAsync(new Index<string>
+                {
+                    Keys = new List<IndexKey<string>>()
+                });
+            var data = FileIndexWorker.GetKeysFromIndex<IndexableData, string>("IndexValue1");
+            var result = new List<IndexKey<string>>();
+            await foreach (var d in data) result.Add(d);
+            Assert.IsEmpty(result);
+        }
 
+        [Test(Author = "PackDB Creator")]
+        public async Task GetKeysFromIndexWhenReadDataFromStreamReturnsAnIndexWithTheKeyAndIds()
+        {
+            var data = FileIndexWorker.GetKeysFromIndex<IndexableData, string>("IndexValue1");
+            var result = new List<IndexKey<string>>();
+            await foreach (var d in data) result.Add(d);
+            Assert.AreEqual(1, result.Count(x => x.Value == IndexKey));
+        }
+        
         [Test(Author = "PackDB Creator", ExpectedResult = true)]
         public async Task<bool> IndexDataTypeWithNoIndexedProperties()
         {

PackDB.FileSystem/IndexWorker/FileIndexWorker.cs

@@ -87,6 +87,27 @@ public async IAsyncEnumerable<int> GetIdsFromIndex<TDataType, TKeyType>(string i
             }
         }
 
+        public async IAsyncEnumerable<IndexKey<TKeyType>> GetKeysFromIndex<TDataType, TKeyType>(string indexName) where TDataType : DataEntity
+        {
+            using (_logger.BeginScope("{Operation} is {Action} {IndexName} for {DataType}}",
+                nameof(FileIndexWorker), "getting keys from index", indexName, typeof(TDataType).Name))
+            {
+                var index = await FileStreamer.ReadDataFromStream<Index<TKeyType>>(GetFileName<TDataType>(indexName));
+                var keys = index.Keys;
+                if (keys == null)
+                {
+                    _logger.LogWarning("The index doesn't have the keys");
+                    yield break;
+                }
+
+                foreach (var key in keys)
+                {
+                    _logger.LogInformation("Returning {KeyValue}", key.Value, key);
+                    yield return key;
+                }
+            }
+        }
+
         public async Task<bool> Index<TDataType>(TDataType data) where TDataType : DataEntity
         {
             using (_logger.BeginScope("{Operation} is {Action} for {DataType}", nameof(FileIndexWorker), "indexing",

PackDB.FileSystem/PackDB.FileSystem.csproj

@@ -22,6 +22,7 @@
 0.2.0 - Beta release
 0.3.0 - Fixed issue with getting next id when no data exists for that type
 0.4.0 - Handled unique indexes
+0.5.0 - Allowed keys to be read from index
         </PackageReleaseNotes>
         <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
         <NeutralLanguage>en-GB</NeutralLanguage>
@@ -38,7 +39,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="PackDB.Core" Version="0.6.0" />
+      <PackageReference Include="PackDB.Core" Version="0.7.0" />
     </ItemGroup>
 
     <ItemGroup>