Skip to main content

PyPI Python License

evoid-postgresql

PostgreSQL storage engine — Intent Handler system

Quick StartIntent HandlerConfigAPI


Quick Start

pip install evoid-postgresql

Method 1: Intent Handler (Recommended)

from evoid_postgresql import register_handlers
from evoid.core.storage import storage_read, storage_write, storage_delete

# Register PostgreSQL as storage handler
register_handlers(url="postgresql+asyncpg://user:pass@localhost/evoid")

# Use high-level API
await storage_write("user:1", {"name": "Alice"})
user = await storage_read("user:1")
await storage_delete("user:1")

Method 2: Direct API

from evoid_postgresql import create_storage

storage = create_storage("postgresql+asyncpg://user:pass@localhost/evoid")
await storage.write("user:1", {"name": "Alice"})
user = await storage.read("user:1")

Intent Handler

evoid-postgresql registers these Intent handlers:

Intent Handler Description
storage.read handle_read Read from PostgreSQL
storage.write handle_write Write to PostgreSQL
storage.delete handle_delete Delete from PostgreSQL
storage.health handle_health Check connection

Configuration

TOML

[engines]
storage = "postgresql"

[engines.options.postgresql]
url = "postgresql+asyncpg://user:pass@localhost/evoid"

Python

from evoid.config import config

app = config(
    engines={
        "storage": "postgresql",
        "options": {
            "postgresql": {
                "url": "postgresql+asyncpg://prod:secret@db/evoid",
            },
        },
    },
)

API

register_handlers(url: str)

Register PostgreSQL as Intent handlers.

Parameter Type Default Description
url str postgresql+asyncpg://localhost/evoid SQLAlchemy async connection URL

create_storage(url: str) -> PostgresStorage

Factory function for direct API access.

Methods

Method Signature Returns Description
write async write(key: str, data: dict) bool Upsert data (JSONB)
read async read(key: str) Any | None Read data by key
delete async delete(key: str) bool Delete by key
health async health() bool Check connection

Dependencies

  • evoid>=0.4.0
  • sqlalchemy[asyncio]>=2.0.0
  • asyncpg>=0.29.0

Links

License

MIT

Release files for evoid-postgresql 0.1.1

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 evoid-postgresql 0.1.1
File Interpreter ABI Platform
evoid_postgresql-0.1.1-py3-none-any.whl Python 3 none any Details

Release files / evoid_postgresql-0.1.1-py3-none-any.whl

Download URL evoid_postgresql-0.1.1-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
88085c88c4544c0ed1847568222b7520d58822e0855ea5e6738ead54d6d6b24a
BLAKE2b-256 checksum
How to use checksums
4c86810f10ebca4be291903480bb4c999b11b7a0ab133d1c353ad0ab1e303a47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.2.0

1 release file

0.1.2

1 release file

This release

0.1.1 This release

1 release file

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page