Fixes and additions for 2dot2 (#28)

Co-authored-by: Stephen Hewitt <stephenh@sembit.com>

Author: a-random-steve

src/DataStax.AstraDB.DataApi/Admin/AstraDatabasesAdmin.cs

@@ -732,6 +732,71 @@ internal async Task<DatabaseInfo> GetDatabaseInfoAsync(Guid dbGuid, CommandOptio
         return response;
     }
 
+    /// <summary>
+    /// Synchronous version of <see cref="FindAvailableRegionsAsync()"/>
+    /// </summary>
+    /// <returns></returns>
+    public List<RegionInfo> FindAvailableRegions()
+    {
+        return FindAvailableRegions(new FindAvailableRegionsCommandOptions());
+    }
+
+    /// <summary>
+    /// Synchronous version of <see cref="FindAvailableRegionsAsync(FindAvailableRegionsCommandOptions)"/>
+    /// </summary>
+    /// <returns></returns>
+    public List<RegionInfo> FindAvailableRegions(FindAvailableRegionsCommandOptions options)
+    {
+        return FindAvailableRegionsAsync(options, true).ResultSync();
+    }
+
+    /// <summary>
+    /// Gets a list of available regions for database creation.
+    /// </summary>
+    /// <returns></returns>
+    public Task<List<RegionInfo>> FindAvailableRegionsAsync()
+    {
+        return FindAvailableRegionsAsync(new FindAvailableRegionsCommandOptions());
+    }
+
+    /// <summary>
+    /// Gets a list of available regions for database creation.
+    /// </summary>
+    /// <param name="options"></param>
+    /// <returns></returns>
+    public Task<List<RegionInfo>> FindAvailableRegionsAsync(FindAvailableRegionsCommandOptions options)
+    {
+        return FindAvailableRegionsAsync(options, false);
+    }
+
+    internal async Task<List<RegionInfo>> FindAvailableRegionsAsync(FindAvailableRegionsCommandOptions options, bool runSynchronously)
+    {
+        Dictionary<string, string> parms = new Dictionary<string, string>();
+        string regionType = "";
+        switch (options.RegionType)
+        {
+            case RegionTypeFilter.All:
+                regionType = "all";
+                break;
+            case RegionTypeFilter.Serverless:
+                regionType = "";
+                break;
+            case RegionTypeFilter.Vector:
+                regionType = "vector";
+                break;
+        }
+        parms.Add("region-type", regionType);
+        parms.Add("filter-by-org", options.OnlyOrgEnabledRegions ? "enabled" : "disabled");
+        var command = CreateCommand()
+            .AddUrlPath("regions/serverless")
+            .WithTimeoutManager(new DatabaseAdminTimeoutManager())
+            .AddQueryParameters(parms)
+            .AddCommandOptions(options);
+
+        var response = await command.RunAsyncRaw<List<RegionInfo>>(HttpMethod.Get, runSynchronously);
+        return response;
+    }
+
     private DatabaseAdminAstra GetDatabaseAdmin(DatabaseInfo dbInfo)
     {
         var apiEndpoint = $"https://{dbInfo.Id}-{dbInfo.Region}.apps.astra.datastax.com";

src/DataStax.AstraDB.DataApi/Admin/DatabaseAdminAstra.cs

@@ -46,10 +46,14 @@ public class DatabaseAdminAstra : IDatabaseAdmin
         internal DatabaseAdminAstra(Database database, DataApiClient client, CommandOptions adminOptions)
         {
             Guard.NotNull(client, nameof(client));
+            if (database.DatabaseId == null)
+            {
+                throw new ArgumentException("Database must have a valid DatabaseId to use DatabaseAdminAstra", nameof(database));
+            }
             _client = client;
             _adminOptions = adminOptions;
             _database = database;
-            _id = _database.DatabaseId;
+            _id = _database.DatabaseId.Value;
         }
 
         /// <summary>
@@ -575,6 +579,97 @@ internal async Task<FindEmbeddingProvidersResult> FindEmbeddingProvidersAsync(Co
             return response.Result;
         }
 
+        /// <summary>
+        /// Finds and returns available reranking providers for the current database.
+        /// </summary>
+        /// <returns>A <see cref="FindRerankingProvidersResult"/> containing the discovered providers.</returns>
+        /// <example>
+        /// <code>
+        /// var providers = admin.FindRerankingProviders();
+        /// </code>
+        /// </example>
+        public FindRerankingProvidersResult FindRerankingProviders()
+        {
+            return FindRerankingProvidersAsync(null, true).ResultSync();
+        }
+
+        /// <summary>
+        /// Asynchronously finds and returns available reranking providers for the current database.
+        /// </summary>
+        /// <returns>
+        /// A task that resolves to a <see cref="FindRerankingProvidersResult"/> containing the discovered providers.
+        /// </returns>
+        /// <example>
+        /// <code>
+        /// var providers = await admin.FindRerankingProvidersAsync();
+        /// </code>
+        /// </example>
+        public Task<FindRerankingProvidersResult> FindRerankingProvidersAsync()
+        {
+            return FindRerankingProvidersAsync(null, false);
+        }
+
+        /// <summary>
+        /// Finds and returns available reranking providers for the current database using the specified command options.
+        /// </summary>
+        /// <param name="options">Optional settings that influence request execution.</param>
+        /// <returns>A <see cref="FindRerankingProvidersResult"/> containing the discovered providers.</returns>
+        /// <example>
+        /// <code>
+        /// var providers = admin.FindRerankingProviders(options);
+        /// </code>
+        /// </example>
+        public FindRerankingProvidersResult FindRerankingProviders(FindRerankingProvidersCommandOptions options)
+        {
+            return FindRerankingProvidersAsync(options, true).ResultSync();
+        }
+
+        /// <summary>
+        /// Asynchronously finds and returns available reranking providers for the current database
+        /// using the specified command options.
+        /// </summary>
+        /// <param name="options">Optional settings that influence request execution.</param>
+        /// <returns>
+        /// A task that resolves to a <see cref="FindRerankingProvidersResult"/> containing the discovered providers.
+        /// </returns>
+        /// <example>
+        /// <code>
+        /// var providers = await admin.FindRerankingProvidersAsync(options);
+        /// </code>
+        /// </example>
+        public Task<FindRerankingProvidersResult> FindRerankingProvidersAsync(FindRerankingProvidersCommandOptions options)
+        {
+            return FindRerankingProvidersAsync(options, false);
+        }
+
+        internal async Task<FindRerankingProvidersResult> FindRerankingProvidersAsync(FindRerankingProvidersCommandOptions options, bool runSynchronously)
+        {
+            if (options == null)
+            {
+                options = new FindRerankingProvidersCommandOptions();
+            }
+            options.DeserializeToObjectDictionary = true;
+            var command = CreateCommandEmbedding()
+               .AddCommandOptions(options)
+               .WithTimeoutManager(new DatabaseAdminTimeoutManager())
+               .WithPayload(new
+               {
+                   findRerankingProviders = new
+                   {
+                       options = new
+                       {
+                           filterModelStatus = options.StatusString
+                       }
+                   }
+               });
+
+            var response = await command
+                .RunAsyncReturnStatus<FindRerankingProvidersResult>(runSynchronously)
+                .ConfigureAwait(false);
+
+            return response.Result;
+        }
+
         private Command CreateCommandAdmin()
         {
             return new Command(_database.Client, _optionsTree, new AdminCommandUrlBuilder());
@@ -584,6 +679,5 @@ private Command CreateCommandEmbedding()
         {
             return new Command(_database.Client, _optionsTree, new EmbeddingCommandUrlBuilder(_database));
         }
-
     }
 }

src/DataStax.AstraDB.DataApi/Admin/DatabaseAdminOther.cs

@@ -25,7 +25,6 @@ namespace DataStax.AstraDB.DataApi.Admin
 {
     public class DatabaseAdminOther : IDatabaseAdmin
     {
-        private readonly Guid _id;
         private readonly Database _database;
         private readonly CommandOptions _adminOptions;
         private readonly DataApiClient _client;
@@ -37,16 +36,17 @@ internal DatabaseAdminOther(Database database, DataApiClient client, CommandOpti
             _client = client;
             _adminOptions = adminOptions;
             _database = database;
-            _id = _database.DatabaseId;
-        }
-
-        public DatabaseAdminOther(Guid id)
-        {
-            _id = id;
         }
 
         public IEnumerable<string> ListKeyspaces()
         {
+            /*
+            const resp = await this.#httpClient.executeCommand({ findKeyspaces: {} }, {
+      timeoutManager: this.#httpClient.tm.single('keyspaceAdminTimeoutMs', options),
+      methodName: 'dbAdmin.listKeyspaces',
+      keyspace: null,
+    });
+            */
             throw new NotImplementedException();
         }
 
@@ -184,5 +184,11 @@ public Task<bool> DoesKeyspaceExistAsync(string keyspace)
         {
             throw new NotImplementedException();
         }
+
+        public FindRerankingProvidersResult FindRerankingProviders()
+        {
+            throw new NotImplementedException();
+        }
+
     }
 }

src/DataStax.AstraDB.DataApi/Admin/IDatabaseAdmin.cs

@@ -26,6 +26,7 @@ public interface IDatabaseAdmin
     IEnumerable<string> ListKeyspaces();
     Task<IEnumerable<string>> ListKeyspacesAsync();
     FindEmbeddingProvidersResult FindEmbeddingProviders();
+    FindRerankingProvidersResult FindRerankingProviders();
     Database GetDatabase();
     void CreateKeyspace(string keyspace);
     void CreateKeyspace(string keyspace, CommandOptions options);

src/DataStax.AstraDB.DataApi/Admin/ListDatabaseOptions.cs

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-using DataStax.AstraDB.DataApi.Core;
 using System.Text.Json.Serialization;
 
 namespace DataStax.AstraDB.DataApi.Admin;

src/DataStax.AstraDB.DataApi/Core/ApiError.cs

@@ -18,29 +18,50 @@
 
 namespace DataStax.AstraDB.DataApi.Core;
 
-internal class ApiError
+/// <summary>
+/// Represents an error returned by the API.
+/// </summary>
+public class ApiError
 {
+    /// <summary>
+    /// The error message.
+    /// </summary>
     [JsonPropertyName("message")]
     public string Message { get; set; }
 
     [JsonPropertyName("code")]
-    public string Code { get; set; }
+    [JsonInclude]
+    internal string Code { get; set; }
 
+    /// <summary>
+    /// The error code.
+    /// </summary>
     [JsonPropertyName("errorCode")]
     public string ErrorCode { get; set; }
 
     [JsonPropertyName("exceptionClass")]
-    public string ExceptionClass { get; set; }
+    [JsonInclude]
+    internal string ExceptionClass { get; set; }
 
     [JsonPropertyName("family")]
-    public string Family { get; set; }
+    [JsonInclude]
+    internal string Family { get; set; }
 
+    /// <summary>
+    /// The scope of the error.
+    /// </summary>
     [JsonPropertyName("scope")]
     public string Scope { get; set; }
 
+    /// <summary>
+    /// The title of the error.
+    /// </summary>
     [JsonPropertyName("title")]
     public string Title { get; set; }
 
+    /// <summary>
+    /// The unique identifier for the error instance.
+    /// </summary>
     [JsonPropertyName("id")]
     public string Id { get; set; }
 }

src/DataStax.AstraDB.DataApi/Core/Builders.cs

@@ -30,7 +30,7 @@ public class Builders
     /// <example>
     /// <code>
     /// var index = Builders.TableIndex.Text();
-    /// table.CreateTextIndex("index_name", r => r.SomeTextProperty, index);
+    /// table.CreateIndex("index_name", r => r.SomeTextProperty, index);
     /// </code>
     /// </example>
     /// </summary>
@@ -93,15 +93,24 @@ public class Builders<T>
     /// </code>
     /// </example>
     public static UpdateBuilder<T> Update => new();
-
     /// <summary>
     /// A builder for creating table indexes
     /// <example>
     /// <code>
     /// var index = Builders.TableIndex.Text();
-    /// table.CreateTextIndex("index_name", r => r.SomeTextProperty, index);
+    /// table.CreateIndex("index_name", r => r.SomeTextProperty, index);
     /// </code>
     /// </example>
     /// </summary>
     public static TableIndexBuilder TableIndex => new();
+    /// <summary>
+    /// A builder for creating sort definitions for tables
+    /// </summary>
+    /// <example>
+    /// <code>
+    /// var sort = Builders&lt;DocumentType&gt;.TableSort;
+    /// sort = sort.Ascending(x => x.Name);
+    /// </code>
+    /// </example>
+    public static TableFilterBuilder<T> TableFilter => new();
 }

