utils

Documentation

Index

• Constants
• Variables
• func Aqua(str string) string
• func AssertDockerIsRunning() error
• func AssertSupabaseStartIsRunning() error
• func Bold(str string) string
• func DockerExec(ctx context.Context, container string, cmd []string) (io.Reader, error)
• func DockerRemoveAll()
• func DockerRun(ctx context.Context, name string, config *container.Config, ...) (io.Reader, error)
• func GetCurrentBranch() (string, error)
• func GetCurrentTimestamp() string
• func GetGitRoot() (*string, error)
• func IsBranchNameReserved(branch string) bool
• func IsRootDirectory(dir string) bool
• func LoadConfig() error
• func ProcessDiffOutput(p Program, out io.Reader) ([]byte, error)
• func ProcessPsqlOutput(out io.Reader, p Program) error
• func ProcessPullOutput(out io.ReadCloser, p Program) error
• type DiffDependencies
• type DiffEntry
• type FakeProgram
  • func NewFakeProgram(model tea.Model) *FakeProgram
  • func (p *FakeProgram) Quit()
  • func (p *FakeProgram) Send(msg tea.Msg)
  • func (p *FakeProgram) Start() error
• type Program
  • func NewProgram(model tea.Model, opts ...tea.ProgramOption) Program
• type ProgressMsg
• type PsqlMsg
• type StatusMsg

Constants

const (
	GotrueImage   = "supabase/gotrue:v2.5.5"
	RealtimeImage = "supabase/realtime:v0.21.0"
	StorageImage  = "supabase/storage-api:v0.11.0"
)

Update initial schemas in internal/utils/templates/initial_schemas when updating any one of these.

const (
	ShadowDbName   = "supabase_shadow"
	KongImage      = "library/kong:2.1"
	InbucketImage  = "inbucket/inbucket:stable"
	PostgrestImage = "postgrest/postgrest:v9.0.0.20220107"
	DifferImage    = "supabase/pgadmin-schema-diff:cli-0.0.4"
	PgmetaImage    = "supabase/postgres-meta:v0.33.2"
	// TODO: Hardcode version once provided upstream.
	StudioImage = "supabase/studio:latest"

	// https://dba.stackexchange.com/a/11895
	// Args: dbname
	TerminateDbSqlFmt = `` /* 215-byte string literal not displayed */

)

Variables

var (
	Docker = func() *client.Client {
		docker, err := client.NewClientWithOpts(client.WithAPIVersionNegotiation())
		if err != nil {
			fmt.Fprintln(os.Stderr, "Failed to initialize Docker client:", err)
			os.Exit(1)
		}
		return docker
	}()

	ApiPort      string
	InbucketPort string
	DbPort       string
	StudioPort   string
	DbVersion    string
	DbImage      string
	ProjectId    string
	NetId        string
	DbId         string
	KongId       string
	GotrueId     string
	InbucketId   string
	RealtimeId   string
	RestId       string
	StorageId    string
	DifferId     string
	PgmetaId     string
	StudioId     string

	//go:embed templates/globals.sql
	GlobalsSql       string
	InitialSchemaSql string
)

Functions

func Aqua

func Aqua(str string) string

For commands & names.

func AssertDockerIsRunning

func AssertDockerIsRunning() error

func AssertSupabaseStartIsRunning

func AssertSupabaseStartIsRunning() error

func Bold

func Bold(str string) string

For paths & filenames.

func DockerExec

func DockerExec(ctx context.Context, container string, cmd []string) (io.Reader, error)

func DockerRemoveAll

func DockerRemoveAll()

func DockerRun

func DockerRun(
	ctx context.Context,
	name string,
	config *container.Config,
	hostConfig *container.HostConfig,
) (io.Reader, error)

func GetCurrentBranch

func GetCurrentBranch() (string, error)

func GetCurrentTimestamp

func GetCurrentTimestamp() string

func GetGitRoot

func GetGitRoot() (*string, error)

func IsBranchNameReserved

func IsBranchNameReserved(branch string) bool

func IsRootDirectory

func IsRootDirectory(dir string) bool

IsRootDirectory reports whether the string dir is a root directory.

func LoadConfig

func LoadConfig() error

func ProcessDiffOutput

func ProcessDiffOutput(p Program, out io.Reader) ([]byte, error)

func ProcessPsqlOutput

func ProcessPsqlOutput(out io.Reader, p Program) error

func ProcessPullOutput

func ProcessPullOutput(out io.ReadCloser, p Program) error

Types

type DiffDependencies

type DiffDependencies struct {
	Type string `json:"type"`
}

type DiffEntry

type DiffEntry struct {
	Type             string             `json:"type"`
	Status           string             `json:"status"`
	DiffDdl          string             `json:"diff_ddl"`
	GroupName        string             `json:"group_name"`
	Dependencies     []DiffDependencies `json:"dependencies"`
	SourceSchemaName *string            `json:"source_schema_name"`
}

type FakeProgram

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

A dumb text implementation of BubbleTea's Program that allows for output to be piped to another program.

func NewFakeProgram

func NewFakeProgram(model tea.Model) *FakeProgram

func (*FakeProgram) Quit

func (p *FakeProgram) Quit()

func (*FakeProgram) Send

func (p *FakeProgram) Send(msg tea.Msg)

func (*FakeProgram) Start

func (p *FakeProgram) Start() error

type Program

type Program interface {
	Start() error
	Send(msg tea.Msg)
	Quit()
}

An interface describing the parts of BubbleTea's Program that we actually use.

func NewProgram

func NewProgram(model tea.Model, opts ...tea.ProgramOption) Program

type ProgressMsg

type ProgressMsg *float64

type PsqlMsg

type PsqlMsg *string

type StatusMsg

type StatusMsg string