zlmdb._pmap

Persistent mappings.

Attributes

HAS_SNAPPY
_NATIVE_PICKLE_PROTOCOL

Classes

Index	Holds book-keeping metadata for indexes on tables (pmaps).
MapBytes16FlatBuffers	Persistent map with Bytes16 keys and Flatbuffers values.
MapBytes16TimestampUuid	Persistent map with (Bytes20, Timestamp) keys and UUID values.
MapBytes16TimestampUuidFlatBuffers	Persistent map with (Bytes20, Timestamp, UUID) keys and Flatbuffers values.
MapBytes20Bytes16	Persistent map with Bytes20 keys and Bytes16 values.
MapBytes20Bytes20	Persistent map with Bytes20 keys and Bytes20 values.
MapBytes20Bytes20FlatBuffers	Persistent map with (Bytes20, Bytes20) keys and Flatbuffers values.
MapBytes20Bytes20Timestamp	Persistent map with Bytes20 keys and (Bytes20, Timestamp) values.
MapBytes20FlatBuffers	Persistent map with Bytes20 keys and Flatbuffers values.
MapBytes20StringFlatBuffers	Persistent map with (Bytes20, String) keys and Flatbuffers values.
MapBytes20TimestampBytes20	Persistent map with (Bytes20, Timestamp) keys and Bytes20 values.
MapBytes20TimestampUuid	Persistent map with (Bytes20, Timestamp) keys and UUID values.
MapBytes20Uuid	Persistent map with Bytes20 keys and UUID values.
MapBytes32Bytes32	Persistent map with Bytes32 keys and Bytes32 values.
MapBytes32Bytes32FlatBuffers	Persistent map with (Bytes32, Bytes32) keys and Flatbuffers values.
MapBytes32FlatBuffers	Persistent map with Bytes32 keys and Flatbuffers values.
MapBytes32StringFlatBuffers	Persistent map with (Bytes32, String) keys and Flatbuffers values.
MapBytes32Timestamp	Persistent map with Bytes32 keys and Timestamp values.
MapBytes32Uuid	Persistent map with Bytes32 keys and UUID values.
MapBytes32UuidFlatBuffers	Persistent map with (Bytes32, UUID) keys and Flatbuffers values.
MapOid3FlatBuffers	Persistent map with (OID, OID, OID) / (uint64, uint64, uint64) keys and FlatBuffers values.
MapOidCbor	Persistent map with OID (uint64) keys and CBOR values.
MapOidFlatBuffers	Persistent map with OID (uint64) keys and FlatBuffers values.
MapOidJson	Persistent map with OID (uint64) keys and JSON values.
MapOidOid	Persistent map with OID (uint64) keys and OID (uint64) values.
MapOidOidFlatBuffers	Persistent map with (OID, OID) / (uint64, uint64) keys and FlatBuffers values.
MapOidOidOid	Persistent map with (OID, OID) keys and OID values.
MapOidOidSet	Persistent map with OID (uint64) keys and OID-set (set of unique uint64) values.
MapOidPickle	Persistent map with OID (uint64) keys and Python pickle values.
MapOidString	Persistent map with OID (uint64) keys and string (utf8) values.
MapOidStringOid	Persistent map with (OID, string) keys and OID values.
MapOidTimestampFlatBuffers	Persistent map with (OID, Timestamp) keys and Flatbuffers values, where Timestamp is a np.datetime64[ns].
MapOidTimestampOid	Persistent map with (OID, Timestamp) keys and OID values, where Timestamp is a np.datetime64[ns].
MapOidTimestampStringOid	Persistent map with (OID, Timestamp, String) keys and OID values, where Timestamp is a np.datetime64[ns].
MapOidUuid	Persistent map with OID (uint64) keys and UUID (16 bytes) values.
MapSlotUuidUuid	Persistent map with (slot, UUID) and UUID values.
MapStringCbor	Persistent map with string (utf8) keys and CBOR values.
MapStringFlatBuffers	Persistent map with string (utf8) keys and FlatBuffers values.
MapStringJson	Persistent map with string (utf8) keys and JSON values.
MapStringOid	Persistent map with string (utf8) keys and OID (uint64) values.
MapStringOidOid	Persistent map with (string:utf8, OID:uint64) keys and OID:uint64 values.
MapStringPickle	Persistent map with string (utf8) keys and Python pickle values.
MapStringString	Persistent map with string (utf8) keys and string (utf8) values.
MapStringStringStringUuid	Persistent map with (string, string, string) keys and UUID (16 bytes) values.
MapStringStringUuid	Persistent map with (string, string) keys and UUID (16 bytes) values.
MapStringTimestampCbor	Persistent map with (String, Timestamp) keys and CBOR values.
MapStringUuid	Persistent map with string (utf8) keys and UUID (16 bytes) values.
MapTimestampBytes32FlatBuffers	Persistent map with (Timestamp, Bytes32) keys and FlatBuffers values.
MapTimestampFlatBuffers	Persistent map with Timestamp keys and FlatBuffers values.
MapTimestampStringCbor	Persistent map with (Timestamp, String) keys and CBOR values.
MapTimestampStringFlatBuffers	Persistent map with (Timestamp, String) keys and FlatBuffers values.
MapTimestampUuidCbor	Persistent map with (Timestamp, UUID) keys and CBOR values.
MapTimestampUuidFlatBuffers	Persistent map with (Timestamp, UUID) keys and FlatBuffers values.
MapTimestampUuidStringFlatBuffers	Persistent map with (Timestamp, UUID, String) keys and FlatBuffers values.
MapUint16UuidTimestampFlatBuffers	Persistent map with (uint16, UUID, Timestamp) keys and FlatBuffers values.
MapUint64TimestampUuid	Persistent map with (Uint64, Timestamp) keys and UUID values.
MapUuidBytes20Bytes20Uint8UuidFlatBuffers	Persistent map with (UUID, bytes[20], bytes[20], uint8, UUID) keys and FlatBuffers values.
MapUuidBytes20Uint8FlatBuffers	Persistent map with (UUID, bytes[20], uint8) keys and FlatBuffers values.
MapUuidBytes20Uint8UuidFlatBuffers	Persistent map with (UUID, bytes[20], uint8, UUID) keys and FlatBuffers values.
MapUuidBytes32FlatBuffers	Persistent map with (UUID, Bytes32) keys and Flatbuffers values.
MapUuidCbor	Persistent map with UUID (16 bytes) keys and CBOR values.
MapUuidFlatBuffers	Persistent map with UUID (16 bytes) keys and FlatBuffers values.
MapUuidJson	Persistent map with UUID (16 bytes) keys and JSON values.
MapUuidOid	Persistent map with UUID (16 bytes) keys and OID (uint64) values.
MapUuidPickle	Persistent map with UUID (16 bytes) keys and Python Pickle values.
MapUuidString	Persistent map with UUID (16 bytes) keys and string (utf8) values.
MapUuidStringFlatBuffers	Persistent map with (UUID, String) keys and Flatbuffers values.
MapUuidStringOid	Persistent map with (UUID, string) keys and Oid values.
MapUuidStringUuid	Persistent map with (UUID, string) keys and UUID values.
MapUuidTimestampBytes32	Persistent map with (UUID, Timestamp) keys and Bytes32 values.
MapUuidTimestampCbor	Persistent map with (UUID, Timestamp) keys and CBOR values.
MapUuidTimestampFlatBuffers	Persistent map with (UUID, Timestamp) keys and FlatBuffers values.
MapUuidTimestampUuid	Persistent map with (UUID, timestamp) keys and UUID values.
MapUuidTimestampUuidFlatBuffers	Persistent map with (UUID, Timestamp, UUID) keys and FlatBuffers values.
MapUuidUuid	Persistent map with UUID (16 bytes) keys and UUID (16 bytes) values.
MapUuidUuidCbor	Persistent map with (UUID, UUID) keys and CBOR values.
MapUuidUuidFlatBuffers	Persistent map with (UUID, UUID) keys and Flatbuffers values.
MapUuidUuidSet	Persistent map with (UUID, string) keys and UUID values.
MapUuidUuidStringFlatBuffers	Persistent map with (UUID, UUID, String) keys and Flatbuffers values.
MapUuidUuidStringUuid	Persistent map with (UUID, UUID, string) keys and UUID values.
MapUuidUuidUuid	Persistent map with (UUID, UUID) keys and UUID values.
MapUuidUuidUuidStringUuid	Persistent map with (UUID, UUID, UUID, string) keys and UUID values.
MapUuidUuidUuidUuid	Persistent map with (UUID, UUID, UUID) keys and UUID values.
MapUuidUuidUuidUuidUuid	Persistent map with (UUID, UUID, UUID, UUID) keys and UUID values.
PersistentMap	Abstract base class for persistent maps stored in LMDB.
PersistentMapIterator	Iterator that walks over zLMDB database records.

