Skip to content

feat: add flag to skip linking pooler #4319

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
merged 1 commit into from
Oct 16, 2025
+37 −21
Merged

feat: add flag to skip linking pooler #4319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion cmd/db.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ func init() {
dumpFlags := dbDumpCmd.Flags()
dumpFlags.BoolVar(&dryRun, "dry-run", false, "Prints the pg_dump script that would be executed.")
dumpFlags.BoolVar(&dataOnly, "data-only", false, "Dumps only data records.")
dumpFlags.BoolVar(&useCopy, "use-copy", false, "Uses copy statements in place of inserts.")
dumpFlags.BoolVar(&useCopy, "use-copy", false, "Use copy statements in place of inserts.")
dumpFlags.StringSliceVarP(&excludeTable, "exclude", "x", []string{}, "List of schema.tables to exclude from data-only dump.")
dumpFlags.BoolVar(&roleOnly, "role-only", false, "Dumps only cluster roles.")
dbDumpCmd.MarkFlagsMutuallyExclusive("role-only", "data-only")
Expand Down
5 changes: 4 additions & 1 deletion cmd/link.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import (
)

var (
skipPooler bool

linkCmd = &cobra.Command{
GroupID: groupLocalDev,
Use: "link",
Expand All @@ -35,7 +37,7 @@ var (
}
// TODO: move this to root cmd
cobra.CheckErr(viper.BindPFlag("DB_PASSWORD", cmd.Flags().Lookup("password")))
return link.Run(ctx, flags.ProjectRef, fsys)
return link.Run(ctx, flags.ProjectRef, skipPooler, fsys)
},
}
)
Expand All @@ -44,6 +46,7 @@ func init() {
linkFlags := linkCmd.Flags()
linkFlags.StringVar(&flags.ProjectRef, "project-ref", "", "Project ref of the Supabase project.")
linkFlags.StringVarP(&dbPassword, "password", "p", "", "Password to your remote Postgres database.")
linkFlags.BoolVar(&skipPooler, "skip-pooler", false, "Use direct connection instead of pooler.")
// For some reason, BindPFlag only works for StringVarP instead of StringP
rootCmd.AddCommand(linkCmd)
}
2 changes: 1 addition & 1 deletion internal/bootstrap/bootstrap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func Run(ctx context.Context, starter StarterTemplate, fsys afero.Fs, options ..
if err := flags.LoadConfig(fsys); err != nil {
return err
}
link.LinkServices(ctx, flags.ProjectRef, tenant.NewApiKey(keys).Anon, fsys)
link.LinkServices(ctx, flags.ProjectRef, tenant.NewApiKey(keys).Anon, false, fsys)
if err := utils.WriteFile(utils.ProjectRefPath, []byte(flags.ProjectRef), fsys); err != nil {
return err
}
Expand Down
43 changes: 28 additions & 15 deletions internal/link/link.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"github.com/supabase/cli/pkg/queue"
)

func Run(ctx context.Context, projectRef string, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
func Run(ctx context.Context, projectRef string, skipPooler bool, fsys afero.Fs, options ...func(*pgx.ConnConfig)) error {
majorVersion := utils.Config.Db.MajorVersion
if err := checkRemoteProjectStatus(ctx, projectRef, fsys); err != nil {
return err
Expand All @@ -33,7 +33,7 @@ func Run(ctx context.Context, projectRef string, fsys afero.Fs, options ...func(
if err != nil {
return err
}
LinkServices(ctx, projectRef, keys.ServiceRole, fsys)
LinkServices(ctx, projectRef, keys.ServiceRole, skipPooler, fsys)

// 2. Check database connection
config := flags.NewDbConfigWithPassword(ctx, projectRef)
Expand All @@ -58,21 +58,35 @@ major_version = %d
return nil
}

func LinkServices(ctx context.Context, projectRef, serviceKey string, fsys afero.Fs) {
func LinkServices(ctx context.Context, projectRef, serviceKey string, skipPooler bool, fsys afero.Fs) {
jq := queue.NewJobQueue(5)
logger := utils.GetDebugLogger()
fmt.Fprintln(logger, jq.Put(func() error { return linkDatabaseSettings(ctx, projectRef) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkNetworkRestrictions(ctx, projectRef) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkPostgrest(ctx, projectRef) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkGotrue(ctx, projectRef) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkStorage(ctx, projectRef) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkPooler(ctx, projectRef, fsys) }))
api := tenant.NewTenantAPI(ctx, projectRef, serviceKey)
fmt.Fprintln(logger, jq.Put(func() error { return linkPostgrestVersion(ctx, api, fsys) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkGotrueVersion(ctx, api, fsys) }))
fmt.Fprintln(logger, jq.Put(func() error { return linkStorageVersion(ctx, api, fsys) }))
jobs := []func() error{
func() error { return linkDatabaseSettings(ctx, projectRef) },
func() error { return linkNetworkRestrictions(ctx, projectRef) },
func() error { return linkPostgrest(ctx, projectRef) },
func() error { return linkGotrue(ctx, projectRef) },
func() error { return linkStorage(ctx, projectRef) },
func() error {
if skipPooler {
return fsys.RemoveAll(utils.PoolerUrlPath)
}
return linkPooler(ctx, projectRef, fsys)
},
func() error { return linkPostgrestVersion(ctx, api, fsys) },
func() error { return linkGotrueVersion(ctx, api, fsys) },
func() error { return linkStorageVersion(ctx, api, fsys) },
}
// Ignore non-fatal errors linking services
fmt.Fprintln(logger, jq.Collect())
logger := utils.GetDebugLogger()
for _, job := range jobs {
if err := jq.Put(job); err != nil {
fmt.Fprintln(logger, err)
}
}
if err := jq.Collect(); err != nil {
fmt.Fprintln(logger, err)
}
}

func linkPostgrest(ctx context.Context, projectRef string) error {
Expand Down Expand Up @@ -129,7 +143,6 @@ func linkStorageVersion(ctx context.Context, api tenant.TenantAPI, fsys afero.Fs
if err != nil {
return err
}
fmt.Fprintln(os.Stderr, version)
return utils.WriteFile(utils.StorageVersionPath, []byte(version), fsys)
}

Expand Down
6 changes: 3 additions & 3 deletions internal/link/link_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ func TestLinkCommand(t *testing.T) {
Reply(200).
BodyString(storage)
// Run test
err := Run(context.Background(), project, fsys, conn.Intercept)
err := Run(context.Background(), project, false, fsys, conn.Intercept)
// Check error
assert.NoError(t, err)
assert.Empty(t, apitest.ListUnmatchedRequests())
Expand Down Expand Up @@ -192,7 +192,7 @@ func TestLinkCommand(t *testing.T) {
Get("/storage/v1/version").
ReplyError(errors.New("network error"))
// Run test
err := Run(context.Background(), project, fsys, func(cc *pgx.ConnConfig) {
err := Run(context.Background(), project, false, fsys, func(cc *pgx.ConnConfig) {
cc.LookupFunc = func(ctx context.Context, host string) (addrs []string, err error) {
return nil, errors.New("hostname resolving error")
}
Expand Down Expand Up @@ -269,7 +269,7 @@ func TestLinkCommand(t *testing.T) {
Get("/v1/projects").
ReplyError(errors.New("network error"))
// Run test
err := Run(context.Background(), project, fsys, conn.Intercept)
err := Run(context.Background(), project, false, fsys, conn.Intercept)
// Check error
assert.ErrorContains(t, err, "operation not permitted")
assert.Empty(t, apitest.ListUnmatchedRequests())
Expand Down