Help us shape the future of Go! Take the 2026 Go Developer Survey

branch

package
v0.328.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 28, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BranchCmd 

func BranchCmd(ch *cmdutil.Helper) *cobra.Command

BranchCmd handles the branching of a database.

func ConnectionsCmd added in v0.290.0 

func ConnectionsCmd(ch *cmdutil.Helper) *cobra.Command

ConnectionsCmd manages branch connections across supported database engines.

func ConnectionsKillCmd added in v0.290.0 

func ConnectionsKillCmd(ch *cmdutil.Helper) *cobra.Command

func ConnectionsKillTransactionCmd added in v0.290.0 

func ConnectionsKillTransactionCmd(ch *cmdutil.Helper) *cobra.Command

func ConnectionsShowCmd added in v0.290.0 

func ConnectionsShowCmd(ch *cmdutil.Helper) *cobra.Command

func CreateCmd added in v0.9.0 

func CreateCmd(ch *cmdutil.Helper) *cobra.Command

func DeleteCmd 

func DeleteCmd(ch *cmdutil.Helper) *cobra.Command

func DeleteQueryPatternsCmd added in v0.323.0 

func DeleteQueryPatternsCmd(ch *cmdutil.Helper) *cobra.Command

func DemoteCmd added in v0.131.0 

func DemoteCmd(ch *cmdutil.Helper) *cobra.Command

func DiffCmd added in v0.21.0 

func DiffCmd(ch *cmdutil.Helper) *cobra.Command

DiffCmd is the command for showing the diff of a branch.

func DisableSafeMigrationsCmd added in v0.132.0 

func DisableSafeMigrationsCmd(ch *cmdutil.Helper) *cobra.Command

func DownloadQueryPatternsCmd added in v0.294.0 

func DownloadQueryPatternsCmd(ch *cmdutil.Helper) *cobra.Command

DownloadQueryPatternsCmd generates a query patterns report for a branch, waits for it to finish, and downloads the resulting CSV file.

func EnableSafeMigrationsCmd added in v0.132.0 

func EnableSafeMigrationsCmd(ch *cmdutil.Helper) *cobra.Command

func ExtensionsCmd added in v0.323.0 

func ExtensionsCmd(ch *cmdutil.Helper) *cobra.Command

ExtensionsCmd lists extensions available on a Postgres branch's cluster image.

func GetRoutingRulesCmd added in v0.187.0 

func GetRoutingRulesCmd(ch *cmdutil.Helper) *cobra.Command

GetRoutingRulesCmd is the command for showing the routing rules of a branch.

func InfraCmd added in v0.273.0 

func InfraCmd(ch *cmdutil.Helper) *cobra.Command

InfraCmd shows infrastructure (pods) for a branch.

func LintCmd added in v0.134.0 

func LintCmd(ch *cmdutil.Helper) *cobra.Command

func ListCmd 

func ListCmd(ch *cmdutil.Helper) *cobra.Command

ListCmd encapsulates the command for listing branches for a database.

func ListQueryPatternsCmd added in v0.323.0 

func ListQueryPatternsCmd(ch *cmdutil.Helper) *cobra.Command

func MaintenanceCmd added in v0.323.0 

func MaintenanceCmd(ch *cmdutil.Helper) *cobra.Command

MaintenanceCmd groups the maintenance commands for a Postgres branch.

func MaintenanceRunCmd added in v0.323.0 

func MaintenanceRunCmd(ch *cmdutil.Helper) *cobra.Command

MaintenanceRunCmd starts a maintenance run for a Postgres branch.

func ParametersCmd added in v0.304.0 

func ParametersCmd(ch *cmdutil.Helper) *cobra.Command

ParametersCmd groups the read-only parameter commands for a Postgres branch. Parameters are changed with 'pscale branch resize --parameters'.

func ProcesslistCmd added in v0.287.0 

func ProcesslistCmd(ch *cmdutil.Helper) *cobra.Command

ProcesslistCmd manages MySQL process lists for a Vitess branch.

func ProcesslistKillCmd added in v0.287.0 

func ProcesslistKillCmd(ch *cmdutil.Helper) *cobra.Command

ProcesslistKillCmd kills a running MySQL process on a Vitess branch.

func ProcesslistShowCmd added in v0.287.0 

func ProcesslistShowCmd(ch *cmdutil.Helper) *cobra.Command

ProcesslistShowCmd shows the MySQL process list for a Vitess branch.

func PromoteCmd added in v0.64.0 

func PromoteCmd(ch *cmdutil.Helper) *cobra.Command

func QueryPatternsCmd added in v0.294.0 

