wrangler

package
v0.0.0-...-9a5932e Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2014 License: BSD-3-Clause Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultActionTimeout = 30 * time.Second
	DefaultLockTimeout   = 30 * time.Second
)
View Source 
const ChangeSlaveTypeActionName = "ChangeSlaveTypeAction"
View Source 
const (
	SLAVE_STATUS_DEADLINE = 10e9
)
View Source 
const StartBlpActionName = "StartBlpAction"
View Source 
const StartSlaveActionName = "StartSlaveAction"
View Source 
const TabletTagActionName = "TabletTagAction"

Variables

This section is empty.

Functions

func CopyMapKeys 

func CopyMapKeys(m interface{}, typeHint interface{}) interface{}

Copy keys from from map m into a new slice with the type specified by typeHint. Reflection can't make a new slice type just based on the key type AFAICT.

func CopyMapValues 

func CopyMapValues(m interface{}, typeHint interface{}) interface{}

func FindTabletByIPAddrAndPort 

func FindTabletByIPAddrAndPort(tabletMap map[topo.TabletAlias]*topo.TabletInfo, addr, portName string, port int) (topo.TabletAlias, error)

Search within a tablet map for tablets

func GetAllTablets 

func GetAllTablets(ts topo.Server, cell string) ([]*topo.TabletInfo, error)

Return a sorted list of tablets.

func GetAllTabletsAccrossCells 

func GetAllTabletsAccrossCells(ts topo.Server) ([]*topo.TabletInfo, error)

GetAllTabletsAccrossCells returns all tablets from known cells. If it returns topo.ErrPartialResult, then the list is valid, but partial.

func GetTabletMap 

func GetTabletMap(ts topo.Server, tabletAliases []topo.TabletAlias) (map[topo.TabletAlias]*topo.TabletInfo, error)

GetTabletMap tries to read all the tablets in the provided list, and returns them all in a map. If error is topo.ErrPartialResult, the results in the dictionary are incomplete, meaning some tablets couldn't be read.

func GetTabletMapForShard 

func GetTabletMapForShard(ts topo.Server, keyspace, shard string) (map[topo.TabletAlias]*topo.TabletInfo, error)

GetTabletMapForShard returns the tablets for a shard. It can return topo.ErrPartialResult if it couldn't read all the cells, or all the individual tablets, in which case the map is valid, but partial.

func GetTabletMapForShardByCell 

func GetTabletMapForShardByCell(ts topo.Server, keyspace, shard string, cells []string) (map[topo.TabletAlias]*topo.TabletInfo, error)

GetTabletMapForShardByCell returns the tablets for a shard. It can return topo.ErrPartialResult if it couldn't read all the cells, or all the individual tablets, in which case the map is valid, but partial.

func RecordChangeSlaveTypeAction 

func RecordChangeSlaveTypeAction(cleaner *Cleaner, tabletAlias topo.TabletAlias, tabletType topo.TabletType)

RecordChangeSlaveTypeAction records a new ChangeSlaveTypeAction into the specified Cleaner

func RecordStartBlpAction 

func RecordStartBlpAction(cleaner *Cleaner, tabletAlias topo.TabletAlias, waitTime time.Duration)

RecordStartBlpAction records a new StartBlpAction into the specified Cleaner

func RecordStartSlaveAction 

func RecordStartSlaveAction(cleaner *Cleaner, tabletAlias topo.TabletAlias, waitTime time.Duration)

RecordStartSlaveAction records a new StartSlaveAction into the specified Cleaner

func RecordTabletTagAction 

func RecordTabletTagAction(cleaner *Cleaner, tabletAlias topo.TabletAlias, name, value string)

RecordTabletTagAction records a new TabletTagAction into the specified Cleaner

func SignalInterrupt 

func SignalInterrupt()

func WriteAddr 

func WriteAddr(zconn zk.Conn, zkPath string, addr *zkns.ZknsAddr) error

func WriteAddrs 