Functions

is_null(value)	Check if the scalar value or tuple/list value is NULL.
qual(obj)	Return fully qualified name of a class.

Module Contents

HAS_SNAPPY = False

class Index(name, fkey, pmap, nullable=False, unique=True)

Bases: object

Holds book-keeping metadata for indexes on tables (pmaps).

_fkey

_name

_nullable = False

_pmap

_unique = True

property fkey

Indexed value extractor property.

Returns:

Function to extract indexed value from the indexed table.

Return type:

callable

property name

Index name property.

Returns:

Name of the index (on the indexed table).

Return type:

str

property nullable

Index nullable property.

Returns:

Whether the indexed table column is allowed to take None values.

Return type:

bool

property pmap

Index table (pmap) property.

Returns:

Persistent map for index storage.

Return type:

zlmdb._pmap.PersistentMap

property unique

Index uniqueness property-

Returns:

Whether the indexed table column must take unique values.

Return type:

bool

class MapBytes16FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes16KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with Bytes16 keys and Flatbuffers values.

class MapBytes16TimestampUuid(slot=None, compress=None)

Bases: zlmdb._types._Bytes16TimestampKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (Bytes20, Timestamp) keys and UUID values.

class MapBytes16TimestampUuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes16TimestampUuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Bytes20, Timestamp, UUID) keys and Flatbuffers values.

