Skip to content

fix(decalrative): change default declarative/ folder to database/ #5057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avallete merged 5 commits into from
Apr 10, 2026
Merged

fix(decalrative): change default declarative/ folder to database/ #5057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
14a25fa
fix(decalrative): change default declarative/ folder to database/
avallete Apr 9, 2026
8f2d51d
Merge branch 'develop' into fix/rename-default-declarative-dir-to-dat…
avallete Apr 10, 2026
90d022c
fix: rename from database to schemas
avallete Apr 9, 2026
cf7136f
fix: capture declarative cmds telemetry
avallete Apr 10, 2026
cc8aa79
Revert "fix: rename from database to schemas"
avallete Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions cmd/db_schema_declarative.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,21 @@ var (
// so in the rest of the code we can know that we're running pg-delta logic.
if viper.GetBool("EXPERIMENTAL") && !utils.IsPgDeltaEnabled() {
utils.Config.Experimental.PgDelta = &config.PgDeltaConfig{Enabled: true}
return nil
}
if utils.IsPgDeltaEnabled() {
return nil
if !utils.IsPgDeltaEnabled() {
utils.CmdSuggestion = fmt.Sprintf("Either pass %s or add %s with %s to %s",
utils.Aqua("--experimental"),
utils.Aqua("[experimental.pgdelta]"),
utils.Aqua("enabled = true"),
utils.Bold(utils.ConfigPath))
return errors.New("declarative commands require --experimental flag or pg-delta enabled in config")
}
utils.CmdSuggestion = fmt.Sprintf("Either pass %s or add %s with %s to %s",
utils.Aqua("--experimental"),
utils.Aqua("[experimental.pgdelta]"),
utils.Aqua("enabled = true"),
utils.Bold(utils.ConfigPath))
return errors.New("declarative commands require --experimental flag or pg-delta enabled in config")
// If the config.toml has [experimental.pgdelta] enabled = true, set the EXPERIMENTAL flag to true
// so the follow-up PersistentPreRunE can run the pg-delta logic.
if utils.Config.Experimental.PgDelta.Enabled {
viper.Set("EXPERIMENTAL", true)
}
return cmd.Root().PersistentPreRunE(cmd, args)
Copy link
Copy Markdown
Member Author

@avallete avallete Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note

This needs to be called so the telemetry can capture this command runs.

},
}

Expand Down
2 changes: 1 addition & 1 deletion docs/templates/examples.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ supabase-db-schema-declarative-sync:
Reset local database to match migrations first? (local data will be lost) [y/N] y
Resetting database...
...
Declarative schema written to supabase/declarative
Declarative schema written to supabase/database
Finished supabase db schema declarative generate.
supabase-test-db:
- id: basic-usage
Expand Down
2 changes: 1 addition & 1 deletion internal/db/declarative/declarative_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func TestWriteDeclarativeSchemas(t *testing.T) {

cfg, err := afero.ReadFile(fsys, utils.ConfigPath)
require.NoError(t, err)
assert.Contains(t, string(cfg), `"declarative"`)
assert.Contains(t, string(cfg), `"database"`)
}

func TestTryCacheMigrationsCatalogWritesPrefixedCache(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion internal/utils/misc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ var (
CurrBranchPath = filepath.Join(SupabaseDirPath, ".branches", "_current_branch")
// DeclarativeDir is the canonical location for pg-delta declarative schema
// files generated or synced by `supabase db schema declarative` commands.
DeclarativeDir = filepath.Join(SupabaseDirPath, "declarative")
DeclarativeDir = filepath.Join(SupabaseDirPath, "database")
ClusterDir = filepath.Join(SupabaseDirPath, "cluster")
SchemasDir = filepath.Join(SupabaseDirPath, "schemas")
MigrationsDir = filepath.Join(SupabaseDirPath, "migrations")
Expand Down
2 changes: 1 addition & 1 deletion pkg/config/templates/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,6 @@ s3_secret_key = "env(S3_SECRET_KEY)"
# When enabled, pg-delta becomes the active engine for supported schema flows.
# enabled = false
# Directory under `supabase/` where declarative files are written.
# declarative_schema_path = "./declarative"
# declarative_schema_path = "./database"
# JSON string passed through to pg-delta SQL formatting.
# format_options = "{\"keywordCase\":\"upper\",\"indent\":2,\"maxWidth\":80,\"commaStyle\":\"trailing\"}"
Loading