dbsync-py 1.0.0.dev5

Python helper package for interacting with Cardano DB Sync databases

dbsync-py

Python helper package for interacting with Cardano DB Sync databases.

This package provides SQLModel-based ORM models and utilities for interacting with Cardano DB Sync PostgreSQL databases, enabling type-safe access to Cardano blockchain data.

Installation

pip install dbsync-py

Configuration

dbsync-py supports multiple ways to configure database connections:

Option 1: Environment File (.env)

Copy sample.env to .env and modify the values:

cp sample.env .env
# Edit .env with your database configuration

Option 2: Environment Variables

Set environment variables directly:

export DBSYNC_HOST=localhost
export DBSYNC_PORT=5432
export DBSYNC_DATABASE=cexplorer
export DBSYNC_USERNAME=your_username
export DBSYNC_PASSWORD=your_password

Option 3: Complete Database URL

export DBSYNC_DATABASE_URL=postgresql://username:password@localhost:5432/cexplorer

Quick Start

import dbsync_py

# Test database connection
from dbsync_py.utils import quick_connection_check
if quick_connection_check():
    print("✅ Database connection successful!")
else:
    print("❌ Database connection failed")

# Use database sessions
from dbsync_py.session import get_session_context
with get_session_context() as session:
    result = session.execute("SELECT version()")
    print(result.scalar())

Development Status

This project is currently in development. Core database connection utilities are implemented.

License

Apache-2.0