Skip to main content

A Git-like SQLite database management system with branching and multi-tenancy

Project description

CinchDB

Git-like SQLite database management with branching and multi-tenancy

NOTE: CinchDB is in early alpha. This is project to test out an idea. Do not use this in production.

CinchDB is for projects that need fast queries, data isolated data per-tenant or even per-user, and a branchable database.

On a meta level, I made this because I wanted a database structure that I felt comfortable letting AI agents take full control over, safely, and I didn't want to run my own Postgres instance somewhere or pay for it on e.g. Neon - I don't need hyperscaling, I just need super fast queries.

Because it's so lightweight and its only dependencies are FastAPI, pydantic, requests, and Typer, it is super cheap to run on a small VM like from Fly.io and I don't need to SSH into it to make changes - I can just store an API key in my local projects and hit the remote instance.

uv pip install cinchdb

# Initialize project
cinch init 

# Create and query tables
cinch table create users name:TEXT email:TEXT
cinch query "SELECT * FROM users"

# Git-like branching
cinch branch create feature
cinch branch switch feature
cinch table create products name:TEXT price:REAL
cinch branch merge-into-main feature

# Multi-tenant support
cinch tenant create customer_a
cinch query "SELECT * FROM users" --tenant customer_a

# API server
uv pip install cinchdb[server]
cinch-server serve

# Autogenerate Python SDK from database
cinch codegen generate python cinchdb_models/

What is CinchDB?

CinchDB combines SQLite with Git-like workflows for database schema management:

  • Branch schemas like code - create feature branches, make changes, merge back
  • Multi-tenant isolation - shared schema, isolated data per tenant
  • Automatic change tracking - all schema changes tracked and mergeable
  • Safe structure changes - change merges happen atomically with zero rollback risk (seriously)
  • Remote deployment - FastAPI server with UUID authentication
  • Type-safe SDK - Python and TypeScript SDKs with full type safety
  • API server for remote hosting - Useful for running many web projects
  • SDK generation from database schema - Generate a typesafe SDK from your database models for CRUD operations

Installation

Requires Python 3.10+:

pip install cinchdb

Quick Start

CLI Usage

# Initialize project
cinch init my_app
cd my_app

# Create schema on feature branch
cinch branch create user-system
cinch table create users username:TEXT email:TEXT
cinch view create active_users "SELECT * FROM users WHERE created_at > datetime('now', '-30 days')"

# Merge to main
cinch branch merge-into-main user-system

# Multi-tenant operations
cinch tenant create customer_a
cinch tenant create customer_b
cinch query "SELECT COUNT(*) FROM users" --tenant customer_a

Python SDK

import cinchdb
from cinchdb.models import Column

# Local connection
db = cinchdb.connect("myapp")

# Create schema
db.create_table("posts", [
    Column(name="title", type="TEXT",nullable=False),
    Column(name="content", type="TEXT")
])

# Query data
results = db.query("SELECT * FROM posts WHERE title LIKE ?", ["%python%"])

# CRUD operations
post_id = db.insert("posts", {"title": "Hello World", "content": "First post"})
db.update("posts", post_id, {"content": "Updated content"})

Remote API

# Connect to remote API
db = cinchdb.connect_api("https://api.example.com", "your-api-key", "myapp")

# Same interface as local
results = db.query("SELECT * FROM users")
user_id = db.insert("users", {"username": "alice", "email": "alice@example.com"})

API Server

Start the server:

cinch-server serve --create-key
# Creates API key (works after shutdown as well) and starts server on http://localhost:8000

Interactive docs at /docs, health check at /health.

Architecture

  • Python SDK: Core functionality (local + remote)
  • CLI: Full-featured command-line interface
  • FastAPI Server: REST API with authentication
  • TypeScript SDK: Browser and Node.js client

Development

git clone https://github.com/russellromney/cinchdb.git
cd cinchdb
make install-all
make test

Future

Though probably not, perhaps I'll evolve it into something bigger and more full-featured, with things like

  • data backups
  • replication to S3
  • audit access
  • SaaS-like dynamics
  • multi-project hosting
  • auth proxying
  • leader-follower abilities for edge deployment

License

Apache 2.0 - see LICENSE


CinchDB - Database management as easy as version control

Project details


Download files

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

Source Distribution

cinchdb-0.1.1.tar.gz (74.6 kB view details)

Uploaded Source

Built Distribution

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

cinchdb-0.1.1-py3-none-any.whl (109.9 kB view details)

Uploaded Python 3

File details

Details for the file cinchdb-0.1.1.tar.gz.

File metadata

  • Download URL: cinchdb-0.1.1.tar.gz
  • Upload date:
  • Size: 74.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.0

File hashes

Hashes for cinchdb-0.1.1.tar.gz
Algorithm Hash digest
SHA256 effaa7e868424c3878f54eb6db3bb39876672308b1dbf8f0aa74e42a66be51a9
MD5 4c34c0e3388779af66eae77e13f83a26
BLAKE2b-256 b93c405458935df8dc0a54466818ce03ea762b83ce12ac4b1e5c5839d34de356

See more details on using hashes here.

File details

Details for the file cinchdb-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cinchdb-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 109.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.0

File hashes

Hashes for cinchdb-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f4faea7bc04e5b1e239e28356e710eae7d3317e9ba34941ae7d1398984618115
MD5 0752a7cc3d1018b10c3f9f9b266197a8
BLAKE2b-256 ffccbd2d332d475435b94ca405bdf7d55879befd798f8fea0938054abdf6b037

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