zlmdb 25.10.1__cp314-cp314-manylinux_2_34_x86_64.whl

zlmdb/_schema.py

@@ -0,0 +1,137 @@
+###############################################################################
+#
+# The MIT License (MIT)
+#
+# Copyright (c) typedef int GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+###############################################################################
+
+from zlmdb._pmap import PersistentMap
+
+
+class Slot(object):
+    """
+    LMDB database slot. A slot is defined just by the convention of using
+    the first 2 bytes of keys in a LMDB database as the "slot index".
+
+    The 2 bytes are interpreted as an uint16 in big endian byte order.
+    """
+
+    def __init__(self, slot, name, pmap):
+        """
+
+        :param slot:
+        :param name:
+        :param pmap:
+        """
+        self.slot = slot
+        self.name = name
+        self.pmap = pmap
+
+
+class Schema(object):
+    """
+    ZLMDB database schema definition.
+    """
+
+    SLOT_DATA_EMPTY = 0
+    """
+    Database slot is empty (unused, not necessarily zero'ed, but uninitialized).
+    """
+
+    SLOT_DATA_METADATA = 1
+    """
+    FIXME.
+    """
+
+    SLOT_DATA_TYPE = 2
+    """
+    FIXME.
+    """
+
+    SLOT_DATA_SEQUENCE = 3
+    """
+    FIXME.
+    """
+
+    SLOT_DATA_TABLE = 4
+    """
+    Database slot contains a persistent map, for example a map of type OID to Pickle.
+    """
+
+    SLOT_DATA_INDEX = 5
+    """
+    FIXME.
+    """
+
+    SLOT_DATA_REPLICATION = 6
+    """
+    FIXME.
+    """
+
+    SLOT_DATA_MATERIALIZATION = 7
+    """
+    FIXME.
+    """
+
+    def __init__(self):
+        self._index_to_slot = {}
+        self._name_to_slot = {}
+
+    def slot(
+        self,
+        slot_index,
+        marshal=None,
+        unmarshal=None,
+        build=None,
+        cast=None,
+        compress=False,
+    ):
+        """
+        Decorator for use on classes derived from zlmdb.PersistentMap. The decorator define slots
+        in a LMDB database schema based on persistent maps, and slot configuration.
+
+        :param slot_index:
+        :param marshal:
+        :param unmarshal:
+        :param build:
+        :param cast:
+        :param compress:
+        :return:
+        """
+
+        def decorate(o):
+            assert isinstance(o, PersistentMap)
+            name = o.__class__.__name__
+            assert slot_index not in self._index_to_slot
+            assert name not in self._name_to_slot
+            o._zlmdb_slot = slot_index
+            o._zlmdb_marshal = marshal
+            o._zlmdb_unmarshal = unmarshal
+            o._zlmdb_build = build
+            o._zlmdb_cast = cast
+            o._zlmdb_compress = compress
+            _slot = Slot(slot_index, name, o)
+            self._index_to_slot[slot_index] = _slot
+            self._name_to_slot[name] = _slot
+            return o
+
+        return decorate

zlmdb/_transaction.py

@@ -0,0 +1,181 @@
+###############################################################################
+#
+# The MIT License (MIT)
+#
+# Copyright (c) typedef int GmbH
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+###############################################################################
+"""Transactions"""
+
+import struct
+import zlmdb.lmdb as lmdb
+from typing import Optional
+
+from txaio import time_ns as walltime
+
+
+class TransactionStats(object):
+    """
+    Value class for holding transaction statistics.
+    """
+
+    def __init__(self):
+        self.puts = 0
+        self.dels = 0
+        self._started = walltime()
+
+    @property
+    def started(self):
+        """
+
+        :return: start time in ns since epoch
+        """
+        return self._started
+
+    @property
+    def duration(self):
+        """
+
+        :return: duration in ns
+        """
+        if self._started:
+            return walltime() - self._started
+        else:
+            return 0
+
+    def reset(self):
+        """
+
+        :return:
+        """
+        self.puts = 0
+        self.dels = 0
+        self._started = walltime()
+
+
+class Transaction(object):
+    """
+    Transactions in zLMDB are always run under an instance of this class.
+    """
+
+    PUT = 1
+    DEL = 2
+
+    def __init__(self, db, write=False, buffers=False, stats=None):
+        """
+
+        :param db:
+        :type db: zlmdb.Database
+
+        :param write:
+        :type write: bool
+
+        :param stats:
+        :type stats: TransactionStats
+        """
+        self._db = db
+        self._write = write
+        self._buffers = buffers
+        self._stats = stats
+        self._txn: Optional[lmdb.Transaction] = None
+        self._log = None
+
+    def __enter__(self):
+        assert self._txn is None
+
+        self._txn = lmdb.Transaction(
+            self._db._env, write=self._write, buffers=self._buffers
+        )
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        assert self._txn is not None
+
+        # https://docs.python.org/3/reference/datamodel.html#object.__exit__
+        # If the context was exited without an exception, all three arguments will be None.
+        if exc_type is None:
+            if self._log:
+                cnt = 0
+                for op, key in self._log:
+                    _key = struct.pack(">H", 0)
+                    _data = struct.pack(">H", op) + key
+                    self._txn.put(_key, _data)
+                    cnt += 1
+            self._txn.commit()
+        else:
+            self._txn.abort()
+
+        self._txn = None
+
+    def id(self):
+        """
+
+        :return:
+        """
+        assert self._txn is not None
+
+        return self._txn.id()
+
+    def get(self, key):
+        """
+
+        :param key:
+        :return:
+        """
+        assert self._txn is not None
+
+        return self._txn.get(key)
+
+    def put(self, key, data, overwrite=True):
+        """
+
+        :param key:
+        :param data:
+        :param overwrite:
+        :return:
+        """
+        assert self._txn is not None
+
+        # store the record, returning True if it was written, or False to indicate the key
+        # was already present and overwrite=False.
+        was_written = self._txn.put(key, data, overwrite=overwrite)
+        if was_written:
+            if self._stats:
+                self._stats.puts += 1
+            if self._log:
+                self._log.append((Transaction.PUT, key))
+        return was_written
+
+    def delete(self, key):
+        """
+
+        :param key:
+        :return:
+        """
+        assert self._txn is not None
+
+        was_deleted = self._txn.delete(key)
+        if was_deleted:
+            if self._stats:
+                self._stats.dels += 1
+            if self._log:
+                self._log.append((Transaction.DEL, key))
+        return was_deleted