PostgreSQL protocol for SQLite databases. Turn any SQLite database into a PostgreSQL server that your existing tools and applications can connect to.
⚠️ WARNING: Experimental Project This is an experimental project and is not yet ready for production use. It is under active development and may contain bugs, incomplete features, or breaking changes.
pgsqlite lets you use PostgreSQL tools and libraries with SQLite databases. This is perfect for:
- 🚀 Rapid Testing & CI/CD: Run integration tests without spinning up PostgreSQL. Just copy your SQLite file and go.
- 🌿 Feature Branch Deployments: Each branch gets its own database. Just copy the SQLite file - no complex database provisioning.
- 🤖 AI Agent Development: Multiple agents can work on isolated sandbox environments with zero setup. Clone the database instantly.
- 💻 Local Development: Use your favorite PostgreSQL tools (psql, pgAdmin, DataGrip) with lightweight SQLite storage.
- 🔧 Migration Path: Prototype with SQLite, seamlessly move to PostgreSQL later without changing application code.
# Clone and build from source
git clone https://github.com/erans/pgsqlite
cd pgsqlite
cargo build --release
./target/release/pgsqlite
- Start pgsqlite with a SQLite database:
# Use an existing SQLite database
pgsqlite --database ./my-database.db
# Or start with an in-memory database for testing
pgsqlite --in-memory
- Connect with any PostgreSQL client:
# Using psql
psql -h localhost -p 5432 -d my-database
# Using connection string
psql "postgresql://localhost:5432/my-database"
- Use it just like PostgreSQL:
-- Create tables with PostgreSQL syntax
CREATE TABLE users (
id SERIAL PRIMARY KEY,
email VARCHAR(255) UNIQUE NOT NULL,
created_at TIMESTAMP DEFAULT NOW()
);
-- Insert data
INSERT INTO users (email) VALUES ('user@example.com');
-- Query with PostgreSQL functions
SELECT * FROM users WHERE created_at > NOW() - INTERVAL '7 days';
# Copy your template database for each test run
cp template.db test-1.db
pgsqlite --database test-1.db --port 5433 &
# Run your tests against it
npm test -- --database-url postgresql://localhost:5433/test-1
# Cleanup is just removing the file
rm test-1.db
# Each branch gets its own database copy
cp main.db feature-branch-123.db
pgsqlite --database feature-branch-123.db --port 5433
Python (psycopg2):
import psycopg2
conn = psycopg2.connect(
host="localhost",
port=5432,
database="myapp"
)
Node.js (pg):
const { Client } = require('pg')
const client = new Client({
host: 'localhost',
port: 5432,
database: 'myapp'
})
Any PostgreSQL-compatible ORM: Works with SQLAlchemy, Django ORM, ActiveRecord, Prisma, etc.
# Basic options
pgsqlite \
--database <path> # SQLite database file (default: sqlite.db)
--port <port> # PostgreSQL port (default: 5432)
--in-memory # Use in-memory database
# Security
pgsqlite \
--ssl # Enable SSL/TLS encryption
--ssl-cert <path> # Custom SSL certificate
--ssl-key <path> # Custom SSL key
# Performance
pgsqlite \
--journal-mode WAL # Enable WAL mode for better concurrency
For all configuration options, see the Configuration Reference.
- ✅ Wire Protocol: Full PostgreSQL v3 protocol implementation
- ✅ Clients: Works with psql, pgAdmin, DBeaver, and all PostgreSQL drivers
- ✅ SQL Syntax: Most PostgreSQL queries work without modification
- ✅ Data Types: 40+ PostgreSQL types including SERIAL, JSON, UUID, arrays (stored as JSON)
- ✅ Transactions: Full ACID compliance via SQLite
- Array Types: Full support for PostgreSQL arrays (e.g.,
INTEGER[]
,TEXT[][]
) stored as JSON - ENUM Types:
CREATE TYPE status AS ENUM ('active', 'pending', 'archived')
- RETURNING Clauses:
INSERT INTO users (email) VALUES ('test@example.com') RETURNING id
- CTEs:
WITH
andWITH RECURSIVE
queries - JSON Support:
JSON
andJSONB
types with operators (->
,->>
,@>
,<@
,#>
,#>>
) and functions - Generated Columns:
SERIAL
andBIGSERIAL
auto-increment columns - VARCHAR/CHAR Constraints: Length validation for
VARCHAR(n)
andCHAR(n)
with proper padding - NUMERIC/DECIMAL Constraints: Precision and scale validation for
NUMERIC(p,s)
andDECIMAL(p,s)
- psql Compatibility: Use psql's
\d
and\dt
commands to explore your database
- ❌ Stored procedures and custom functions
- ❌ PostgreSQL-specific system functions (
pg_*
) - ❌ Some advanced data types (ranges, geometric types, full-text search)
- ❌ Array operators and functions (ANY, ALL, @>, unnest, array_agg)
- ❌ Multiple concurrent writers (SQLite allows only one writer at a time)
For detailed compatibility information, see Type Mapping Documentation.
pgsqlite acts as a translation layer between PostgreSQL protocol and SQLite, which does add overhead:
- Best for: Development, testing, prototyping, and single-user applications or low write throughput applications
- Typical overhead: 40-300x vs raw SQLite depending on operation
- Optimizations: Built-in query caching, connection pooling, and prepared statements
- Batch Operations: Multi-row INSERT syntax provides dramatic performance improvements:
- 10-row batches: ~11x faster than single-row INSERTs
- 100-row batches: ~51x faster
- 1000-row batches: ~76x faster
For production use cases with high performance requirements, consider using native PostgreSQL.
- Schema Migrations: Automatic migration system for pgsqlite metadata
- SSL/TLS Setup: Secure connections configuration
- Unix Sockets: Lower latency local connections
- Performance Tuning: Cache configuration and optimization
- Architecture Overview: How pgsqlite works internally
- Array Support: Comprehensive guide to PostgreSQL arrays
- JSON/JSONB Support: Comprehensive guide to JSON functionality
- Future Features: Roadmap for enhanced SQLite capabilities
# Clone the repository
git clone https://github.com/erans/pgsqlite
cd pgsqlite
# Build
cargo build --release
# Run tests
cargo test
# Run with debug logging
RUST_LOG=debug ./target/release/pgsqlite
# Run all test suites
./run_ssl_tests.sh
# Run specific test mode
./run_ssl_tests.sh --mode tcp-ssl --verbose
We welcome contributions! When reporting issues, please include:
- The SQL query that caused the problem
- Expected behavior
- Actual behavior
- Any error messages
See CONTRIBUTING.md for development guidelines.
- Type Mapping Reference - Detailed PostgreSQL to SQLite type mappings
- Configuration Reference - All configuration options
- Architecture Overview - Technical deep dive
- Performance Analysis - Detailed benchmarks and optimization strategies
This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.