Add missing txn commit in DbiBuilder

lmdbjava · at055612 · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025 · Mar 6, 2025
commit ef0c852ad9a631ae0f194f4d63dce62e3d1b549f
diff --git a/src/main/java/org/lmdbjava/AbstractFlagSet.java b/src/main/java/org/lmdbjava/AbstractFlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.Collection;
@@ -62,7 +77,7 @@

  /**
   * @return True if this set is empty.
   */
  @Override
  public boolean isEmpty() {
    return flags.isEmpty();
@@ -136,7 +151,7 @@
      return false;
    }

    @Override
    public Iterator<T> iterator() {
      if (enumSet == null) {
        return initSet().iterator();
@@ -196,7 +211,7 @@
    }

    @Override
    public boolean isEmpty() {
      return true;
    }


diff --git a/src/main/java/org/lmdbjava/CopyFlagSet.java b/src/main/java/org/lmdbjava/CopyFlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.Collection;

diff --git a/src/main/java/org/lmdbjava/Dbi.java b/src/main/java/org/lmdbjava/Dbi.java
@@ -49,7 +49,7 @@
  */
 public final class Dbi<T> {
 
-  private final ComparatorCallback ccb;
+  private final ComparatorCallback callbackComparator;
   private boolean cleaned;
   // Used for CursorIterable KeyRange testing and/or native callbacks
   private final Comparator<T> comparator;
@@ -82,7 +82,7 @@ public final class Dbi<T> {
     if (nativeCb) {
       requireNonNull(comparator, "comparator cannot be null if nativeCb is set");
       // LMDB will call back to this comparator for insertion/iteration order
-      this.ccb =
+      this.callbackComparator =
           (keyA, keyB) -> {
             final T compKeyA  = proxy.out(proxy.allocate(), keyA);
             final T compKeyB = proxy.out(proxy.allocate(), keyB);
@@ -91,9 +91,9 @@ public final class Dbi<T> {
             proxy.deallocate(compKeyB);
             return result;
           };
-      LIB.mdb_set_compare(txn.pointer(), ptr, ccb);
+      LIB.mdb_set_compare(txn.pointer(), ptr, callbackComparator);
     } else {
-      ccb = null;
+      callbackComparator = null;
     }
   }
 
@@ -380,8 +380,7 @@ public boolean put(final Txn<T> txn, final T key, final T val, final PutFlags...
     final Pointer transientKey = txn.kv().keyIn(key);
     final Pointer transientVal = txn.kv().valIn(val);
     final int mask = mask(flags);
-    final int rc =
-        LIB.mdb_put(txn.pointer(), ptr, txn.kv().pointerKey(), txn.kv().pointerVal(), mask);
+    final int rc = LIB.mdb_put(txn.pointer(), ptr, txn.kv().pointerKey(), txn.kv().pointerVal(), mask);
     if (rc == MDB_KEYEXIST) {
       if (isSet(mask, MDB_NOOVERWRITE)) {
         txn.kv().valOut(); // marked as in,out in LMDB C docs

diff --git a/src/main/java/org/lmdbjava/DbiBuilder.java b/src/main/java/org/lmdbjava/DbiBuilder.java
@@ -355,20 +355,23 @@
     /**
      * Construct and open the {@link Dbi}.
      * <p>
-     * If a {@link Txn} was supplied to the builder, it should be committed upon return from
-     * this method.
+     * If a {@link Txn} was supplied to the builder, it is the callers responsibility to
+     * commit and close the txn upon return from this method, else the created DB won't be retained.
      * </p>
      *
      * @return A newly constructed and opened {@link Dbi}.
      */
     public Dbi<T> open() {
       final DbiBuilder<T> dbiBuilder = dbiBuilderStage2.dbiBuilder;
-      if (txn == null) {
+      if (txn != null) {
+        return open(txn, dbiBuilder);
+      } else {
         try (final Txn<T> txn = getTxn(dbiBuilder)) {
-          return open(txn, dbiBuilder);
+          final Dbi<T> dbi = open(txn, dbiBuilder);
+          // even RO Txns require a commit to retain Dbi in Env
+          txn.commit();
+          return dbi;
         }
-      } else {
-        return open(txn, dbiBuilder);
       }
     }
 

diff --git a/src/main/java/org/lmdbjava/DbiFlagSet.java b/src/main/java/org/lmdbjava/DbiFlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.Collection;

diff --git a/src/main/java/org/lmdbjava/EnvFlagSet.java b/src/main/java/org/lmdbjava/EnvFlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.Collection;

diff --git a/src/main/java/org/lmdbjava/FlagSet.java b/src/main/java/org/lmdbjava/FlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.Comparator;
@@ -12,7 +27,7 @@
 * @param <T>
 */
 public interface FlagSet<T extends MaskedFlag> extends Iterable<T> {

  int getMask();

  Set<T> getFlags();

diff --git a/src/main/java/org/lmdbjava/PutFlagSet.java b/src/main/java/org/lmdbjava/PutFlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.Collection;

diff --git a/src/main/java/org/lmdbjava/ReferenceUtil.java b/src/main/java/org/lmdbjava/ReferenceUtil.java
@@ -41,6 +41,7 @@ private ReferenceUtil() {}
    */
   public static void reachabilityFence0(final Object ref) {
     if (ref != null) {
+      //noinspection EmptySynchronizedStatement
       synchronized (ref) {
         // Empty synchronized is ok: https://stackoverflow.com/a/31933260/1151521
       }

diff --git a/src/main/java/org/lmdbjava/Txn.java b/src/main/java/org/lmdbjava/Txn.java
@@ -42,15 +42,16 @@ public final class Txn<T> implements AutoCloseable {
   private final Pointer ptr;
   private final boolean readOnly;
   private final Env<T> env;
+  private final TxnFlagSet flags;
   private State state;
 
   Txn(final Env<T> env, final Txn<T> parent, final BufferProxy<T> proxy, final TxnFlagSet flags) {
-    final TxnFlagSet flagSet = flags != null
+    this.flags = flags != null
         ? flags
         : TxnFlagSet.EMPTY;
     this.proxy = proxy;
     this.keyVal = proxy.keyVal();
-    this.readOnly = flagSet.isSet(MDB_RDONLY_TXN);
+    this.readOnly = this.flags.isSet(MDB_RDONLY_TXN);
     if (env.isReadOnly() && !this.readOnly) {
       throw new EnvIsReadOnly();
     }
@@ -61,7 +62,7 @@ public final class Txn<T> implements AutoCloseable {
     }
     final Pointer txnPtr = allocateDirect(RUNTIME, ADDRESS);
     final Pointer txnParentPtr = parent == null ? null : parent.ptr;
-    checkRc(LIB.mdb_txn_begin(env.pointer(), txnParentPtr, flagSet.getMask(), txnPtr));
+    checkRc(LIB.mdb_txn_begin(env.pointer(), txnParentPtr, this.flags.getMask(), txnPtr));
     ptr = txnPtr.getPointer(0);
 
     state = READY;

diff --git a/src/main/java/org/lmdbjava/TxnFlagSet.java b/src/main/java/org/lmdbjava/TxnFlagSet.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import java.util.EnumSet;

diff --git a/src/test/java/org/lmdbjava/CopyFlagSetTest.java b/src/test/java/org/lmdbjava/CopyFlagSetTest.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import static org.hamcrest.CoreMatchers.is;

diff --git a/src/test/java/org/lmdbjava/DbiBuilderTest.java b/src/test/java/org/lmdbjava/DbiBuilderTest.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.lmdbjava;
+
+import static com.jakewharton.byteunits.BinaryByteUnit.MEBIBYTES;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.lmdbjava.Env.create;
+import static org.lmdbjava.EnvFlags.MDB_NOSUBDIR;
+import static org.lmdbjava.TestUtils.bb;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.nio.charset.StandardCharsets;
+import org.hamcrest.Matchers;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+
+public class DbiBuilderTest {
+
+  @Rule
+  public final TemporaryFolder tmp = new TemporaryFolder();
+  private Env<ByteBuffer> env;
+
+  @After
+  public void after() {
+    env.close();
+  }
+
+  @Before
+  public void before() throws IOException {
+    System.out.println("before");
+    final File path = tmp.newFile();
+    env = create()
+        .setMapSize(MEBIBYTES.toBytes(64))
+        .setMaxReaders(2)
+        .setMaxDbs(2)
+        .open(path, MDB_NOSUBDIR);
+  }
+
+  @Test
+  public void unnamed() {
+    final Dbi<ByteBuffer> dbi = env.buildDbi()
+        .withoutDbName()
+        .withDefaultComparator()
+        .withDbiFlags(DbiFlags.MDB_CREATE)
+        .open();
+
+    assertThat(env.getDbiNames().size(), Matchers.is(0));
+
+    assertPutAndGet(dbi);
+  }
+
+
+  @Test
+  public void named() {
+    final Dbi<ByteBuffer> dbi = env.buildDbi()
+        .withDbName("foo")
+        .withDefaultComparator()
+        .withDbiFlags(DbiFlags.MDB_CREATE)
+        .open();
+
+    assertPutAndGet(dbi);
+
+    assertThat(env.getDbiNames().size(), Matchers.is(1));
+    assertThat(new String(env.getDbiNames().get(0), StandardCharsets.UTF_8), Matchers.is("foo"));
+  }
+
+  private void assertPutAndGet(Dbi<ByteBuffer> dbi) {
+    try (Txn<ByteBuffer> writeTxn = env.txnWrite()) {
+      dbi.put(writeTxn, bb(123), bb(123_000));
+      writeTxn.commit();
+    }
+
+    try (Txn<ByteBuffer> readTxn = env.txnRead()) {
+      final ByteBuffer byteBuffer = dbi.get(readTxn, bb(123));
+      final int val = byteBuffer.getInt();
+      assertThat(val, Matchers.is(123_000));
+    }
+  }
+}
diff --git a/src/test/java/org/lmdbjava/DbiFlagSetTest.java b/src/test/java/org/lmdbjava/DbiFlagSetTest.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import static org.hamcrest.CoreMatchers.is;

diff --git a/src/test/java/org/lmdbjava/EnvFlagSetTest.java b/src/test/java/org/lmdbjava/EnvFlagSetTest.java
@@ -1,3 +1,18 @@
+/*
+ * Copyright © 2016-2025 The LmdbJava Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.lmdbjava;
 
 import static org.hamcrest.CoreMatchers.is;