vtctld

Documentation

Overview

Package vtctld contains all the code to expose a vtctld server based on the provided topo.Server.

Package vtctld contains all the code to expose a vtctld server based on the provided topo.Server.

Index

• func InitVtctld(ts *topo.Server)
• func RegisterDebugHealthHandler(ts *topo.Server)
• type ActionRepository
  • func NewActionRepository(ts *topo.Server) *ActionRepository
  • func (ar *ActionRepository) ApplyKeyspaceAction(ctx context.Context, actionName, keyspace string, r *http.Request) *ActionResult
  • func (ar *ActionRepository) ApplyShardAction(ctx context.Context, actionName, keyspace, shard string, r *http.Request) *ActionResult
  • func (ar *ActionRepository) ApplyTabletAction(ctx context.Context, actionName string, tabletAlias *topodatapb.TabletAlias, ...) *ActionResult
  • func (ar *ActionRepository) RegisterKeyspaceAction(name string, method actionKeyspaceMethod)
  • func (ar *ActionRepository) RegisterShardAction(name string, method actionShardMethod)
  • func (ar *ActionRepository) RegisterTabletAction(name, role string, method actionTabletMethod)
• type ActionResult
• type Result
• type TabletStats
• type TabletWithStatsAndURL

Functions

func InitVtctld

func InitVtctld(ts *topo.Server)

InitVtctld initializes all the vtctld functionality.

func RegisterDebugHealthHandler

func RegisterDebugHealthHandler(ts *topo.Server)

RegisterDebugHealthHandler register a debug health http endpoint for a vtcld server

Types

type ActionRepository

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

ActionRepository is a repository of actions that can be performed on a {Keyspace,Shard,Tablet}. Note that the registered action methods will be passed an *http.Request on which ParseForm() has already succeeded.

func NewActionRepository

func NewActionRepository(ts *topo.Server) *ActionRepository

NewActionRepository creates and returns a new ActionRepository, with no actions.

func (*ActionRepository) ApplyKeyspaceAction

func (ar *ActionRepository) ApplyKeyspaceAction(ctx context.Context, actionName, keyspace string, r *http.Request) *ActionResult

ApplyKeyspaceAction applies the provided action to the keyspace.

func (*ActionRepository) ApplyShardAction

func (ar *ActionRepository) ApplyShardAction(ctx context.Context, actionName, keyspace, shard string, r *http.Request) *ActionResult

ApplyShardAction applies the provided action to the shard.

func (*ActionRepository) ApplyTabletAction

func (ar *ActionRepository) ApplyTabletAction(ctx context.Context, actionName string, tabletAlias *topodatapb.TabletAlias, r *http.Request) *ActionResult

ApplyTabletAction applies the provided action to the tablet.

func (*ActionRepository) RegisterKeyspaceAction

func (ar *ActionRepository) RegisterKeyspaceAction(name string, method actionKeyspaceMethod)

RegisterKeyspaceAction registers a new action on a keyspace.

func (*ActionRepository) RegisterShardAction

func (ar *ActionRepository) RegisterShardAction(name string, method actionShardMethod)

RegisterShardAction registers a new action on a shard.

func (*ActionRepository) RegisterTabletAction

func (ar *ActionRepository) RegisterTabletAction(name, role string, method actionTabletMethod)

RegisterTabletAction registers a new action on a tablet.

type ActionResult

type ActionResult struct {
	Name       string
	Parameters string
	Output     string
	Error      bool
}

ActionResult contains the result of an action. If Error, the action failed.

type Result

type Result struct {
	Data     string
	Children []string
	Error    string
}

Result is what the backendExplorer returns. It represents one directory node. It is exported so the JSON encoder can print it.

type TabletStats

type TabletStats struct {
	LastError string                 `json:"last_error,omitempty"`
	Realtime  *querypb.RealtimeStats `json:"realtime,omitempty"`
	Serving   bool                   `json:"serving"`
	Up        bool                   `json:"up"`
}

TabletStats represents realtime stats from a discovery.LegacyTabletStats struct.

type TabletWithStatsAndURL

type TabletWithStatsAndURL struct {
	Alias               *topodatapb.TabletAlias `json:"alias,omitempty"`
	Hostname            string                  `json:"hostname,omitempty"`
	PortMap             map[string]int32        `json:"port_map,omitempty"`
	Keyspace            string                  `json:"keyspace,omitempty"`
	Shard               string                  `json:"shard,omitempty"`
	KeyRange            *topodatapb.KeyRange    `json:"key_range,omitempty"`
	Type                topodatapb.TabletType   `json:"type,omitempty"`
	DbNameOverride      string                  `json:"db_name_override,omitempty"`
	Tags                map[string]string       `json:"tags,omitempty"`
	MysqlHostname       string                  `json:"mysql_hostname,omitempty"`
	MysqlPort           int32                   `json:"mysql_port,omitempty"`
	MasterTermStartTime *vttime.Time            `json:"master_term_start_time,omitempty"`
	Stats               *TabletStats            `json:"stats,omitempty"`
	URL                 string                  `json:"url,omitempty"`
}

TabletWithStatsAndURL wraps topo.Tablet, adding a URL property and optional realtime stats.