Skip to main content

Templated Abstract Polymorphic Database - A flexible object model library

Project description

Templated Abstract Polymorphic Database

Templated Abstract Polymorphic Database, or TAPDB, is a reusable PostgreSQL-backed substrate for typed, versioned, auditable entities.

It is intentionally not a domain application. TAPDB provides the generic persistence and runtime mechanics that higher-level repos use to model their own business objects. Bloom is a motivating example of the kind of system TAPDB supports, but Bloom-specific workflow semantics do not belong in TAPDB itself.

At a high level TAPDB combines:

  • SQLAlchemy polymorphic models over a small, schema-stable core
  • template packs that define object shape and behavior
  • concrete instances created from those templates
  • lineage edges that describe relationships and history
  • audit, outbox, and inbox tables that preserve change and delivery state
  • explicit domain, application, and tenant scoping
flowchart TB
    App["Client application repo\n(Bloom or another domain app)"]
    CLI["tapdb CLI"]
    Lib["daylily_tapdb library"]
    DB["PostgreSQL\nschema + triggers + RLS"]
    Core["TAPDB core substrate\nTemplates / Instances / Lineage / Audit / Outbox / Inbox"]
    Domain["App-owned domain code\nTemplates, workflows, UI, integrations"]

    App --> Domain
    Domain --> CLI
    Domain --> Lib
    CLI --> Core
    Lib --> Core
    Core --> DB
    DB --> Core

Quickstart

The repo follows a CLI-first workflow. Start by activating the repo environment:

source ./activate

The canonical operational form for runtime commands is:

tapdb --config <path> --env <name> ...

Smoke the installed CLI surface first:

tapdb --help
tapdb version
bash examples/readme/00_smoke.sh

For a fuller local bootstrap, use the namespaced config flow and then bring up the local runtime:

tapdb --config ~/.config/tapdb/<client-id>/<database-name>/tapdb-config.yaml \
  db-config init \
  --client-id <client-id> \
  --database-name <database-name> \
  --euid-client-code <client-code> \
  --env dev \
  --db-port dev=5533 \
  --ui-port dev=8911

tapdb --config ~/.config/tapdb/<client-id>/<database-name>/tapdb-config.yaml \
  --env dev \
  bootstrap local --no-gui

tapdb --config ~/.config/tapdb/<client-id>/<database-name>/tapdb-config.yaml \
  --env dev \
  info --json

If optional workflow packs are present in the config, add --include-workflow to the bootstrap command. If you want the generated scripts rather than inline commands, use the companion examples under examples/readme/:

  • examples/readme/00_smoke.sh
  • examples/readme/10_bootstrap_local.sh
  • examples/readme/20_python_api.py

Mental Model

TAPDB’s core model is deliberately small:

  • template: a blueprint, stored as a generic_template row and usually seeded from JSON packs
  • instance: a concrete object, stored as a generic_instance row and created from a template
  • lineage: a directed relationship, stored as generic_instance_lineage
  • audit: immutable change history in audit_log
  • outbox: durable dispatch state for cross-service delivery
  • inbox: durable receipt state for inbound messages

The library surface is built around those concepts:

  • TemplateManager resolves template codes to seeded templates
  • InstanceFactory materializes instances from templates
  • lineage helpers traverse parent/child relationships
  • outbox helpers enqueue, claim, deliver, and record message attempts

The important mental shift is that template packs describe shape, not business truth. Application repos own domain semantics and TAPDB stores the substrate that those semantics sit on.

Identity And Scope

TAPDB uses multiple identity layers on purpose:

  • uid is the internal BIGINT primary key
  • euid is the external Meridian identifier used on labels, links, APIs, and human-facing references
  • domain_code scopes a row or identifier to a Meridian domain
  • issuer_app_code records the issuing application and is not part of the EUID string
  • tenant_id is the database tenancy scope and is separate from Meridian domain scoping

Do not infer business meaning from an EUID prefix. EUIDs are opaque by design. The string helps validation and transport; the real meaning lives in database lookup and application context.

Boundaries

TAPDB owns:

  • template seeding and validation
  • polymorphic persistence
  • lineage and graph traversal
  • audit and soft-delete behavior
  • outbox/inbox delivery state
  • CLI-managed runtime and database lifecycle

Application repos own:

  • domain semantics
  • domain template packs
  • workflow rules and business policy
  • UI and API affordances on top of TAPDB
  • integration-specific behavior

That boundary is the point of the project. TAPDB is the substrate, not the business system.

Docs

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

daylily_tapdb-4.0.3.tar.gz (319.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

daylily_tapdb-4.0.3-py3-none-any.whl (229.1 kB view details)

Uploaded Python 3

File details

Details for the file daylily_tapdb-4.0.3.tar.gz.

File metadata

  • Download URL: daylily_tapdb-4.0.3.tar.gz
  • Upload date:
  • Size: 319.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for daylily_tapdb-4.0.3.tar.gz
Algorithm Hash digest
SHA256 081e88137f69d6174895027c8958e88e60952bf27b9b34e5e21a6af56be5d6b7
MD5 32fc772c720437904ab9dd96b7294363
BLAKE2b-256 71bb7857b652fbba3ea238c68d9ed7c665c77b6215b752f516996b08635be62e

See more details on using hashes here.

File details

Details for the file daylily_tapdb-4.0.3-py3-none-any.whl.

File metadata

  • Download URL: daylily_tapdb-4.0.3-py3-none-any.whl
  • Upload date:
  • Size: 229.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for daylily_tapdb-4.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d2ef6ea9d11885be1d163bc01e7edfff94a34230f70bd382d5696fc6ab2f0c30
MD5 5038ff6652d54ccf9c24d6d9a9be7b08
BLAKE2b-256 ecc2011ed527293e9067102cd9830192d278697b67f8f2137bf78d22da133a28

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page