diff --git a/apps/docs/spec/cli_v1_commands.yaml b/apps/docs/spec/cli_v1_commands.yaml index ce3a23aa4ee..0af1323dc4a 100644 --- a/apps/docs/spec/cli_v1_commands.yaml +++ b/apps/docs/spec/cli_v1_commands.yaml @@ -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: [] diff --git a/apps/docs/spec/cli_v1_config.yaml b/apps/docs/spec/cli_v1_config.yaml index ab88a167a6c..5d6ff187e08 100644 --- a/apps/docs/spec/cli_v1_config.yaml +++ b/apps/docs/spec/cli_v1_config.yaml @@ -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'