pool

type Connection struct {
	DSN      string
	ReadOnly bool
}

type Option func(*Options)

type Options struct {
	Connections []Connection

	MaxOpen     int
	MaxLifetime time.Duration

	PreferSimpleProtocol   bool
	SkipDefaultTransaction bool

	TraceConfig     config.ConfigurationDatabaseTracing
	InsertBatchSize int

	PreparedStatements bool

	// DialectAdapter and TenancyProvider are resolved by NewPool with
	// Postgres defaults when unset. TenancyProviderSet distinguishes
	// "use default" from "explicitly disabled (nil)".
	DialectAdapter     dialect.DialectAdapter
	TenancyProvider    tenancy.Provider
	TenancyProviderSet bool
}

type Pool interface {
	// DB returns a *gorm.DB routed to a writable (readOnly=false) or
	// read-only (readOnly=true) connection. The returned session has
	// tenancy applied at the connection level — callers do not need
	// to filter by tenant_id or partition_id explicitly.
	DB(ctx context.Context, readOnly bool) *gorm.DB

	// AddConnection opens a new physical connection and adds it to the
	// pool. May be called multiple times for read/write replication.
	AddConnection(ctx context.Context, opts ...Option) error

	// CanMigrate reports whether this pool was constructed in a mode
	// that permits running migrations.
	CanMigrate() bool

	// SaveMigration records the supplied patches in the migrations
	// metadata table without applying them.
	SaveMigration(ctx context.Context, migrationPatches ...*migration.Patch) error

	// Migrate finds missing migrations, applies them, and installs
	// tenancy enforcement (via the configured tenancy.Provider) on
	// every enrolled model.
	Migrate(ctx context.Context, migrationsDirPath string, migrations ...any) error

	// Close gracefully shuts down all opened connections.
	Close(ctx context.Context)
}