func WriteAddrs(zconn zk.Conn, zkPath string, addrs *LegacyZknsAddrs) error

Types

type ChangeSlaveTypeAction 

type ChangeSlaveTypeAction struct {
	TabletAlias topo.TabletAlias
	TabletType  topo.TabletType
}

ChangeSlaveTypeAction will change a server type to another type

func FindChangeSlaveTypeActionByTarget 

func FindChangeSlaveTypeActionByTarget(cleaner *Cleaner, tabletAlias topo.TabletAlias) (*ChangeSlaveTypeAction, error)

FindChangeSlaveTypeActionByTarget finds the first action for the target

func (ChangeSlaveTypeAction) CleanUp 

func (csta ChangeSlaveTypeAction) CleanUp(wr *Wrangler) error

CleanUp is part of CleanerAction interface.

type Cleaner 

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

Cleaner remembers a list of cleanup steps to perform. Just record action cleanup steps, and execute them at the end in reverse order, with various guarantees.

func (*Cleaner) CleanUp 

func (cleaner *Cleaner) CleanUp(wr *Wrangler) error

CleanUp will run the recorded actions. If an action on a target fails, it will not run the next action on the same target. We return the aggregate errors for all cleanups. TODO(alainjobart) Actions should run concurrently on a per target basis. They are then serialized on each target.

func (*Cleaner) GetActionByName 

func (cleaner *Cleaner) GetActionByName(name, target string) (CleanerAction, error)

GetActionByName returns the first action in the list with the given name and target

func (*Cleaner) Record 

func (cleaner *Cleaner) Record(name, target string, action CleanerAction)

Record will add a cleaning action to the list

func (*Cleaner) RemoveActionByName 

func (cleaner *Cleaner) RemoveActionByName(name, target string) error

RemoveActionByName removes an action from the cleaner list

type CleanerAction 

type CleanerAction interface {
	CleanUp(wr *Wrangler) error
}

CleanerAction is the interface that clean-up actions need to implement

type KeyspaceNodes 

type KeyspaceNodes map[string]TabletNodesByType

KeyspaceNodes represents all tablet nodes in a keyspace.

func (KeyspaceNodes) HasType 

func (ks KeyspaceNodes) HasType(name string) bool

HasType returns true if ks has any tablets with the named type.

func (KeyspaceNodes) ShardNodes 

func (ks KeyspaceNodes) ShardNodes() []*ShardNodes

ShardNodes returns all the shard nodes, in a reasonable order.

func (KeyspaceNodes) TabletTypes 

func (ks KeyspaceNodes) TabletTypes() []string

TabletTypes returns a slice of tablet type names this ks contains.

type LegacyZknsAddrs 

type LegacyZknsAddrs struct {
	Endpoints []string `json:"endpoints"`
}

type ServingGraph 

type ServingGraph struct {
	Keyspaces map[string]KeyspaceNodes
	Cell      string
}

type ShardNodes 

type ShardNodes struct {
	TabletNodes TabletNodesByType
	Name        string
}

ShardNodes represents all tablet nodes for a shard. The keys are string representations of tablet types.

type StartBlpAction 

type StartBlpAction struct {
	TabletAlias topo.TabletAlias
	WaitTime    time.Duration
}

StartBlpAction will restart binlog replication on a server

func (StartBlpAction) CleanUp 

func (sba StartBlpAction) CleanUp(wr *Wrangler) error

CleanUp is part of CleanerAction interface.

type StartSlaveAction 

type StartSlaveAction struct {
	TabletAlias topo.TabletAlias
	WaitTime    time.Duration
}

StartSlaveAction will restart binlog replication on a server

func (StartSlaveAction) CleanUp 

func (sba StartSlaveAction) CleanUp(wr *Wrangler) error

CleanUp is part of CleanerAction interface.

type TabletNode 

type TabletNode struct {
	Host  string
	Alias topo.TabletAlias
	Port  int
}

