zlmdb._database

Attributes

KV_TYPE_TO_CLASS
_LMDB_MYPID_ENVS

Classes

ConfigurationElement	Internal zLMDB configuration element base type.
Database	ZLMDB database access.
Schema
Slot	Internal zLMDB database slot configuration element.

Functions

qual(→ str)

Module Contents

class ConfigurationElement(oid: uuid.UUID | None = None, name: str | None = None, description: str | None = None, tags: List[str] | None = None)

Bases: object

Internal zLMDB configuration element base type.

__eq__(other: Any) → bool

__ne__(other: Any) → bool

__slots__ = ('_oid', '_name', '_description', '_tags')

__str__() → str

_description = None

_name = None

_oid = None

_tags = None

property description: str | None

marshal() → Dict[str, Any]

property name: str | None

property oid: uuid.UUID | None

static parse(value: Dict[str, Any]) → ConfigurationElement

property tags: List[str] | None

class Database(dbpath: str | None = None, maxsize: int = 10485760, readonly: bool = False, lock: bool = True, sync: bool = True, create: bool = True, open_now: bool = True, writemap: bool = False, context: Any = None, log: txaio.interfaces.ILogger | None = None)

Bases: object

ZLMDB database access.

Objects of this class are generally “light-weight” (cheap to create and destroy), but do manage internal resource such as file descriptors.

To manage these resources in a robust way, this class implements the Python context manager interface.

__enter__()

Enter database runtime context and open the underlying LMDB database environment.

Note

Enter the runtime context related to this object. The with statement will bind this method’s return value to the target(s) specified in the as clause of the statement, if any. [Source](https://docs.python.org/3/reference/datamodel.html#object.__enter__)

Note

A context manager is an object that defines the runtime context to be established when executing a with statement. The context manager handles the entry into, and the exit from, the desired runtime context for the execution of the block of code. Context managers are normally invoked using the with statement (described in section The with statement), but can also be used by directly invoking their methods.” [Source](https://docs.python.org/3/reference/datamodel.html#with-statement-context-managers)

Returns:

This database instance (in open state).

__exit__(exc_type, exc_value, traceback)

Exit runtime context and close the underlying LMDB database environment.

Note

Exit the runtime context related to this object. The parameters describe the exception that caused the context to be exited. If the context was exited without an exception, all three arguments will be None. [Source](https://docs.python.org/3/reference/datamodel.html#object.__exit__).

Parameters:

• exc_type

• exc_value

• traceback

Returns:

__slots__ = ('log', '_is_temp', '_tempdir', '_dbpath', '_maxsize', '_readonly', '_lock', '_sync', '_create',...

_attach_slot(oid: uuid.UUID, klass: Type[zlmdb._pmap.PersistentMap], marshal: Callable | None = None, parse: Callable | None = None, build: Callable | None = None, cast: Callable | None = None, compress: int | None = None, create: bool = True, name: str | None = None, description: str | None = None)

Parameters:

• oid

• klass

• marshal

• parse

• build

• cast

• compress

• create

• name

• description

Returns:

_cache_slots()

Returns:

_context = None

_create = True

_env: zlmdb.lmdb.Environment | None = None

_get_free_slot() → int

Returns:

_get_slots(cached=True) → Dict[uuid.UUID, Slot]

Parameters:

cached

Returns:

_lock = True

_maxsize = 10485760

_open_now = True

_readonly = False

_set_slot(slot_index: int, slot: Slot | None)

Parameters:

• slot_index

• slot

Returns:

_slots: Dict[uuid.UUID, Slot] | None = None

_slots_by_index: Dict[uuid.UUID, int] | None = None

_sync = True

_writemap = False

attach_table(klass: Type[zlmdb._pmap.PersistentMap])

Parameters:

klass

Returns:

begin(write: bool = False, buffers: bool = False, stats: zlmdb._transaction.TransactionStats | None = None) → zlmdb._transaction.Transaction

Parameters:

• write

• buffers

• stats

Returns:

config() → Dict[str, Any]

Returns:

property context

return:

property dbpath: str | None

return:

property is_open: bool

return:

property is_readonly: bool

return:

property is_sync: bool

return:

property is_writemap: bool

return:

property maxsize: int

return:

static open(dbpath: str | None = None, maxsize: int = 10485760, readonly: bool = False, lock: bool = True, sync: bool = True, create: bool = True, open_now: bool = True, writemap: bool = False, context: Any = None, log: txaio.interfaces.ILogger | None = None) → Database

static scratch(dbpath: str)

Parameters:

dbpath

Returns:

stats(include_slots: bool = False) → Dict[str, Any]

Parameters:

include_slots

Returns:

sync(force: bool = False)

Parameters:

force

Returns:

KV_TYPE_TO_CLASS

class Schema(meta, slots, slots_byname)

Bases: object

abstractmethod __delitem__(name)

__getitem__(name)

__iter__()

__len__()

abstractmethod __setitem__(name, value)

__str__()

_meta

_slots

_slots_byname

static parse(filename, klassmap=KV_TYPE_TO_CLASS)

class Slot(oid: uuid.UUID | None = None, name: str | None = None, description: str | None = None, tags: List[str] | None = None, slot: int | None = None, creator: str | None = None)

Bases: ConfigurationElement

Internal zLMDB database slot configuration element.

__slots__ = ('_slot', '_creator')

__str__() → str

_creator = None

_slot = None

property creator: str | None

marshal() → Dict[str, Any]

static parse(data: Dict[str, Any]) → Slot

property slot: int | None

_LMDB_MYPID_ENVS: Dict[str, Tuple[Database, int]]

qual(clazz: type) → str