mdbxmou 0.3.6 → 0.3.8

package/README.md

@@ -1,6 +1,6 @@
 # mdbxmou
 
-High-performance Node.js binding for libmdbx — a fast, lightweight, embedded key-value database.
+High-performance Node.js binding for [libmdbx](https://github.com/erthink/libmdbx) — a fast, lightweight, embedded key-value database.
 
 ## Features
 
@@ -24,29 +24,33 @@ CommonJS:
 ```javascript
 const { MDBX_Env, MDBX_Param } = require('mdbxmou');
 
-// Create environment
-const env = new MDBX_Env();
-await env.open({ 
-  path: './data',
-  keyFlag: MDBX_Param.keyFlag.string,    // Default key encoding (optional)
-  valueFlag: MDBX_Param.valueFlag.string // Default value encoding (optional)
-});
+async function main() {
+  // Create environment
+  const env = new MDBX_Env();
+  await env.open({ 
+    path: './data',
+    keyFlag: MDBX_Param.keyFlag.string,    // Default key encoding (optional)
+    valueFlag: MDBX_Param.valueFlag.string // Default value encoding (optional)
+  });
 
-// Write data
-const txn = env.startWrite();
-const dbi = txn.createMap(MDBX_Param.keyMode.ordinal);
-dbi.put(txn, 1, "hello");
-dbi.put(txn, 2, "world");
-txn.commit();
+  // Write data
+  const txn = env.startWrite();
+  const dbi = txn.createMap(MDBX_Param.keyMode.ordinal);
+  dbi.put(txn, 1, "hello");
+  dbi.put(txn, 2, "world");
+  txn.commit();
 
-// Read data
-const readTxn = env.startRead();
-const readDbi = readTxn.openMap(BigInt(MDBX_Param.keyMode.ordinal));
-const value = readDbi.get(readTxn, 1);
-console.log(value); // "hello"
-readTxn.commit();
+  // Read data
+  const readTxn = env.startRead();
+  const readDbi = readTxn.openMap(BigInt(MDBX_Param.keyMode.ordinal));
+  const value = readDbi.get(readTxn, 1);
+  console.log(value); // "hello"
+  readTxn.commit();
 
-await env.close();
+  await env.close();
+}
+
+main().catch(console.error);
 ```
 
 ESM:
@@ -628,6 +632,9 @@ async function asyncExample() {
   readTxn.commit();
   await env.close();
 }
+
+syncExample();
+asyncExample().catch(console.error);
 ```
 
 ### Key Type Behavior
@@ -670,6 +677,8 @@ function keyTypesExample() {
 
   env.closeSync();
 }
+
+keyTypesExample();
 ```
 
 ### Cursor Operations
@@ -723,6 +732,8 @@ function cursorExample() {
   readTxn.commit();
   env.closeSync();
 }
+
+cursorExample();
 ```
 
 ### Query API (Advanced Async)
@@ -742,7 +753,7 @@ async function queryExample() {
   // Async query with DBI object (not database name)
   const results = await env.query([
     {
-      dbi: dbi,
+      dbi,
       mode: MDBX_Param.queryMode.insertUnique,
       item: [
         { key: 1, value: JSON.stringify({ name: "Alice" }) },
@@ -750,7 +761,7 @@ async function queryExample() {
       ]
     },
     {
-      dbi: dbi,
+      dbi,
       mode: MDBX_Param.queryMode.get,
       item: [
         { key: 1 },
@@ -762,6 +773,8 @@ async function queryExample() {
   console.log('Query results:', JSON.stringify(results, null, 2));
   await env.close();
 }
+
+queryExample().catch(console.error);
 ```
 
 ### Async Keys API
@@ -788,7 +801,7 @@ async function keysExample() {
   console.log("All keys:", allKeys);
 
   // Get keys with DBI object parameter  
-  const allKeys2 = await env.keys({ dbi: dbi });
+  const allKeys2 = await env.keys({ dbi });
   console.log("All keys (object):", allKeys2);
 
   // Get keys from multiple DBIs
@@ -797,32 +810,54 @@ async function keysExample() {
 
   // Get limited keys from specific position
   const limitedKeys = await env.keys([
-    { dbi: dbi, limit: 3, from: 5 }
+    { dbi, limit: 3, from: 5 }
   ]);
   console.log("Limited keys:", limitedKeys);
 
   await env.close();
 }
+
+keysExample().catch(console.error);
 ```
 
 ## Error Handling
 
 ```javascript
-try {
-  const env = new MDBX_Env();
-  await env.open({ path: './data' });
-  
-  const txn = env.startWrite();
-  const dbi = txn.createMap(MDBX_Param.keyMode.ordinal);
-  
-  // This might throw if key already exists with MDBX_NOOVERWRITE
-  dbi.put(txn, 123, "value");
-  
-  txn.commit();
-} catch (error) {
-  console.error('Database error:', error.message);
-  if (txn) txn.abort();
+async function errorHandlingExample() {
+  let txn;
+  try {
+    const env = new MDBX_Env();
+    await env.open({ path: './data' });
+    
+    txn = env.startWrite();
+    const dbi = txn.createMap(MDBX_Param.keyMode.ordinal);
+    
+    // This might throw if key already exists with MDBX_NOOVERWRITE
+    dbi.put(txn, 123, "value");
+    
+    txn.commit();
+  } catch (error) {
+    console.error('Database error:', error.message);
+    if (txn) txn.abort();
+  }
 }
+
+errorHandlingExample().catch(console.error);
+```
+
+## Runnable README Tests
+
+The examples above have matching runnable tests in `test/`. You can execute them directly:
+
+```bash
+node test/readme-quick-start.js
+node test/readme-sync-example.js
+node test/readme-async-example.js
+node test/readme-key-types.js
+node test/readme-cursor-example.js
+node test/readme-query-example.js
+node test/readme-keys-example.js
+node test/readme-error-handling.js
 ```
 
 ## Configuration Options

package/deps/libmdbx/.clang-format-ignore

@@ -0,0 +1,8 @@
+mdbx.c
+mdbx.c++
+mdbx_chk.c
+mdbx_copy.c
+mdbx_drop.c
+mdbx_dump.c
+mdbx_load.c
+mdbx_stat.c

package/deps/libmdbx/.github/workflows/ci-android.yml

@@ -0,0 +1,38 @@
+name: ci-android
+
+env:
+  CI: GITHUB
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+on: [push]
+
+jobs:
+  ci-job:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ndk: [r26d, r27c]
+        target: [arm64-v8a, "armeabi-v7a with NEON", x86_64]
+        build-type: [Debug, Release]
+        os: [ubuntu-latest]
+        exclude:
+          - ndk: r26d
+            build-type: Debug
+    steps:
+    - uses: actions/checkout@v4
+    - uses: nttld/setup-ndk@v1
+      id: setup-ndk
+      with:
+        ndk-version: ${{ matrix.ndk }}
+        add-to-path: true
+    - name: ci-step
+      env:
+        ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}
+        CI_MAKE_TARGET: ""
+      shell: bash
+      run: |
+        . ci.sh "-DANDROID_ABI=${{ matrix.target }}|-DCMAKE_TOOLCHAIN_FILE:PATH=${{ steps.setup-ndk.outputs.ndk-path }}/build/cmake/android.toolchain.cmake|-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}"

package/deps/libmdbx/.github/workflows/ci-mingw.yml

@@ -0,0 +1,40 @@
+name: ci-mingw
+
+env:
+  CI: GITHUB
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+on: [push]
+
+jobs:
+  ci-job:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        build-type: [Debug, Release]
+        dll: [ON, OFF]
+        without_crt: [ON, OFF]
+        os: [windows-latest]
+        exclude:
+          - build-type: Debug
+            dll: OFF
+          - build-type: Release
+            without_crt: ON
+    steps:
+    - uses: actions/checkout@v4
+#    - name: Update mingw64
+#      run: choco upgrade mingw -y --no-progress
+    - name: ci-step
+      shell: bash
+      env:
+        CI_MAKE_TARGET: smoke
+      run: |
+        echo "initial-PATH=$PATH" && \
+        export "PATH=/c/mingw64/bin:/c/programdata/mingw64/mingw64/bin:$PATH" && \
+        export MDBX_BUILD_OPTIONS=$(if [ "${{ matrix.build-type }}" = 'Debug' ]; then echo '-DMDBX_FORCE_ASSERTIONS=1'; else echo '-DNDEBUG=1'; fi) && \
+        export MDBX_BUILD_CXX=$(if [ "${{ matrix.without_crt }}" = 'OFF' ]; then echo 'YES'; else echo 'NO'; fi) && \
+        . ci.sh "-G|MinGW Makefiles|-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}|-DMDBX_BUILD_SHARED_LIBRARY:BOOL=${{ matrix.dll }}|-DMDBX_WITHOUT_MSVC_CRT:BOOL=${{ matrix.without_crt }}"

package/deps/libmdbx/.github/workflows/ci-posix.yml

@@ -0,0 +1,34 @@
+name: ci-posix
+
+env:
+  CI: GITHUB
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+on: [push]
+
+jobs:
+  ci-job:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-14, macos-26]
+        build-type: [Debug, Release]
+#        alloy: [ON, OFF]
+        cxx: [ON, OFF]
+#        exclude:
+#          - os: macos-14
+#            cxx: OFF
+#            alloy: ON
+    steps:
+    - uses: actions/checkout@v4
+    - name: ci-step
+      shell: bash
+      run: |
+        export CI_MAKE_TARGET=$(if [ "$(uname)" = 'Linux' ]; then echo 'check'; elif [ "${{ matrix.build-type }}" != 'Debug' ]; then echo 'test'; else echo 'smoke'; fi) && \
+        export MDBX_BUILD_OPTIONS=$(if [ "${{ matrix.build-type }}" = 'Debug' ]; then echo '-DMDBX_FORCE_ASSERTIONS=1'; else echo '-DNDEBUG=1'; fi) && \
+        export MDBX_BUILD_CXX=$(if [ "${{ matrix.cxx }}" = 'ON' ]; then echo 'YES'; else echo 'NO'; fi) && \
+        . ci.sh "-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}|-DMDBX_BUILD_CXX:BOOL=${{ matrix.cxx }}"

package/deps/libmdbx/.github/workflows/ci-wincxx.yml

@@ -0,0 +1,45 @@
+name: ci-wincxx
+
+env:
+  CI: GITHUB
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+on: [push]
+
+jobs:
+  ci-job:
+    strategy:
+      fail-fast: false
+      matrix:
+        toolset: [v142, v143]
+        cxx: [11, 14, 17, 20]
+        target: [Win32, x64, ARM64]
+        build-type: [Debug, Release]
+        os: [windows-latest, windows-2022]
+        exclude:
+          - os: windows-latest
+            toolset: v142
+          - os: windows-latest
+            cxx: 11
+          - os: windows-2022
+            toolset: v143
+          - os: windows-2022
+            cxx: 20
+#          - target: x64
+#            build-type: Debug
+          - target: ARM64
+            toolset: v142
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: ci-step
+      env:
+        CI_MAKE_TARGET: ""
+        CXXSTD: "-std=gnu++${{ matrix.cxx }}"
+      shell: bash
+      run: |
+        . ci.sh "-A|${{ matrix.target }}|-T|${{ matrix.toolset }}|-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}|-DCMAKE_CXX_STANDARD=${{ matrix.cxx }}" \
+          "--config|${{ matrix.build-type }}" "--build-config|${{ matrix.build-type }}"

package/deps/libmdbx/.github/workflows/ci-windows.yml

@@ -0,0 +1,32 @@
+name: ci-windows
+
+env:
+  CI: GITHUB
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+on: [push]
+
+jobs:
+  ci-job:
+    strategy:
+      fail-fast: false
+      matrix:
+        toolset: [v143]
+        dll: [ON, OFF]
+        without_crt: [ON, OFF]
+        target: [x64, Win32]
+        build-type: [Debug, Release]
+        os: [windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: ci-step
+      env:
+        CI_MAKE_TARGET: ""
+      shell: bash
+      run: |
+        . ci.sh "-A|${{ matrix.target }}|-T|${{ matrix.toolset }}|-DCMAKE_BUILD_TYPE=${{ matrix.build-type }}|-DMDBX_BUILD_SHARED_LIBRARY:BOOL=${{ matrix.dll }}|-DMDBX_WITHOUT_MSVC_CRT:BOOL=${{ matrix.without_crt }}" \
+          "--config|${{ matrix.build-type }}" "--build-config|${{ matrix.build-type }}"