class MapBytes20Bytes16(slot=None, compress=None)

Bases: zlmdb._types._Bytes20KeysMixin, zlmdb._types._Bytes16ValuesMixin, PersistentMap

Persistent map with Bytes20 keys and Bytes16 values.

class MapBytes20Bytes20(slot=None, compress=None)

Bases: zlmdb._types._Bytes20KeysMixin, zlmdb._types._Bytes20ValuesMixin, PersistentMap

Persistent map with Bytes20 keys and Bytes20 values.

class MapBytes20Bytes20FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes20Bytes20KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Bytes20, Bytes20) keys and Flatbuffers values.

class MapBytes20Bytes20Timestamp(slot=None, compress=None)

Bases: zlmdb._types._Bytes20KeysMixin, zlmdb._types._Bytes20TimestampValuesMixin, PersistentMap

Persistent map with Bytes20 keys and (Bytes20, Timestamp) values.

class MapBytes20FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes20KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with Bytes20 keys and Flatbuffers values.

class MapBytes20StringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes20StringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Bytes20, String) keys and Flatbuffers values.

class MapBytes20TimestampBytes20(slot=None, compress=None)

Bases: zlmdb._types._Bytes20TimestampKeysMixin, zlmdb._types._Bytes20ValuesMixin, PersistentMap

Persistent map with (Bytes20, Timestamp) keys and Bytes20 values.

class MapBytes20TimestampUuid(slot=None, compress=None)

Bases: zlmdb._types._Bytes20TimestampKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (Bytes20, Timestamp) keys and UUID values.

class MapBytes20Uuid(slot=None, compress=None)

Bases: zlmdb._types._Bytes20KeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with Bytes20 keys and UUID values.

class MapBytes32Bytes32(slot=None, compress=None)

Bases: zlmdb._types._Bytes32KeysMixin, zlmdb._types._Bytes32ValuesMixin, PersistentMap

Persistent map with Bytes32 keys and Bytes32 values.

class MapBytes32Bytes32FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes32Bytes32KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Bytes32, Bytes32) keys and Flatbuffers values.

class MapBytes32FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes32KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with Bytes32 keys and Flatbuffers values.