func QueryPatternsCmd(ch *cmdutil.Helper) *cobra.Command

QueryPatternsCmd wraps commands for a branch's query patterns reports.

func RefreshSchemaCmd added in v0.28.0 

func RefreshSchemaCmd(ch *cmdutil.Helper) *cobra.Command

func ResizeCancelCmd added in v0.304.0 

func ResizeCancelCmd(ch *cmdutil.Helper) *cobra.Command

ResizeCancelCmd cancels the queued change requests for a Postgres branch.

func ResizeCmd added in v0.292.0 

func ResizeCmd(ch *cmdutil.Helper) *cobra.Command

ResizeCmd changes a Postgres branch's cluster: its size, replica count, and/or configuration parameters. All changes are queued as a single change request via the branch changes API.

func ResizeStatusCmd added in v0.304.0 

func ResizeStatusCmd(ch *cmdutil.Helper) *cobra.Command

ResizeStatusCmd shows the most recent change request for a Postgres branch.

func RoutingRulesCmd added in v0.187.0 

func RoutingRulesCmd(ch *cmdutil.Helper) *cobra.Command

RoutingRulesCmd is the top-level command for fetching or updating the routing rules of a branch.

func SafeMigrationsCmd added in v0.132.0 

func SafeMigrationsCmd(ch *cmdutil.Helper) *cobra.Command

func SchemaCmd added in v0.21.0 

func SchemaCmd(ch *cmdutil.Helper) *cobra.Command

SchemaCmd is the command for showing the schema of a branch.

func ShowCmd added in v0.13.0 

func ShowCmd(ch *cmdutil.Helper) *cobra.Command

func ShowQueryPatternsCmd added in v0.323.0 

func ShowQueryPatternsCmd(ch *cmdutil.Helper) *cobra.Command

func SwitchCmd added in v0.2.0 

func SwitchCmd(ch *cmdutil.Helper) *cobra.Command

func SwitchoverCmd added in v0.322.0 

func SwitchoverCmd(ch *cmdutil.Helper) *cobra.Command

SwitchoverCmd switches over the primary of a Postgres branch.

func SwitchoverListCmd added in v0.327.0 

func SwitchoverListCmd(ch *cmdutil.Helper) *cobra.Command

func SwitchoverShowCmd added in v0.327.0 

func SwitchoverShowCmd(ch *cmdutil.Helper) *cobra.Command

func UpdateCmd added in v0.322.0 

func UpdateCmd(ch *cmdutil.Helper) *cobra.Command

UpdateCmd updates configurable branch settings.

func UpdateRoutingRulesCmd added in v0.187.0 

func UpdateRoutingRulesCmd(ch *cmdutil.Helper) *cobra.Command

UpdateRoutingRulesCmd is the command for updating the routing rules of a branch.

func VtgateCmd added in v0.310.0 

func VtgateCmd(ch *cmdutil.Helper) *cobra.Command

VtgateCmd manages Vitess branch VTGate configuration.

func VtgateResizeCancelCmd added in v0.310.0 

func VtgateResizeCancelCmd(ch *cmdutil.Helper) *cobra.Command

func VtgateResizeCmd added in v0.310.0 

func VtgateResizeCmd(ch *cmdutil.Helper) *cobra.Command

VtgateResizeCmd resizes VTGates on a Vitess production branch.

func VtgateResizeStatusCmd added in v0.310.0 

func VtgateResizeStatusCmd(ch *cmdutil.Helper) *cobra.Command

func VtgateShowCmd added in v0.310.0 

func VtgateShowCmd(ch *cmdutil.Helper) *cobra.Command

VtgateShowCmd shows the current VTGate configuration for a Vitess branch.

Types

type DatabaseBranch added in v0.14.0 

type DatabaseBranch struct {
	ID             string `header:"id" json:"id"`
	Name           string `header:"name" json:"name"`
	ParentBranch   string `header:"parent branch,n/a" json:"parent_branch"`
	Region         string `header:"region" json:"region"`
	Production     bool   `header:"production" json:"production"`
	SafeMigrations bool   `header:"safe migrations" json:"safe_migrations"`
	Ready          bool   `header:"ready" json:"ready"`
	CreatedAt      int64  `header:"created_at,timestamp(ms|utc|human)" json:"created_at"`
	UpdatedAt      int64  `header:"updated_at,timestamp(ms|utc|human)" json:"updated_at"`
	// contains filtered or unexported fields
}

func ToDatabaseBranch added in v0.69.0 

func ToDatabaseBranch(db *ps.DatabaseBranch) *DatabaseBranch

ToDatabaseBranch returns a struct that prints out the various fields of a database model.

