Add OrioleDB extension documentation (#30489)

* Add OrioleDB extension documentation * orioledb docs, reduce linter errors * update project create images --------- Co-authored-by: Oliver Rice <github@oliverrice.com>
supabase · Dec 1, 2024 · 2de1784 · 2de1784
1 parent 1818806
commit 2de1784
Show file tree

Hide file tree

Showing 5 changed files with 147 additions and 0 deletions.
diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
@@ -828,6 +828,16 @@ export const database: NavMenuConstant = {
         },
       ],
     },
+    {
+      name: 'OrioleDB',
+      url: undefined,
+      items: [
+        {
+          name: 'Overview',
+          url: '/guides/database/orioledb',
+        },
+      ],
+    },
     {
       name: 'Access and security',
       url: undefined,

diff --git a/apps/docs/content/guides/database/orioledb.mdx b/apps/docs/content/guides/database/orioledb.mdx
@@ -0,0 +1,137 @@
+---
+id: 'orioledb'
+title: 'OrioleDB Overview'
+description: "A storage extension for PostgreSQL which uses PostgreSQL's pluggable storage system"
+---
+
+The [OrioleDB](https://www.orioledb.com/) Postgres extension provides a drop-in replacement storage engine for the default heap storage method. It is designed to improve Postgres' scalability and performance.
+
+OrioleDB addresses PostgreSQL's scalability limitations by removing bottlenecks in the shared memory cache under high concurrency. It also optimizes write-ahead-log (WAL) insertion through row-level WAL logging. These changes lead to significant improvements in the industry standard TPC-C benchmark, which approximates a real-world transactional workload. The following benchmark was performed on a c7g.metal instance and shows OrioleDB's performance outperforming the default PostgreSQL heap method with a 3.3x speedup.
+
+<Image
+  alt="TPC-C (warehouses = 500)"
+  src="/docs/img/database/orioledb-tpc-c-500-warehouse.png"
+  className="max-w-[550px] !mx-auto border rounded-md"
+  zoomable
+/>
+
+<Admonition type="info">
+
+OrioleDB is in active development and currently has [certain limitations](https://www.orioledb.com/docs/usage/getting-started#current-limitations). Currently, only B-tree indexes are supported, so features like pg_vector's HNSW indexes are not yet available. An Index Access Method bridge to unlock support for all index types used with heap storage is under active development. In the Supabase OrioleDB image the default storage method has been updated to use OrioleDB, granting better performance out of the box.
+
+</Admonition>
+
+## Concepts
+
+### Index-organized tables
+
+OrioleDB uses index-organized tables, where table data is stored in the index structure. This design eliminates the need for separate heap storage, reduces overhead and improves lookup performance for primary key queries.
+
+### No buffer mapping
+
+In-memory pages are connected to the storage pages using direct links. This allows OrioleDB to bypass PostgreSQL's shared buffer pool and eliminate the associated complexity and contention in buffer mapping.
+
+### Undo log
+
+Multi-Version Concurrency Control (MVCC) is implemented using an undo log. The undo log stores previous row versions and transaction information, which enables consistent reads while removing the need for table vacuuming completely.
+
+### Copy-on-write checkpoints
+
+OrioleDB implements copy-on-write checkpoints to persist data efficiently. This approach writes only modified data during a checkpoint, reducing the I/O overhead compared to traditional PostgreSQL checkpointing and allowing row-level WAL logging.
+
+## Usage
+
+### Creating OrioleDB project
+
+You can get started with OrioleDB by enabling the extension in your Supabase dashboard.
+To get started with OrioleDB you need to [create a new Supabase project](https://supabase.com/dashboard/new/_) and choose `OrioleDB Public Alpha` Postgres version.
+
+<Image
+  alt="Creating OrioleDB project"
+  src={{
+    light: '/docs/img/database/orioledb-creating-project--light.png',
+    dark: '/docs/img/database/orioledb-creating-project.png',
+  }}
+  className="max-w-[550px] !mx-auto border rounded-md"
+  zoomable
+/>
+
+### Creating tables
+
+To create a table using the OrioleDB storage engine just execute the standard `CREATE TABLE` statement. By default it will create a table using OrioleDB storage engine. For example:
+
+```sql
+-- Create a table
+create table blog_post (
+  id int8 not null,
+  title text not null,
+  body text not null,
+  author text not null,
+  published_at timestamptz not null default CURRENT_TIMESTAMP,
+  views bigint not null,
+  primary key (id)
+);
+```
+
+### Creating indexes
+
+OrioleDB tables always have a primary key. If it wasn't defined explicitly, a hidden primary key is created using the `ctid` column.
+Additionally you can create secondary indexes.
+
+<Admonition type="info">
+
+Currently, only B-tree indexes are supported, so features like pg_vector's HNSW indexes are not yet available.
+
+</Admonition>
+
+```sql
+-- Create an index
+create index blog_post_published_at on blog_post (published_at);
+
+create index blog_post_views on blog_post (views) where (views > 1000);
+```
+
+### Data manipulation
+
+You can query and modify data in OrioleDB tables using standard SQL statements, including `SELECT`, `INSERT`, `UPDATE`, `DELETE` and `INSERT ... ON CONFLICT`.
+
+```sql
+INSERT INTO blog_post (id, title, body, author, views)
+VALUES (1, 'Hello, World!', 'This is my first blog post.', 'John Doe', 1000);
+
+SELECT * FROM blog_post ORDER BY published_at DESC LIMIT 10;
+ id │     title     │            body             │  author  │         published_at          │ views
+────┼───────────────┼─────────────────────────────┼──────────┼───────────────────────────────┼───────
+  1 │ Hello, World! │ This is my first blog post. │ John Doe │ 2024-11-15 12:04:18.756824+01 │  1000
+```
+
+### Viewing query plans
+
+You can see the execution plan using standard `EXPLAIN` statement.
+
+```sql
+EXPLAIN SELECT * FROM blog_post ORDER BY published_at DESC LIMIT 10;
+                                                 QUERY PLAN
+────────────────────────────────────────────────────────────────────────────────────────────────────────────
+ Limit  (cost=0.15..1.67 rows=10 width=120)
+   ->  Index Scan Backward using blog_post_published_at on blog_post  (cost=0.15..48.95 rows=320 width=120)
+
+EXPLAIN SELECT * FROM blog_post WHERE id = 1;
+                                    QUERY PLAN
+──────────────────────────────────────────────────────────────────────────────────
+ Index Scan using blog_post_pkey on blog_post  (cost=0.15..8.17 rows=1 width=120)
+   Index Cond: (id = 1)
+
+EXPLAIN (ANALYZE, BUFFERS) SELECT * FROM blog_post ORDER BY published_at DESC LIMIT 10;
+                                                                      QUERY PLAN
+──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
+ Limit  (cost=0.15..1.67 rows=10 width=120) (actual time=0.052..0.054 rows=1 loops=1)
+   ->  Index Scan Backward using blog_post_published_at on blog_post  (cost=0.15..48.95 rows=320 width=120) (actual time=0.050..0.052 rows=1 loops=1)
+ Planning Time: 0.186 ms
+ Execution Time: 0.088 ms
+```
+
+## Resources
+
+- [Official OrioleDB documentation](https://www.orioledb.com/docs)
+- [OrioleDB GitHub repository](https://github.com/orioledb/orioledb)
diff --git a/apps/docs/public/img/database/orioledb-creating-project--light.png b/apps/docs/public/img/database/orioledb-creating-project--light.png
diff --git a/apps/docs/public/img/database/orioledb-creating-project.png b/apps/docs/public/img/database/orioledb-creating-project.png
diff --git a/apps/docs/public/img/database/orioledb-tpc-c-500-warehouse.png b/apps/docs/public/img/database/orioledb-tpc-c-500-warehouse.png