class MapBytes32StringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes32StringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Bytes32, String) keys and Flatbuffers values.

class MapBytes32Timestamp(slot=None, compress=None)

Bases: zlmdb._types._Bytes32KeysMixin, zlmdb._types._TimestampValuesMixin, PersistentMap

Persistent map with Bytes32 keys and Timestamp values.

class MapBytes32Uuid(slot=None, compress=None)

Bases: zlmdb._types._Bytes32KeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with Bytes32 keys and UUID values.

class MapBytes32UuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Bytes32UuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Bytes32, UUID) keys and Flatbuffers values.

class MapOid3FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Oid3KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (OID, OID, OID) / (uint64, uint64, uint64) keys and FlatBuffers values.

class MapOidCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and CBOR values.

class MapOidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and FlatBuffers values.

class MapOidJson(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._JsonValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and JSON values.

class MapOidOid(slot=None, compress=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and OID (uint64) values.

class MapOidOidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._OidOidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (OID, OID) / (uint64, uint64) keys and FlatBuffers values.

class MapOidOidOid(slot=None, compress=None)

Bases: zlmdb._types._OidOidKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with (OID, OID) keys and OID values.

class MapOidOidSet(slot=None, compress=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._OidSetValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and OID-set (set of unique uint64) values.

class MapOidPickle(slot=None, compress=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._PickleValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and Python pickle values.

class MapOidString(slot=None, compress=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._StringValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and string (utf8) values.

class MapOidStringOid(slot=None, compress=None)

Bases: zlmdb._types._OidStringKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with (OID, string) keys and OID values.

class MapOidTimestampFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._OidTimestampKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (OID, Timestamp) keys and Flatbuffers values, where Timestamp is a np.datetime64[ns].

class MapOidTimestampOid(slot=None, compress=None)

Bases: zlmdb._types._OidTimestampKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with (OID, Timestamp) keys and OID values, where Timestamp is a np.datetime64[ns].

class MapOidTimestampStringOid(slot=None, compress=None)

Bases: zlmdb._types._OidTimestampStringKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with (OID, Timestamp, String) keys and OID values, where Timestamp is a np.datetime64[ns].

class MapOidUuid(slot=None, compress=None)

Bases: zlmdb._types._OidKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with OID (uint64) keys and UUID (16 bytes) values.

class MapSlotUuidUuid(slot=None, compress=None)

Bases: zlmdb._types._SlotUuidKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (slot, UUID) and UUID values.

class MapStringCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with string (utf8) keys and CBOR values.

class MapStringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with string (utf8) keys and FlatBuffers values.

class MapStringJson(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._JsonValuesMixin, PersistentMap

Persistent map with string (utf8) keys and JSON values.

class MapStringOid(slot=None, compress=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with string (utf8) keys and OID (uint64) values.

class MapStringOidOid(slot=None, compress=None)

Bases: zlmdb._types._StringOidKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with (string:utf8, OID:uint64) keys and OID:uint64 values.

class MapStringPickle(slot=None, compress=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._PickleValuesMixin, PersistentMap

Persistent map with string (utf8) keys and Python pickle values.

class MapStringString(slot=None, compress=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._StringValuesMixin, PersistentMap

Persistent map with string (utf8) keys and string (utf8) values.

class MapStringStringStringUuid(slot=None, compress=None)

Bases: zlmdb._types._StringStringStringKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (string, string, string) keys and UUID (16 bytes) values.

class MapStringStringUuid(slot=None, compress=None)

Bases: zlmdb._types._StringStringKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (string, string) keys and UUID (16 bytes) values.

class MapStringTimestampCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._StringTimestampKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with (String, Timestamp) keys and CBOR values.

class MapStringUuid(slot=None, compress=None)

Bases: zlmdb._types._StringKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with string (utf8) keys and UUID (16 bytes) values.

class MapTimestampBytes32FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._TimestampBytes32KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Timestamp, Bytes32) keys and FlatBuffers values.

class MapTimestampFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._TimestampKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with Timestamp keys and FlatBuffers values.

class MapTimestampStringCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._TimestampStringKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with (Timestamp, String) keys and CBOR values.

class MapTimestampStringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._TimestampStringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Timestamp, String) keys and FlatBuffers values.

class MapTimestampUuidCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._TimestampUuidKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with (Timestamp, UUID) keys and CBOR values.

class MapTimestampUuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._TimestampUuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Timestamp, UUID) keys and FlatBuffers values.

class MapTimestampUuidStringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._TimestampUuidStringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (Timestamp, UUID, String) keys and FlatBuffers values.

class MapUint16UuidTimestampFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._Uint16UuidTimestampKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (uint16, UUID, Timestamp) keys and FlatBuffers values.

class MapUint64TimestampUuid(slot=None, compress=None)

Bases: zlmdb._types._Uint64TimestampKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (Uint64, Timestamp) keys and UUID values.

class MapUuidBytes20Bytes20Uint8UuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidBytes20Bytes20Uint8UuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, bytes[20], bytes[20], uint8, UUID) keys and FlatBuffers values.

class MapUuidBytes20Uint8FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidBytes20Uint8KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, bytes[20], uint8) keys and FlatBuffers values.

class MapUuidBytes20Uint8UuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidBytes20Uint8UuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, bytes[20], uint8, UUID) keys and FlatBuffers values.

class MapUuidBytes32FlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidBytes32KeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, Bytes32) keys and Flatbuffers values.

class MapUuidCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and CBOR values.

class MapUuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and FlatBuffers values.

class MapUuidJson(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._JsonValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and JSON values.

class MapUuidOid(slot=None, compress=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and OID (uint64) values.

class MapUuidPickle(slot=None, compress=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._PickleValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and Python Pickle values.

class MapUuidString(slot=None, compress=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._StringValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and string (utf8) values.

class MapUuidStringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidStringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, String) keys and Flatbuffers values.

class MapUuidStringOid(slot=None, compress=None)

Bases: zlmdb._types._UuidStringKeysMixin, zlmdb._types._OidValuesMixin, PersistentMap

Persistent map with (UUID, string) keys and Oid values.

class MapUuidStringUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidStringKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, string) keys and UUID values.

class MapUuidTimestampBytes32(slot=None, compress=None)

Bases: zlmdb._types._UuidTimestampKeysMixin, zlmdb._types._Bytes32ValuesMixin, PersistentMap

Persistent map with (UUID, Timestamp) keys and Bytes32 values.

class MapUuidTimestampCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._UuidTimestampKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with (UUID, Timestamp) keys and CBOR values.

class MapUuidTimestampFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidTimestampKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, Timestamp) keys and FlatBuffers values.

class MapUuidTimestampUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidTimestampKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, timestamp) keys and UUID values.

class MapUuidTimestampUuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidTimestampUuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, Timestamp, UUID) keys and FlatBuffers values.

class MapUuidUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with UUID (16 bytes) keys and UUID (16 bytes) values.

class MapUuidUuidCbor(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: zlmdb._types._UuidUuidKeysMixin, zlmdb._types._CborValuesMixin, PersistentMap

Persistent map with (UUID, UUID) keys and CBOR values.

class MapUuidUuidFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidUuidKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, UUID) keys and Flatbuffers values.

class MapUuidUuidSet(slot=None, compress=None)

Bases: zlmdb._types._UuidKeysMixin, zlmdb._types._UuidSetValuesMixin, PersistentMap

Persistent map with (UUID, string) keys and UUID values.

class MapUuidUuidStringFlatBuffers(slot=None, compress=None, build=None, cast=None)

Bases: zlmdb._types._UuidUuidStringKeysMixin, zlmdb._types._FlatBuffersValuesMixin, PersistentMap

Persistent map with (UUID, UUID, String) keys and Flatbuffers values.

class MapUuidUuidStringUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidUuidStringKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, UUID, string) keys and UUID values.

class MapUuidUuidUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidUuidKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, UUID) keys and UUID values.

class MapUuidUuidUuidStringUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidUuidUuidStringKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, UUID, UUID, string) keys and UUID values.

class MapUuidUuidUuidUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidUuidUuidKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, UUID, UUID) keys and UUID values.

class MapUuidUuidUuidUuidUuid(slot=None, compress=None)

Bases: zlmdb._types._UuidUuidUuidUuidKeysMixin, zlmdb._types._UuidValuesMixin, PersistentMap

Persistent map with (UUID, UUID, UUID, UUID) keys and UUID values.

class PersistentMap(slot: int | None, compress: int | None = None)

Bases: UserDict.DictMixin

Abstract base class for persistent maps stored in LMDB.

COMPRESS_SNAPPY = 2

COMPRESS_ZLIB = 1

__contains__(txn_key)

Parameters:

txn_key

Returns:

__delitem__(txn_key)

Parameters:

txn_key

Returns:

__getitem__(txn_key)

Parameters:

txn_key

Returns:

abstractmethod __iter__()

abstractmethod __len__()

__setitem__(txn_key, value)

Parameters:

• txn_key

• value

Returns:

_deserialize_key(data)

_deserialize_value(data)

_index_attached_to = None

_indexes: Dict[str, Index]

