KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

orioledb

★ 4,164 Open GitHub ↗

OrioleDB – building a modern cloud-native storage engine (... and solving some PostgreSQL wicked problems)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OrioleDB – a cloud-native storage engine for PostgreSQL
(A solution to PostgreSQL’s wicked problems)

[![check status](https://github.com/orioledb/orioledb/actions/workflows/check.yml/badge.svg)](https://github.com/orioledb/orioledb/actions)
[![Coverage Status](https://coveralls.io/repos/github/orioledb/orioledb/badge.svg?branch=main)](https://coveralls.io/github/orioledb/orioledb?branch=main)
[![dockerhub](https://github.com/orioledb/orioledb/actions/workflows/docker.yml/badge.svg)](https://hub.docker.com/r/orioledb/orioledb/tags)

OrioleDB is pronounced as _OR-ee-ohl-DEE-BEE_ (IPA _/ˈɔːr.i.oʊl diː biː/_) and
is named after the [golden oriole](https://en.wikipedia.org/wiki/Golden_oriole),
a bird which inhabits a range of habitats and migrates in spring symbolizing renewal.

OrioleDB is a new storage engine for PostgreSQL, bringing a modern approach to
database capacity, capabilities and performance to the world's most-loved
database platform.

OrioleDB consists of an extension, building on the innovative table access
method framework and other standard Postgres extension interfaces. By extending
and enhancing the current table access methods, OrioleDB opens the door to
a future of more powerful storage models that are optimized for cloud and
modern hardware architectures.

1. Designed for modern hardware.  OrioleDB design avoids legacy CPU bottlenecks
   on modern servers containing dozens and hundreds CPU cores, providing
   optimized usage of modern storage technologies such as SSD and NVRAM.

2. Reduced maintenance needs.  OrioleDB implements the concepts of undo log
   and page-mergins, eliminating the need for dedicated garbage collection
   processes.  Additionally, OrioleDB implements default 64-bit transaction
   identifiers, thus eliminating the well-known and painful wraparound problem.

3. Designed to be distributed.  OrioleDB implements a row-level write-ahead
   log with support for parallel apply.  This log architecture is optimized
   for raft consensus-based replication allowing the implementation of
   active-active multimaster.

The key technical differentiations of OrioleDB are as follows:

1. No buffer mapping and lock-less page reading.  In-memory pages in OrioleDB
   are connected with direct links to the storage pages.  This eliminates the
   need for in-buffer mapping along with its related bottlenecks. Additionally,
   in OrioleDB in-memory page reading doesn't involve atomic operations.
   Together, these design decisions bring vertical scalability for Postgres
   to the whole new level.

2. MVCC is based on the UNDO log concept.  In OrioleDB, old versions of tuples
   do not cause bloat in the main storage system, but eviction into the undo
   log comprising undo chains.  Page-level undo records allow the system
   to easily reclaim space occupied by deleted tuples as soon as possible.
   Together with page-mergins, these mechanisms eliminate bloat in the majority
   of cases.  Dedicated VACUUMing of tables is not needed as well, removing
   a significant and common cause of system performance deterioration and
   database outages.

3. Copy-on-write checkpoints and row-level WAL.  OrioleDB utilizes
   copy-on-write checkpoints, which provides a structurally consistent snapshot
   of data every moment of time.  This is friendly for modern SSDs and allows
   row-level WAL logging.  In turn, row-level WAL logging is easy to
   parallelize (done), compact and suitable for active-active
   multimaster (planned).

See [introduction](doc/intro.mdx), [getting started](doc/usage/getting-started.mdx), and [architecture](doc/architecture/overview.mdx)
 documentation as well as
[PostgresBuild 2021 slides](https://www.slideshare.net/AlexanderKorotkov/solving-postgresql-wicked-problems).  To start the development see [OrioleDB development quickstart](doc/contributing/local-builds.mdx), and [project structure](doc/contributing/structure.mdx).

## License

OrioleDB is dual-licensed under the Apache License 2.0 and the PostgreSQL License.

You may choose either license to govern your use of this work.
1. [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
2. [PostgreSQL License](https://www.postgresql.org/about/licence/)

`SPDX-License-Identifier: Apache-2.0 OR PostgreSQL`

All contributions to OrioleDB are made under both the Apache License 2.0 and
the PostgreSQL License.

See [LICENSE-APACHE.txt](./LICENSE-APACHE.txt) and
[LICENSE-POSTGRESQL.txt](./LICENSE-POSTGRESQL.txt) for details.

**Patent Grant:**. Supabase provides a separate patent grant for OrioleDB.
See [PATENTS.txt](./PATENTS.txt) for details.

## Status

OrioleDB now has public beta status.  It is recommended for experiments,
testing, benchmarking, etc., but is not recommended for production usage.
If you are interested in OrioleDB's benefits in production, please
[contact us](mailto:sales@orioledb.com).

## Installation

### Use docker container

We provide docker images for `amd64` and `arm64v8` architectures under Alpine Linux.

```
docker pull orioledb/orioledb:latest-pg17
```
For example it can be started same as postgres server:
```bash
# !Don't forget to set default locale to C, POSIX or use icu-locale
docker run --name some-postgres -e POSTGRES_PASSWORD=... -e POSTGRES_INITDB_ARGS="--locale=C" -d -p5432:5432 orioledb/orioledb:latest-pg17
```

See [our dockerhub](https://hub.docker.com/r/orioledb/orioledb) for details on our docker container usage.  See [the docker build guide](doc/contributing/docker-builds.mdx) for information on how to build the docker images locally.

### Build from source

Before building and installing OrioleDB, one should ensure to have the following:

* [PostgreSQL with extensibility patches](https://github.com/orioledb/postgres) checked out at the exact commit/tag listed for your major version in [`.pgtags`](.pgtags) (`16: …` and `17: …`).  The build verifies this and refuses to compile against any other patchset.
 * Development package of libzstd;
 * python 3.5+ with testgres package.

Typical installation procedure may look like this:

```bash
 # 1. Clone this repo first -- .pgtags pins the exact patched-PostgreSQL
 # commit you must build against.
 $ git clone https://github.com/orioledb/orioledb
 $ cd orioledb
 $ cat .pgtags
 17: 7050019fd74d0d841040edc49ee1e16364a8b589
 16: e5ef9e6a6d21f8e69e1d4bddcd4cdb83f054ca0b

# 2. Build patched PostgreSQL at the commit listed for your major
 # version (substitute the value from .pgtags, do not copy-paste this
 # one -- it moves).
 $ cd ..
 $ git clone https://github.com/orioledb/postgres orioledb-postgres
 $ cd orioledb-postgres
 $ git checkout $(awk -F': ' '/^17: /{print $2}' ../orioledb/.pgtags)
 $ ./configure --prefix=/path/to/pg --enable-debug --enable-cassert --with-icu
 $ make -j install
 $ make -C contrib -j install
 $ export PATH=/path/to/pg/bin:$PATH

# 3. Build the extension.
 $ cd ../orioledb
 # IS_DEV=1 is required for `make installcheck` to actually run the tests
 $ make USE_PGXS=1 IS_DEV=1
 $ make USE_PGXS=1 IS_DEV=1 install
 $ make USE_PGXS=1 IS_DEV=1 installcheck
```

If the configured PostgreSQL is at the wrong commit, the build prints

```
Wrong orioledb patchset version: expected <hash>, got <hash>
Rebuild and install patched orioledb/postgres using commit '<hash>'
```

— in that case re-check out `orioledb-postgres` at the commit from `.pgtags` and rebuild it.

Before starting working with OrioleDB, adding the following line to
`postgresql.conf` is required.  This change requires a restart of
the PostgreSQL database server.

```
shared_preload_libraries = 'orioledb.so'
```

## Collations
OrioleDB tables support only ICU, C, and POSIX collations.

So that you don't have to write COLLATE for every "text" field of tables you have options:
### Create whole cluster with one of these collations:
```bash
initdb --locale=C -D..
# OR
initdb --locale=POSIX -D..
# OR
initdb --locale-provider=icu --icu-locale=en -D...
```

### Create new database with default collation from template0
```bash
createdb --locale=C --template template0 ...
# OR
createdb --locale=POSIX --template template0 ...
# OR
createdb --locale-provider=icu --icu-locale=en --template template0 ...
```
Or using `CREATE DATABASE` with `LOCALE` or `ICU_LOCALE` parameters.

## Setup

Run the following SQL query on the database to enable the OrioleDB engine.

```sql
CREATE EXTENSION orioledb;
```

Once the above steps are complete, you can start using OrioleDB's tables.
See [getting started](doc/usage/getting-started.mdx) documentation for details.

```sql
CREATE TABLE table_name (...) USING orioledb;
```

orioledb

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README