src/DataStax.AstraDB.DataApi/Core/CommandOptions.cs

@@ -42,6 +42,7 @@ public class CommandOptions
     internal JsonConverter OutputConverter { get; set; }
     internal bool? SerializeGuidAsDollarUuid { get; set; }
     internal bool? SerializeDateAsDollarDate { get; set; }
+    internal bool? DeserializeToObjectDictionary { get; set; } = false;
 
     /// <summary>
     /// The token to use for authentication
@@ -143,6 +144,7 @@ internal static CommandOptions Merge(params CommandOptions[] arr)
             IncludeKeyspaceInUrl = FirstNonNull(x => x.IncludeKeyspaceInUrl) ?? Defaults().IncludeKeyspaceInUrl,
             SerializeGuidAsDollarUuid = FirstNonNull(x => x.SerializeGuidAsDollarUuid) ?? Defaults().SerializeGuidAsDollarUuid,
             SerializeDateAsDollarDate = FirstNonNull(x => x.SerializeDateAsDollarDate) ?? Defaults().SerializeDateAsDollarDate,
+            DeserializeToObjectDictionary = FirstNonNull(x => x.DeserializeToObjectDictionary) ?? Defaults().DeserializeToObjectDictionary,
             BulkOperationCancellationToken = list.Select(o => o.BulkOperationCancellationToken).Merge()
         };
         return options;