_serialize_key(key)

_serialize_value(value)

_slot

_zlmdb_build: Callable | None = None

_zlmdb_cast: Callable | None = None

_zlmdb_compress: int | None = None

_zlmdb_marshal: Callable | None = None

_zlmdb_oid: uuid.UUID | None = None

_zlmdb_parse: Callable | None = None

attach_index(name: str, pmap: PersistentMap, fkey: Callable, nullable: bool = False, unique: bool = True)

Parameters:

• name

• pmap

• fkey

• nullable

• unique

count(txn: zlmdb._transaction.Transaction, prefix: Any = None) → int

Count number of records in the persistent map. When no prefix is given, the total number of records is returned. When a prefix is given, only the number of records with keys that have this prefix are counted.

Parameters:

• txn – The transaction in which to run.

• prefix – The key prefix of records to count.

Returns:

The number of records.

count_range(txn: zlmdb._transaction.Transaction, from_key: Any, to_key: Any) → int

Counter number of records in the perstistent map with keys within the given range.

Parameters:

• txn – The transaction in which to run.

• from_key – Count records starting and including from this key.

• to_key – End counting records before this key.

Returns:

The number of records.

detach_index(name: str)

Parameters:

name

indexes() → List[str]

Returns:

is_index() → bool

Flag indicating whether this pmap is used as an index.

Returns:

rebuild_index(txn: zlmdb._transaction.Transaction, name: str) → Tuple[int, int]

Parameters:

• txn

• name

Returns:

rebuild_indexes(txn: zlmdb._transaction.Transaction) → Tuple[int, int]

Parameters:

txn

Returns:

select(txn: zlmdb._transaction.Transaction, from_key: Any = None, to_key: Any = None, return_keys: bool = True, return_values: bool = True, reverse: bool = False, limit: int | None = None) → PersistentMapIterator

Select all records (key-value pairs) in table, optionally within a given key range.

Parameters:

• txn – The transaction in which to run.

• from_key – Return records starting from (and including) this key.

• to_key – Return records up to (but not including) this key.

• return_keys – If True (default), return keys of records.

• return_values – If True (default), return values of records.

• reverse – If True, return records in reverse order.

• limit – Limit number of records returned.

Returns:

truncate(txn: zlmdb._transaction.Transaction, rebuild_indexes: bool = True) → int

Parameters:

• txn

• rebuild_indexes

Returns:

class PersistentMapIterator(txn: zlmdb._transaction.Transaction, pmap: PersistentMap, from_key: Any = None, to_key: Any = None, return_keys: bool = True, return_values: bool = True, reverse: bool = False, limit: int | None = None)

Bases: object

Iterator that walks over zLMDB database records.

__iter__() → PersistentMapIterator

__next__()

Returns:

Return either (key, value), key or value, depending on return_keys and return_values.

_cursor = None

_found = None

_limit = None

_pmap

_read = 0

_return_keys = True

_return_values = True

_reverse = False

_txn

next

_NATIVE_PICKLE_PROTOCOL = 2

is_null(value)

Check if the scalar value or tuple/list value is NULL.

Parameters:

value (a scalar or tuple or list) – Value to check.

Returns:

Returns True if and only if the value is NULL (scalar value is None or _any_ tuple/list elements are None).

Return type:

bool

qual(obj)

Return fully qualified name of a class.