func (*DatabaseBranch) MarshalCSVValue added in v0.17.0 

func (d *DatabaseBranch) MarshalCSVValue() interface{}

func (*DatabaseBranch) MarshalJSON added in v0.14.0 

func (d *DatabaseBranch) MarshalJSON() ([]byte, error)

type InfraPod added in v0.273.0 

type InfraPod struct {
	Component     string `header:"component" json:"component"`
	Size          string `header:"size" json:"size"`
	Cell          string `header:"cell" json:"cell"`
	TabletType    string `header:"tablet type" json:"tablet_type"`
	KeyspaceShard string `header:"keyspace/shard" json:"keyspace_shard"`
	Ready         string `header:"ready" json:"ready"`
	Restarts      int    `header:"restarts" json:"restarts"`
	Status        string `header:"status" json:"status"`
	Age           string `header:"age" json:"age"`
	Name          string `header:"pod name" json:"name"`
	// contains filtered or unexported fields
}

func (*InfraPod) MarshalCSVValue added in v0.273.0 

func (p *InfraPod) MarshalCSVValue() interface{}

func (*InfraPod) MarshalJSON added in v0.273.0 

func (p *InfraPod) MarshalJSON() ([]byte, error)

type PostgresBranch added in v0.247.0 

type PostgresBranch struct {
	ID           string `header:"id" json:"id"`
	Name         string `header:"name" json:"name"`
	ParentBranch string `header:"parent branch,n/a" json:"parent_branch"`
	Region       string `header:"region" json:"region"`
	Production   bool   `header:"production" json:"production"`
	Ready        bool   `header:"ready" json:"ready"`
	CreatedAt    int64  `header:"created_at,timestamp(ms|utc|human)" json:"created_at"`
	UpdatedAt    int64  `header:"updated_at,timestamp(ms|utc|human)" json:"updated_at"`
	// contains filtered or unexported fields
}

func ToPostgresBranch added in v0.247.0 

func ToPostgresBranch(b *ps.PostgresBranch) *PostgresBranch

func (*PostgresBranch) MarshalCSVValue added in v0.247.0 

func (p *PostgresBranch) MarshalCSVValue() interface{}

func (*PostgresBranch) MarshalJSON added in v0.247.0 

func (p *PostgresBranch) MarshalJSON() ([]byte, error)

type PostgresInfraRow added in v0.298.0 

type PostgresInfraRow struct {
	Component string `header:"component" json:"component"`
	Role      string `header:"role" json:"role"`
	Size      string `header:"size" json:"size"`
	AZ        string `header:"az" json:"az"`
	Storage   string `header:"storage" json:"storage"`
	Name      string `header:"name" json:"name"`
	// contains filtered or unexported fields
}

func (*PostgresInfraRow) MarshalCSVValue added in v0.298.0 

func (r *PostgresInfraRow) MarshalCSVValue() interface{}

func (*PostgresInfraRow) MarshalJSON added in v0.298.0 

func (r *PostgresInfraRow) MarshalJSON() ([]byte, error)

type PostgresSwitchover added in v0.322.0 

type PostgresSwitchover struct {
	ID     string `header:"id" json:"id"`
	State  string `header:"state" json:"state"`
	Method string `header:"method,n/a" json:"method,omitempty"`
	// contains filtered or unexported fields
}

func ToPostgresSwitchover added in v0.322.0 

func ToPostgresSwitchover(switchover *ps.PostgresSwitchover) *PostgresSwitchover

func (*PostgresSwitchover) MarshalCSVValue added in v0.322.0 

func (s *PostgresSwitchover) MarshalCSVValue() interface{}

func (*PostgresSwitchover) MarshalJSON added in v0.322.0 

func (s *PostgresSwitchover) MarshalJSON() ([]byte, error)

type QueryPatternsDownload added in v0.294.0 

type QueryPatternsDownload struct {
	ID    string `header:"id" json:"id"`
	State string `header:"state" json:"state"`
	File  string `header:"file" json:"file"`
}

QueryPatternsDownload is the result of downloading a query patterns report.

type SchemaLintError added in v0.134.0 

type SchemaLintError struct {
	LintError        string `json:"lint_error" header:"lint_error"`
	Keyspace         string `json:"keyspace_name" header:"keyspace"`
	Table            string `json:"table_name" header:"table"`
	SubjectType      string `json:"subject_type" header:"subject_type"`
	ErrorDescription string `json:"error_description" header:"error_description"`
	DocsURL          string `json:"docs_url" header:"docs_url"`
	// contains filtered or unexported fields
}

SchemaLintError returns a table-serializable lint error.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.