TabletNode is the representation of a tablet in the db topology.

func TabletNodeFromEndPoint 

func TabletNodeFromEndPoint(ep topo.EndPoint, cell string) *TabletNode

func TabletNodeFromTabletInfo 

func TabletNodeFromTabletInfo(ti *topo.TabletInfo) (*TabletNode, error)

func (TabletNode) ShortName 

func (tn TabletNode) ShortName() string

type TabletNodesByType 

type TabletNodesByType map[string][]*TabletNode

TabletNodesByType maps tablet types to slices of tablet nodes.

type TabletStatus 

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

local structure used to keep track of what we're doing

type TabletTagAction 

type TabletTagAction struct {
	TabletAlias topo.TabletAlias
	Name        string
	Value       string
}

TabletTagAction will add / remove a tag to a tablet. If Value is empty, will remove the tag.

func (TabletTagAction) CleanUp 

func (tta TabletTagAction) CleanUp(wr *Wrangler) error

CleanUp is part of CleanerAction interface.

type Topology 

type Topology struct {
	Assigned map[string]KeyspaceNodes
	Idle     []*TabletNode
	Scrap    []*TabletNode
	Partial  bool
}

func NewTopology 

func NewTopology() *Topology

type Wrangler 

type Wrangler struct {

	// UseRPCs makes the wrangler use RPCs to trigger short live
	// remote actions. It is faster in production, as we don't
	// fork a vtaction. However, unit tests don't support it.
	UseRPCs bool
	// contains filtered or unexported fields
}

func New 

func New(ts topo.Server, actionTimeout, lockTimeout time.Duration) *Wrangler

actionTimeout: how long should we wait for an action to complete? lockTimeout: how long should we wait for the initial lock to start a complex action? 

This is distinct from actionTimeout because most of the time, we want to immediately
know that out action will fail. However, automated action will need some time to
arbitrate the locks.

func (*Wrangler) ActionInitiator 

func (wr *Wrangler) ActionInitiator() *initiator.ActionInitiator

func (*Wrangler) ApplySchema 

func (wr *Wrangler) ApplySchema(tabletAlias topo.TabletAlias, sc *myproto.SchemaChange) (*myproto.SchemaChangeResult, error)

func (*Wrangler) ApplySchemaKeyspace 

func (wr *Wrangler) ApplySchemaKeyspace(keyspace string, change string, simple, force bool) (*myproto.SchemaChangeResult, error)

apply a schema change to an entire keyspace. take a keyspace lock to do this. first we will validate the Preflight works the same on all shard masters and fail if not (unless force is specified) if simple, we just do it on all masters. if complex, we do the shell game in parallel on all shards

func (*Wrangler) ApplySchemaShard 

func (wr *Wrangler) ApplySchemaShard(keyspace, shard, change string, newParentTabletAlias topo.TabletAlias, simple, force bool) (*myproto.SchemaChangeResult, error)

