mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
docs(cli): document OrioleDB initialization and db.orioledb_version (#50908)
Document `supabase init --use-orioledb` in the CLI reference. Add `db.orioledb_version` to the CLI config reference, and mark `experimental.orioledb_version` as deprecated. This complements the general OrioleDB beta guide update in #50813. Companion CLI PR: https://github.com/supabase/cli/pull/6828, released in [v2.119.0](https://github.com/supabase/cli/releases/tag/v2.119.0). <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Documented the `supabase init --use-orioledb` option, which sets the OrioleDB image version in `supabase/config.toml`. * Added configuration guidance for `db.orioledb_version`, including its PostgreSQL version requirements. * Marked `experimental.orioledb_version` as deprecated and directed users to `db.orioledb_version`. The CLI continues to read the experimental setting and warns when it is set. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
This commit is contained in:
1 parent
4f0be099e7
commit
7b08726d3a
2 files changed
+17
-2
No files matched your search
@@ -2359,6 +2359,8 @@ commands:
|
||||
> You may override the directory path by specifying the `SUPABASE_WORKDIR` environment variable or `--workdir` flag.
|
||||
|
||||
In addition to `config.toml`, the `supabase` directory may also contain other Supabase objects, such as `migrations`, `functions`, `tests`, etc.
|
||||
|
||||
To use OrioleDB as the Postgres storage engine, run `supabase init --use-orioledb`. The command writes the OrioleDB version to `db.orioledb_version` in `supabase/config.toml`.
|
||||
examples:
|
||||
- id: basic-usage
|
||||
name: Basic usage
|
||||
@@ -2368,6 +2370,10 @@ commands:
|
||||
name: Initialize from an existing directory
|
||||
code: supabase init --workdir .
|
||||
response: Finished supabase init.
|
||||
- id: with-orioledb
|
||||
name: Initialize with OrioleDB
|
||||
code: supabase init --use-orioledb
|
||||
response: Finished supabase init.
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
|
||||
@@ -152,6 +152,16 @@ parameters:
|
||||
- name: 'PostgreSQL configuration'
|
||||
link: 'https://postgrest.org/en/stable/configuration.html'
|
||||
|
||||
- id: 'db.orioledb_version'
|
||||
title: 'db.orioledb_version'
|
||||
tags: ['database']
|
||||
required: false
|
||||
description: |
|
||||
OrioleDB version of the Postgres image to use for the local database. Leave empty to use the default storage engine. Requires `db.major_version` 15 or 17. `supabase init --use-orioledb` sets this value.
|
||||
links:
|
||||
- name: 'OrioleDB'
|
||||
link: 'https://supabase.com/docs/guides/database/orioledb'
|
||||
|
||||
- id: 'db.pooler.enabled'
|
||||
title: 'db.pooler.enabled'
|
||||
tags: ['database']
|
||||
@@ -1763,8 +1773,7 @@ parameters:
|
||||
tags: ['experimental']
|
||||
required: false
|
||||
description: |
|
||||
Configures Postgres storage engine to use OrioleDB with S3 support.
|
||||
Note: This is an experimental feature and may change in future releases.
|
||||
Deprecated. Use `db.orioledb_version` instead. The CLI still reads this setting and prints a deprecation warning when it is set.
|
||||
links: []
|
||||
|
||||
- id: 'experimental.s3_host'
|
||||
|
||||
Reference in new issue
Block a user