Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.6 KB

README.md

File metadata and controls

44 lines (30 loc) · 2.6 KB

Oliphaunt

PostgreSQL inside your application

Oliphaunt embeds PostgreSQL 18 in desktop, mobile, and browser applications. Use PostgreSQL SQL, types, transactions, and extensions through an SDK for your language, without setting up a separate database service.

Get started

Choose the SDK for your application. Each quickstart covers installation, a complete query, and persistent storage.

Application SDK Package
Rust and Tauri Rust oliphaunt
Node.js, Bun, Deno, Electron TypeScript @oliphaunt/ts
iOS and macOS Swift Oliphaunt
Android Kotlin dev.oliphaunt:oliphaunt-android
React Native and Expo native builds React Native @oliphaunt/react-native
Browsers and JavaScript runtimes using WebAssembly WASIX TypeScript @oliphaunt/wasix-ts
Rust using WebAssembly WASIX Rust oliphaunt-wasix
C, C++, and language bindings C ABI liboliphaunt

How it works

An embedded handle owns one PostgreSQL session. Bind parameters, query rows, and use callback transactions through the SDK. Choose persistent storage to keep data between application runs.

Native Rust and desktop TypeScript also offer a broker process and a local PostgreSQL server. Server mode supports standard drivers, ORMs, and independent client sessions. Browser applications use the WASIX TypeScript Worker integration.

Select extensions before opening a database, then enable them with SQL such as CREATE EXTENSION vector. Package only the native resources your application needs. Runtime and extension versions have their own compatibility requirements.

Documentation

Contributing

See CONTRIBUTING.md for development setup and the maintainer index for architecture, testing, and release procedures.

Oliphaunt is licensed under MIT.