Note for 'complex' mode (the 'simple' mode is easy enough that we don't need to handle recovery that much): this method is able to recover if interrupted in the middle, because it knows which server has the schema change already applied, and will just pass through them very quickly.

func (*Wrangler) ChangeType 

func (wr *Wrangler) ChangeType(tabletAlias topo.TabletAlias, tabletType topo.TabletType, force bool) error

Change the type of tablet and recompute all necessary derived paths in the serving graph. If force is true, it will bypass the vtaction system and make the data change directly, and not run the remote hooks.

Note we don't update the master record in the Shard here, as we can't ChangeType from and out of master anyway.

func (*Wrangler) ChangeTypeNoRebuild 

func (wr *Wrangler) ChangeTypeNoRebuild(tabletAlias topo.TabletAlias, tabletType topo.TabletType, force bool) (rebuildRequired bool, cell, keyspace, shard string, err error)

ChangeTypeNoRebuild changes a tablet's type, and returns whether there's a shard that should be rebuilt, along with its cell, keyspace, and shard. If force is true, it will bypass the vtaction system and make the data change directly, and not run the remote hooks.

Note we don't update the master record in the Shard here, as we can't ChangeType from and out of master anyway.

func (*Wrangler) Clone 

func (wr *Wrangler) Clone(srcTabletAlias topo.TabletAlias, dstTabletAliases []topo.TabletAlias, forceMasterSnapshot bool, snapshotConcurrency, fetchConcurrency, fetchRetryCount int, serverMode bool) error

func (*Wrangler) DbTopology 

func (wr *Wrangler) DbTopology() (*Topology, error)

func (*Wrangler) DeleteShard 

func (wr *Wrangler) DeleteShard(keyspace, shard string) error

DeleteShard will do all the necessary changes in the topology server to entirely remove a shard. It can only work if there are no tablets in that shard.

func (*Wrangler) ExecuteHook 

func (wr *Wrangler) ExecuteHook(tabletAlias topo.TabletAlias, hook *hk.Hook) (hookResult *hk.HookResult, err error)

func (*Wrangler) ExecuteOptionalTabletInfoHook 

func (wr *Wrangler) ExecuteOptionalTabletInfoHook(ti *topo.TabletInfo, hook *hk.Hook) (err error)

Execute a hook and returns an error only if the hook failed, not if the hook doesn't exist.

func (*Wrangler) ExecuteTabletInfoHook 

func (wr *Wrangler) ExecuteTabletInfoHook(ti *topo.TabletInfo, hook *hk.Hook) (hookResult *hk.HookResult, err error)

func (*Wrangler) ExportZkns 

func (wr *Wrangler) ExportZkns(cell string) error

Export addresses from the VT serving graph to a legacy zkns server. Note these functions only work with a zktopo.

func (*Wrangler) ExportZknsForKeyspace 

func (wr *Wrangler) ExportZknsForKeyspace(keyspace string) error

Export addresses from the VT serving graph to a legacy zkns server.

func (*Wrangler) GetPermissions 

func (wr *Wrangler) GetPermissions(tabletAlias topo.TabletAlias) (*myproto.Permissions, error)

func (*Wrangler) GetSchema 

func (wr *Wrangler) GetSchema(tabletAlias topo.TabletAlias, tables []string, includeViews bool) (*myproto.SchemaDefinition, error)

func (*Wrangler) GetVersion 

func (wr *Wrangler) GetVersion(tabletAlias topo.TabletAlias) (string, error)

func (*Wrangler) InitTablet 

func (wr *Wrangler) InitTablet(tablet *topo.Tablet, force, createShardAndKeyspace, update bool) error

InitTablet creates or updates a tablet. If no parent is specified in the tablet, and the tablet has a slave type, we will find the appropriate parent. If createShardAndKeyspace is true and the parent keyspace or shard don't exist, they will be created. If update is true, and a tablet with the same ID exists, update it. If Force is true, and a tablet with the same ID already exists, it will be scrapped and deleted, and then recreated.

func (*Wrangler) MigrateServedFrom 

func (wr *Wrangler) MigrateServedFrom(keyspace, shard string, servedType topo.TabletType, reverse bool) error

func (*Wrangler) MigrateServedTypes 

func (wr *Wrangler) MigrateServedTypes(keyspace, shard string, servedType topo.TabletType, reverse bool) error

func (*Wrangler) MultiRestore 

func (wr *Wrangler) MultiRestore(dstTabletAlias topo.TabletAlias, sources []topo.TabletAlias, concurrency, fetchConcurrency, insertTableConcurrency, fetchRetryCount int, strategy string) error

func (*Wrangler) MultiSnapshot 

func (wr *Wrangler) MultiSnapshot(keyRanges []key.KeyRange, tabletAlias topo.TabletAlias, concurrency int, tables []string, forceMasterSnapshot, skipSlaveRestart bool, maximumFilesize uint64) (manifests []string, parent topo.TabletAlias, err error)

func (*Wrangler) PreflightSchema 

func (wr *Wrangler) PreflightSchema(tabletAlias topo.TabletAlias, change string) (*myproto.SchemaChangeResult, error)

func (*Wrangler) RebuildKeyspaceGraph 

func (wr *Wrangler) RebuildKeyspaceGraph(keyspace string, cells []string) error

Rebuild the serving graph data while locking out other changes.

func (*Wrangler) RebuildReplicationGraph 

func (wr *Wrangler) RebuildReplicationGraph(cells []string, keyspaces []string) error

This is a quick and dirty tool to resurrect the TopologyServer data from the canonical data stored in the tablet nodes.

cells: local vt cells to scan for all tablets keyspaces: list of keyspaces to rebuild

func (*Wrangler) RebuildShardGraph 

func (wr *Wrangler) RebuildShardGraph(keyspace, shard string, cells []string) error

Rebuild the serving and replication rollup data data while locking out other changes.

func (*Wrangler) ReloadSchema 

func (wr *Wrangler) ReloadSchema(tabletAlias topo.TabletAlias) error

func (*Wrangler) RemoveShardCell 

func (wr *Wrangler) RemoveShardCell(keyspace, shard, cell string, force bool) error

RemoveShardCell will remove a cell from the Cells list in a shard. It will first check the shard has no tablets there. if 'force' is specified, it will remove the cell even when the tablet map cannot be retrieved. This is intended to be used when a cell is completely down and its topology server cannot even be reached.

func (*Wrangler) ReparentShard 

func (wr *Wrangler) ReparentShard(keyspace, shard string, masterElectTabletAlias topo.TabletAlias, leaveMasterReadOnly, forceReparentToCurrentMaster bool) error

Create the reparenting action and launch a goroutine to coordinate the procedure.

leaveMasterReadOnly: leave the master in read-only mode, even 

though all the other necessary updates have been made.

forceReparentToCurrentMaster: mostly for test setups, this can 

cause data loss.

func (*Wrangler) ReparentTablet 

func (wr *Wrangler) ReparentTablet(tabletAlias topo.TabletAlias) error

Attempt to reparent this tablet to the current master, based on the current replication position. If there is no match, it will fail.

func (*Wrangler) ReserveForRestore 

func (wr *Wrangler) ReserveForRestore(srcTabletAlias, dstTabletAlias topo.TabletAlias) (err error)

func (*Wrangler) ResetActionTimeout 

func (wr *Wrangler) ResetActionTimeout(actionTimeout time.Duration)

ResetActionTimeout should be used before every action on a wrangler object that is going to be re-used: - vtctl will not call this, as it does one action - vtctld will call this, as it re-uses the same wrangler for actions

func (*Wrangler) Restore 

func (wr *Wrangler) Restore(srcTabletAlias topo.TabletAlias, srcFilePath string, dstTabletAlias, parentAlias topo.TabletAlias, fetchConcurrency, fetchRetryCount int, wasReserved, dontWaitForSlaveStart bool) error

func (*Wrangler) Scrap 

func (wr *Wrangler) Scrap(tabletAlias topo.TabletAlias, force, skipRebuild bool) (actionPath string, err error)

Scrap a tablet. If force is used, we write to topo.Server directly and don't remote-execute the command.

If we scrap the master for a shard, we will clear its record from the Shard object (only if that was the right master)

func (*Wrangler) ServingGraph 

func (wr *Wrangler) ServingGraph(cell string) (*ServingGraph, error)

func (*Wrangler) SetBlacklistedTablesByShard 

func (wr *Wrangler) SetBlacklistedTablesByShard(keyspace, shard string, tabletType topo.TabletType, tables []string) error

SetBlacklistedTablesByShard sets the blacklisted table list of all tablets of a given type in a shard. It would work for the master, but it wouldn't be very efficient.

func (*Wrangler) SetKeyspaceShardingInfo 

func (wr *Wrangler) SetKeyspaceShardingInfo(keyspace, shardingColumnName string, shardingColumnType key.KeyspaceIdType, force bool) error

func (*Wrangler) SetShardServedTypes 

func (wr *Wrangler) SetShardServedTypes(keyspace, shard string, servedTypes []topo.TabletType) error

SetShardServedTypes changes the ServedTypes parameter of a shard. It does not rebuild any serving graph or do any consistency check (yet).

func (*Wrangler) ShardExternallyReparented 

func (wr *Wrangler) ShardExternallyReparented(keyspace, shard string, masterElectTabletAlias topo.TabletAlias, scrapStragglers, continueOnUnexpectedMaster bool, acceptSuccessPercents int) error

func (*Wrangler) ShardMultiRestore 

func (wr *Wrangler) ShardMultiRestore(keyspace, shard string, sources []topo.TabletAlias, tables []string, concurrency, fetchConcurrency, insertTableConcurrency, fetchRetryCount int, strategy string) error

func (*Wrangler) ShardReplicationPositions 

func (wr *Wrangler) ShardReplicationPositions(keyspace, shard string) ([]*topo.TabletInfo, []*myproto.ReplicationPosition, error)

func (*Wrangler) SlaveWasRestarted 

func (wr *Wrangler) SlaveWasRestarted(alias, masterAlias topo.TabletAlias, scrapStragglers bool) error

SlaveWasRestarted notifies the tablet identified by tablet that its master has changed to masterAlias.

func (*Wrangler) Snapshot 

func (wr *Wrangler) Snapshot(tabletAlias topo.TabletAlias, forceMasterSnapshot bool, snapshotConcurrency int, serverMode bool) (manifest string, parent topo.TabletAlias, slaveStartRequired, readOnly bool, originalType topo.TabletType, err error)

forceMasterSnapshot: Normally a master is not a viable tablet to snapshot. However, there are degenerate cases where you need to override this, for instance the initial clone of a new master.

func (*Wrangler) SnapshotSourceEnd 

func (wr *Wrangler) SnapshotSourceEnd(tabletAlias topo.TabletAlias, slaveStartRequired, readWrite bool, originalType topo.TabletType) (err error)

func (*Wrangler) TopoServer 

func (wr *Wrangler) TopoServer() topo.Server

func (*Wrangler) UnreserveForRestore 

func (wr *Wrangler) UnreserveForRestore(dstTabletAlias topo.TabletAlias) (err error)

func (*Wrangler) UnreserveForRestoreMulti 

func (wr *Wrangler) UnreserveForRestoreMulti(dstTabletAliases []topo.TabletAlias)

func (*Wrangler) Validate 

func (wr *Wrangler) Validate(pingTablets bool) error

Validate a whole TopologyServer tree

func (*Wrangler) ValidateKeyspace 

func (wr *Wrangler) ValidateKeyspace(keyspace string, pingTablets bool) error

func (*Wrangler) ValidatePermissionsKeyspace 

func (wr *Wrangler) ValidatePermissionsKeyspace(keyspace string) error

func (*Wrangler) ValidatePermissionsShard 

func (wr *Wrangler) ValidatePermissionsShard(keyspace, shard string) error

func (*Wrangler) ValidateSchemaKeyspace 

func (wr *Wrangler) ValidateSchemaKeyspace(keyspace string, includeViews bool) error

func (*Wrangler) ValidateSchemaShard 

func (wr *Wrangler) ValidateSchemaShard(keyspace, shard string, includeViews bool) error

func (*Wrangler) ValidateShard 

func (wr *Wrangler) ValidateShard(keyspace, shard string, pingTablets bool) error

func (*Wrangler) ValidateVersionKeyspace 

func (wr *Wrangler) ValidateVersionKeyspace(keyspace string) error

func (*Wrangler) ValidateVersionShard 

func (wr *Wrangler) ValidateVersionShard(keyspace, shard string) error

Source Files

View all Source files

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.