Adding overloads for non-nullable and no argument for null params

Author: CoreyKaylor

src/LightningDB.Tests/DatabaseTests.cs

@@ -203,7 +203,7 @@ public void can_get_database_flags()
         // Test default database (should have no special flags)
         using (var txn = env.BeginTransaction())
         {
-            using var db = txn.OpenDatabase(null, new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create });
+            using var db = txn.OpenDatabase(new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create });
 
             var flags = db.GetFlags(txn);
             flags.ShouldBe(DatabaseOpenFlags.None);

src/LightningDB.Tests/EnvironmentTests.cs

@@ -115,7 +115,7 @@ public void can_put_multiple_key_value_pairs_and_flush_successfully()
         env.Open();
 
         using var tx = env.BeginTransaction();
-        using var db = tx.OpenDatabase(null, new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create });
+        using var db = tx.OpenDatabase(new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create });
 
         for (int i = 0; i < 5; i++)
         {
@@ -250,7 +250,7 @@ public void can_copy_to_file_stream()
 
         // Add some data to the source environment
         using (var tx = sourceEnv.BeginTransaction())
-        using (var db = tx.OpenDatabase(null, new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create }))
+        using (var db = tx.OpenDatabase(new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create }))
         {
             for (int i = 0; i < 5; i++)
             {
@@ -286,7 +286,7 @@ public void can_copy_with_compaction_to_file_stream()
 
         // Add some data to the source environment and then delete half of it to create free space
         using (var tx = sourceEnv.BeginTransaction())
-        using (var db = tx.OpenDatabase(null, new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create }))
+        using (var db = tx.OpenDatabase(new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create }))
         {
             for (int i = 0; i < 10; i++)
             {
@@ -333,7 +333,7 @@ public void can_get_environment_file_stream()
 
         // Add some data to make sure the file has content
         using (var tx = env.BeginTransaction())
-        using (var db = tx.OpenDatabase(null, new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create }))
+        using (var db = tx.OpenDatabase(new DatabaseConfiguration { Flags = DatabaseOpenFlags.Create }))
         {
             tx.Put(db, "testkey", "testvalue");
             tx.Commit();

src/LightningDB.Tests/TestBase.cs

@@ -14,7 +14,7 @@ protected string TempPath(string seed = "")
       return path;
    }
    protected LightningEnvironment CreateEnvironment(string? path = null, EnvironmentConfiguration? config = null) =>
-      new(path ?? TempPath(), config);
+      config is null ? new(path ?? TempPath()) : new(path ?? TempPath(), config);
 
    public static void CleanupSession()
    {

src/LightningDB.Tests/TestHelperExtensions.cs

@@ -52,7 +52,7 @@ public static void RunCursorScenario(this LightningEnvironment env,
         DatabaseOpenFlags flags = DatabaseOpenFlags.Create, TransactionBeginFlags transactionFlags = TransactionBeginFlags.None)
     {
         using var tx = env.BeginTransaction(transactionFlags);
-        using var db = tx.OpenDatabase(configuration: new DatabaseConfiguration { Flags = flags });
+        using var db = tx.OpenDatabase(new DatabaseConfiguration { Flags = flags });
         using var cursor = tx.CreateCursor(db);
         scenario(tx, db, cursor);
     }
@@ -62,7 +62,7 @@ public static void RunTransactionScenario(this LightningEnvironment env,
         DatabaseOpenFlags flags = DatabaseOpenFlags.Create, TransactionBeginFlags transactionFlags = TransactionBeginFlags.None)
     {
         using var tx = env.BeginTransaction(transactionFlags);
-        using var db = tx.OpenDatabase(configuration: new DatabaseConfiguration { Flags = flags });
+        using var db = tx.OpenDatabase(new DatabaseConfiguration { Flags = flags });
         scenario(tx, db);
     }
 }

src/LightningDB/LightningEnvironment.cs

@@ -17,23 +17,37 @@ public sealed class LightningEnvironment : IDisposable
     internal nint _handle;
 
     /// <summary>
-    /// Creates a new instance of LightningEnvironment.
+    /// Creates a new instance of LightningEnvironment with default configuration.
     /// </summary>
     /// <param name="path">Directory for storing database files.</param>
-    /// <param name="configuration">Configuration for the environment. If null, default configuration is used.</param>
-    public LightningEnvironment(string path, EnvironmentConfiguration? configuration = null)
+    public LightningEnvironment(string path)
     {
         if (string.IsNullOrWhiteSpace(path))
             throw new ArgumentException("Invalid directory name");
 
-        var config = configuration ?? _config;
-
         mdb_env_create(out _handle).ThrowOnError();
-        config.Configure(this);
-        _config = config;
+        _config.Configure(this);
 
         Path = path;
+    }
 
+    /// <summary>
+    /// Creates a new instance of LightningEnvironment.
+    /// </summary>
+    /// <param name="path">Directory for storing database files.</param>
+    /// <param name="configuration">Configuration for the environment.</param>
+    public LightningEnvironment(string path, EnvironmentConfiguration configuration)
+    {
+        if (string.IsNullOrWhiteSpace(path))
+            throw new ArgumentException("Invalid directory name");
+        if (configuration == null)
+            throw new ArgumentNullException(nameof(configuration));
+
+        mdb_env_create(out _handle).ThrowOnError();
+        configuration.Configure(this);
+        _config = configuration;
+
+        Path = path;
     }
 
     /// <summary>
@@ -218,47 +232,52 @@ public void Open(EnvironmentOpenFlags openFlags = EnvironmentOpenFlags.None, Uni
     }
 
     /// <summary>
-    /// Create a transaction for use with the environment.
+    /// Create a top-level transaction for use with the environment.
     /// The transaction handle may be discarded using Abort() or Commit().
     /// Note:
     /// Transactions may not span threads; a transaction must only be used by a single thread. Also, a thread may only have a single transaction.
     /// Cursors may not span transactions; each cursor must be opened and closed within a single transaction.
     /// </summary>
-    /// <param name="parent">
-    /// If this parameter is non-null, the new transaction will be a nested transaction, with the transaction indicated by parent as its parent.
-    /// Transactions may be nested to any level.
-    /// A parent transaction may not issue any other operations besides BeginTransaction, Abort, or Commit while it has active child transactions.
-    /// </param>
     /// <param name="beginFlags">
     /// Special options for this transaction.
     /// </param>
     /// <returns>
     /// New LightningTransaction
     /// </returns>
-    public LightningTransaction BeginTransaction(LightningTransaction? parent = null, TransactionBeginFlags beginFlags = LightningTransaction.DefaultTransactionBeginFlags)
+    public LightningTransaction BeginTransaction(TransactionBeginFlags beginFlags = LightningTransaction.DefaultTransactionBeginFlags)
     {
-        if (!IsOpened)
-            throw new InvalidOperationException("Environment must be opened before starting a transaction");
-
-        return new LightningTransaction(this, parent, beginFlags);
+        return BeginTransactionImpl(null, beginFlags);
     }
 
     /// <summary>
-    /// Create a transaction for use with the environment.
+    /// Create a nested transaction for use with the environment.
     /// The transaction handle may be discarded using Abort() or Commit().
     /// Note:
     /// Transactions may not span threads; a transaction must only be used by a single thread. Also, a thread may only have a single transaction.
     /// Cursors may not span transactions; each cursor must be opened and closed within a single transaction.
     /// </summary>
+    /// <param name="parent">
+    /// The parent transaction. The new transaction will be a nested transaction.
+    /// Transactions may be nested to any level.
+    /// A parent transaction may not issue any other operations besides BeginTransaction, Abort, or Commit while it has active child transactions.
+    /// </param>
     /// <param name="beginFlags">
     /// Special options for this transaction.
     /// </param>
     /// <returns>
     /// New LightningTransaction
     /// </returns>
-    public LightningTransaction BeginTransaction(TransactionBeginFlags beginFlags)
+    public LightningTransaction BeginTransaction(LightningTransaction parent, TransactionBeginFlags beginFlags = LightningTransaction.DefaultTransactionBeginFlags)
+    {
+        return BeginTransactionImpl(parent, beginFlags);
+    }
+
+    private LightningTransaction BeginTransactionImpl(LightningTransaction? parent, TransactionBeginFlags beginFlags)
     {
-        return BeginTransaction(null, beginFlags);
+        if (!IsOpened)
+            throw new InvalidOperationException("Environment must be opened before starting a transaction");
+
+        return new LightningTransaction(this, parent, beginFlags);
     }
 
     /// <summary>

src/LightningDB/LightningTransaction.cs

@@ -69,15 +69,51 @@ public LightningTransaction BeginTransaction(TransactionBeginFlags beginFlags =
     }
 
     /// <summary>
-    /// Opens a database in context of this transaction.
+    /// Opens the default (unnamed) database in context of this transaction with default configuration.
+    /// </summary>
+    /// <param name="closeOnDispose">Close database handle on dispose</param>
+    /// <returns>Created database wrapper.</returns>
+    public LightningDatabase OpenDatabase(bool closeOnDispose = false)
+    {
+        return OpenDatabaseImpl(null, new DatabaseConfiguration(), closeOnDispose);
+    }
+
+    /// <summary>
+    /// Opens the default (unnamed) database in context of this transaction.
     /// </summary>
-    /// <param name="name">Database name (optional). If null then the default/unnamed database is used.</param>
     /// <param name="configuration">Database open options.</param>
     /// <param name="closeOnDispose">Close database handle on dispose</param>
     /// <returns>Created database wrapper.</returns>
-    public LightningDatabase OpenDatabase(string? name = null, DatabaseConfiguration? configuration = null, bool closeOnDispose = false)
+    public LightningDatabase OpenDatabase(DatabaseConfiguration configuration, bool closeOnDispose = false)
+    {
+        return OpenDatabaseImpl(null, configuration, closeOnDispose);
+    }
+
+    /// <summary>
+    /// Opens a named database in context of this transaction with default configuration.
+    /// </summary>
+    /// <param name="name">Database name.</param>
+    /// <param name="closeOnDispose">Close database handle on dispose</param>
+    /// <returns>Created database wrapper.</returns>
+    public LightningDatabase OpenDatabase(string name, bool closeOnDispose = false)
+    {
+        return OpenDatabaseImpl(name, new DatabaseConfiguration(), closeOnDispose);
+    }
+
+    /// <summary>
+    /// Opens a named database in context of this transaction.
+    /// </summary>
+    /// <param name="name">Database name.</param>
+    /// <param name="configuration">Database open options.</param>
+    /// <param name="closeOnDispose">Close database handle on dispose</param>
+    /// <returns>Created database wrapper.</returns>
+    public LightningDatabase OpenDatabase(string name, DatabaseConfiguration configuration, bool closeOnDispose = false)
+    {
+        return OpenDatabaseImpl(name, configuration, closeOnDispose);
+    }
+
+    private LightningDatabase OpenDatabaseImpl(string? name, DatabaseConfiguration configuration, bool closeOnDispose)
     {
-        configuration ??= new DatabaseConfiguration();
         var db = new LightningDatabase(name, this, configuration, closeOnDispose);
         return db;
     }