microcosm-sqlite

Opinionated data loading with SQLite.

While most distributed application runtimes will use a networked data store for mutable state, the usage patterns of data that is read-only at runtime are great fit for SQLite.

In particular, microcosm-sqlite assumes that applications will

Build data sets in advance and ship them as static artifacts (e.g. in source control)
Load data immutable sets at runtime without loading entire data sets into memory

Writing Models

Persistent data is expected to use SQLAlchemy's declarative base classes. Because different data sets may be shipped in different SQLite databases, each declarative base class needs to have a unique name and a separate engine configuration, which is achieved by adding DataSet as the base of the declarative base class:

Base = DataSet.create("some_name")


class SomeModel(Base):
    __tablename__ = "sometable"

    id = Column(Integer, primary_key=True)

Using Stores

Basic persistence operations are abstracted through a store:

class SomeStore(Store):

    @property
    def model_class(self):
        return SomeModel


 store = SomeStore()
 results = store.search()

Configuring SQLite

Each DataSet defaults to using :memory: storage, but can be customized in two ways:

The SQLiteBindFactory can be configured with custom paths:

loader = load_from_dict(
    sqlite=dict(
        paths={
            "some_name": "/path/to/database",
        },
    ),
)
graph = create_object_graph("example", loader=loader)

The microcosm.sqlite entrypoint can contain a mapping from a data set name to a function that returns a path.

Release files for microcosm-sqlite 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for microcosm-sqlite 2.0.0
File	Interpreter	ABI	Platform	Reset
microcosm_sqlite-2.0.0-py3-none-any.whl 22.2 kB Jun 28, 2024	Python 3	none	any	Details

Release files / microcosm_sqlite-2.0.0-py3-none-any.whl

Download URL	microcosm_sqlite-2.0.0-py3-none-any.whl
Size	22.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`c24013278555c906d275e05bd43ef2ca759b639f64423f135b38cb58adfc6341`
BLAKE2b-256 checksum How to use checksums	`09e812cf5ae0dea41c045021243a5b34cc19c79ceceed69cdea7893e8c710958`
Upload date	Jun 28, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.9`