config

type AddressFamily ¶

type AddressFamily string

const (
	AddressIPv6 AddressFamily = "IPv6"
	AddressIPv4 AddressFamily = "IPv4"
)

func (f *AddressFamily) UnmarshalText(text []byte) error

type Algorithm ¶

type Algorithm string

const (
	AlgRS256 Algorithm = "RS256"
	AlgES256 Algorithm = "ES256"
)

func (p *Algorithm) UnmarshalText(text []byte) error

type BucketConfig ¶

type BucketConfig map[string]bucket

type CaptchaProvider ¶

type CaptchaProvider string

const (
	HCaptchaProvider  CaptchaProvider = "hcaptcha"
	TurnstileProvider CaptchaProvider = "turnstile"
)

func (p *CaptchaProvider) UnmarshalText(text []byte) error

type Config ¶

type Config *config

type ConfigEditor ¶

type ConfigEditor func(Config)

func WithHostname(hostname string) ConfigEditor

type ConfigUpdater ¶

type ConfigUpdater struct {
	// contains filtered or unexported fields
}

func NewConfigUpdater(client v1API.ClientWithResponses) ConfigUpdater

func (u *ConfigUpdater) UpdateApiConfig(ctx context.Context, projectRef string, c api, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateAuthConfig(ctx context.Context, projectRef string, c auth, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateDbConfig(ctx context.Context, projectRef string, c db, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateDbNetworkRestrictionsConfig(ctx context.Context, projectRef string, n networkRestrictions, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateDbSettingsConfig(ctx context.Context, projectRef string, s settings, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateExperimentalConfig(ctx context.Context, projectRef string, exp experimental, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateRemoteConfig(ctx context.Context, remote baseConfig, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateSigningKeys(ctx context.Context, projectRef string, signingKeys []JWK, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateSslEnforcement(ctx context.Context, projectRef string, s sslEnforcement, filter ...func(string) bool) error

func (u *ConfigUpdater) UpdateStorageConfig(ctx context.Context, projectRef string, c storage, filter ...func(string) bool) error

type CustomClaims ¶

type CustomClaims struct {
	// Overrides Issuer to maintain json order when marshalling
	Issuer string `json:"iss,omitempty"`
	Ref    string `json:"ref,omitempty"`
	Role   string `json:"role"`
	IsAnon bool   `json:"is_anonymous,omitempty"`
	jwt.RegisteredClaims
}

func (c CustomClaims) NewToken() *jwt.Token

type FunctionConfig ¶

type FunctionConfig map[string]function

We follow these rules when adding new config:

1. Update init_config.toml (and init_config.test.toml) with the new key, default value, and comments to explain usage.
2. Update config struct with new field and toml tag (spelled in snake_case).
3. Add custom field validations to LoadConfigFS function for eg. integer range checks.

If you are adding new user defined secrets, such as OAuth provider secret, the default value in init_config.toml should be an env var substitution. For example,

> secret = "env(SUPABASE_AUTH_EXTERNAL_APPLE_SECRET)"

Default values for internal configs should be added to `var Config` initializer.

type Glob ¶

type Glob []string

func (g Glob) Files(fsys fs.FS) ([]string, error)

type JWK ¶

type JWK struct {
	KeyType     string    `toml:"kty" json:"kty"`
	KeyID       string    `toml:"kid,omitempty" json:"kid,omitempty"`
	Use         string    `toml:"use,omitempty" json:"use,omitempty"`
	KeyOps      []string  `toml:"key_ops,omitempty" json:"key_ops,omitempty"`
	Algorithm   Algorithm `toml:"alg,omitempty" json:"alg,omitempty"`
	Extractable *bool     `toml:"ext,omitempty" json:"ext,omitempty"`
	// RSA specific fields
	Modulus  string `toml:"n,omitempty" json:"n,omitempty"`
	Exponent string `toml:"e,omitempty" json:"e,omitempty"`
	// RSA private key fields
	PrivateExponent         string `toml:"d,omitempty" json:"d,omitempty"`
	FirstPrimeFactor        string `toml:"p,omitempty" json:"p,omitempty"`
	SecondPrimeFactor       string `toml:"q,omitempty" json:"q,omitempty"`
	FirstFactorCRTExponent  string `toml:"dp,omitempty" json:"dp,omitempty"`
	SecondFactorCRTExponent string `toml:"dq,omitempty" json:"dq,omitempty"`
	FirstCRTCoefficient     string `toml:"qi,omitempty" json:"qi,omitempty"`
	// EC specific fields
	Curve string `toml:"crv,omitempty" json:"crv,omitempty"`
	X     string `toml:"x,omitempty" json:"x,omitempty"`
	Y     string `toml:"y,omitempty" json:"y,omitempty"`
}

func (j JWK) ToPublicJWK() JWK

type LogflareBackend ¶

type LogflareBackend string

const (
	LogflarePostgres LogflareBackend = "postgres"
	LogflareBigQuery LogflareBackend = "bigquery"
)

func (b *LogflareBackend) UnmarshalText(text []byte) error

type OAuthServer ¶

type OAuthServer struct {
	Enabled                  bool   `toml:"enabled" json:"enabled"`
	AllowDynamicRegistration bool   `toml:"allow_dynamic_registration" json:"allow_dynamic_registration"`
	AuthorizationUrlPath     string `toml:"authorization_url_path" json:"authorization_url_path"`
}

type PasswordRequirements ¶

type PasswordRequirements string

const (
	NoRequirements                 PasswordRequirements = ""
	LettersDigits                  PasswordRequirements = "letters_digits"
	LowerUpperLettersDigits        PasswordRequirements = "lower_upper_letters_digits"
	LowerUpperLettersDigitsSymbols PasswordRequirements = "lower_upper_letters_digits_symbols"
)

func NewPasswordRequirement(c v1API.UpdateAuthConfigBodyPasswordRequiredCharacters) PasswordRequirements

func (r PasswordRequirements) ToChar() v1API.UpdateAuthConfigBodyPasswordRequiredCharacters

func (r *PasswordRequirements) UnmarshalText(text []byte) error

type PgDeltaConfig ¶

type PgDeltaConfig struct {
	Enabled               bool   `toml:"enabled" json:"enabled"`
	DeclarativeSchemaPath string `toml:"declarative_schema_path" json:"declarative_schema_path"`
	FormatOptions         string `toml:"format_options" json:"format_options"`
	// NpmVersion is set from .temp/pgdelta-version during Load (not from TOML).
	NpmVersion string `toml:"-" json:"-"`
}

We follow these rules when adding new config:

1. Update init_config.toml (and init_config.test.toml) with the new key, default value, and comments to explain usage.
2. Update config struct with new field and toml tag (spelled in snake_case).
3. Add custom field validations to LoadConfigFS function for eg. integer range checks.

If you are adding new user defined secrets, such as OAuth provider secret, the default value in init_config.toml should be an env var substitution. For example,

> secret = "env(SUPABASE_AUTH_EXTERNAL_APPLE_SECRET)"

Default values for internal configs should be added to `var Config` initializer.

type PoolMode ¶

type PoolMode string

const (
	TransactionMode PoolMode = "transaction"
	SessionMode     PoolMode = "session"
)

func (m *PoolMode) UnmarshalText(text []byte) error

type RequestPolicy ¶

type RequestPolicy string

const (
	PolicyPerWorker RequestPolicy = "per_worker"
	PolicyOneshot   RequestPolicy = "oneshot"
)

func (p *RequestPolicy) UnmarshalText(text []byte) error

type Secret ¶

type Secret struct {
	Value  string
	SHA256 string
}

func (s *Secret) Decrypt(keys []string) error

func (s Secret) MarshalText() (text []byte, err error)

type SecretsConfig ¶

type SecretsConfig map[string]Secret

We follow these rules when adding new config:

1. Update init_config.toml (and init_config.test.toml) with the new key, default value, and comments to explain usage.
2. Update config struct with new field and toml tag (spelled in snake_case).
3. Add custom field validations to LoadConfigFS function for eg. integer range checks.

If you are adding new user defined secrets, such as OAuth provider secret, the default value in init_config.toml should be an env var substitution. For example,

> secret = "env(SUPABASE_AUTH_EXTERNAL_APPLE_SECRET)"

Default values for internal configs should be added to `var Config` initializer.

type SessionReplicationRole ¶

type SessionReplicationRole string

const (
	SessionReplicationRoleOrigin  SessionReplicationRole = "origin"
	SessionReplicationRoleReplica SessionReplicationRole = "replica"
	SessionReplicationRoleLocal   SessionReplicationRole = "local"
)

func (r *SessionReplicationRole) UnmarshalText(text []byte) error