README
¶
This directory contains all the Go code for Vitess.
Most of the packages at the top level are general-purpose and are suitable for use outside Vitess. Packages that are specific to Vitess are in the vt subdirectory. Binaries are in the cmd subdirectory.
Please see GoDoc for a listing of the packages and their purposes.
vt/proto contains the compiled protos for go, one per each directory. When importing these protos (for instance XXX.proto), we rename them on import to XXXpb. For instance:
import (
topodatapb "github.com/youtube/vitess/go/vt/proto/topodata"
)
Directories
¶
| Path | Synopsis |
|---|---|
|
Package acl contains functions to enforce access control lists.
|
Package acl contains functions to enforce access control lists. |
|
Package bufio2 implements buffered I/O. It wraps an io.Reader or io.Writer object, creating another object (Reader or AsyncWriter) that also implements the interface but provides buffering and some help for textual I/O.
|
Package bufio2 implements buffered I/O. It wraps an io.Reader or io.Writer object, creating another object (Reader or AsyncWriter) that also implements the interface but provides buffering and some help for textual I/O. |
|
Package bytes2 provides alternate implementations of functionality similar to go's bytes package.
|
Package bytes2 provides alternate implementations of functionality similar to go's bytes package. |
|
Package cache implements a LRU cache.
|
Package cache implements a LRU cache. |
|
Package cgzip wraps the C library for gzip.
|
Package cgzip wraps the C library for gzip. |
|
Package cistring implements a case-insensitive string type.
|
Package cistring implements a case-insensitive string type. |
|
cmd
|
|
|
automation_client
command
|
|
|
automation_server
command
|
|
|
mysqlctl
command
mysqlctl initializes and controls mysqld with Vitess-specific configuration.
|
mysqlctl initializes and controls mysqld with Vitess-specific configuration. |
|
mysqlctld
command
mysqlctld is a daemon that starts or initializes mysqld and provides an RPC interface for vttablet to stop and start mysqld from a different container without having to restart the container running mysqlctld.
|
mysqlctld is a daemon that starts or initializes mysqld and provides an RPC interface for vttablet to stop and start mysqld from a different container without having to restart the container running mysqlctld. |
|
query_analyzer
command
|
|
|
topo2topo
command
|
|
|
vtclient
command
|
|
|
vtcombo
command
vtcombo: a single binary that contains: - a ZK topology server based on an in-memory map.
|
vtcombo: a single binary that contains: - a ZK topology server based on an in-memory map. |
|
vtctl
command
|
|
|
vtctlclient
command
|
|
|
vtctld
command
|
|
|
vtgate
command
|
|
|
vtgateclienttest
command
Package main is the implementation of vtgateclienttest.
|
Package main is the implementation of vtgateclienttest. |
|
vtgateclienttest/services
Package services exposes all the services for the vtgateclienttest binary.
|
Package services exposes all the services for the vtgateclienttest binary. |
|
vtjanitor
command
|
|
|
vttablet
command
|
|
|
vtworker
command
vtworker is the main program to run a worker job.
|
vtworker is the main program to run a worker job. |
|
vtworkerclient
command
|
|
|
zk
command
|
|
|
zkctl
command
zkctl initializes and controls ZooKeeper with Vitess-specific configuration.
|
zkctl initializes and controls ZooKeeper with Vitess-specific configuration. |
|
zkctld
command
zkctld is a daemon that starts or initializes ZooKeeper with Vitess-specific configuration.
|
zkctld is a daemon that starts or initializes ZooKeeper with Vitess-specific configuration. |
|
Package event provides a reflect-based framework for low-frequency global dispatching of events, which are values of any arbitrary type, to a set of listener functions, which are usually registered by plugin packages during init().
|
Package event provides a reflect-based framework for low-frequency global dispatching of events, which are values of any arbitrary type, to a set of listener functions, which are usually registered by plugin packages during init(). |
|
syslogger
Package syslogger uses the event package to listen for any event that implements the Syslogger interface.
|
Package syslogger uses the event package to listen for any event that implements the Syslogger interface. |
|
Package ewma implements exponentially weighted moving averages(EWMA).
|
Package ewma implements exponentially weighted moving averages(EWMA). |
|
Package exit provides an alternative to os.Exit(int).
|
Package exit provides an alternative to os.Exit(int). |
|
Package fileutil contains utility functions related to files and paths.
|
Package fileutil contains utility functions related to files and paths. |
|
Package flagutil contains flags that parse string lists and string maps.
|
Package flagutil contains flags that parse string lists and string maps. |
|
Package hack gives you some efficient functionality at the cost of breaking some Go rules.
|
Package hack gives you some efficient functionality at the cost of breaking some Go rules. |
|
Package history implements a circular buffer with adjacent-item deduplication.
|
Package history implements a circular buffer with adjacent-item deduplication. |
|
Package ioutil2 provides extra functionality along similar lines to io/ioutil.
|
Package ioutil2 provides extra functionality along similar lines to io/ioutil. |
|
Package memcache is a client for memcached.
|
Package memcache is a client for memcached. |
|
Package mysql wraps the C client library for MySQL.
|
Package mysql wraps the C client library for MySQL. |
|
Package netutil contains network-related utility functions.
|
Package netutil contains network-related utility functions. |
|
Package pools provides functionality to manage and reuse resources like connections.
|
Package pools provides functionality to manage and reuse resources like connections. |
|
Package proc allows you to configure servers to be restarted with negligible downtime.
|
Package proc allows you to configure servers to be restarted with negligible downtime. |
|
Package ratelimiter implements rate limiting functionality.
|
Package ratelimiter implements rate limiting functionality. |
|
Package sqldb defines an interface for low level db connection.
|
Package sqldb defines an interface for low level db connection. |
|
Package sqltypes implements interfaces and types that represent SQL values.
|
Package sqltypes implements interfaces and types that represent SQL values. |
|
Package stats is a wrapper for expvar.
|
Package stats is a wrapper for expvar. |
|
influxdbbackend
Package influxdbbackend is useful for publishing metrics to an InfluxDB backend (tested on v0.88).
|
Package influxdbbackend is useful for publishing metrics to an InfluxDB backend (tested on v0.88). |
|
promstats
Package promstats contains adapters to publish stats variables to prometheus (http://prometheus.io)
|
Package promstats contains adapters to publish stats variables to prometheus (http://prometheus.io) |
|
Package streamlog provides a non-blocking message broadcaster.
|
Package streamlog provides a non-blocking message broadcaster. |
|
Package sync2 provides extra functionality along the same lines as sync.
|
Package sync2 provides extra functionality along the same lines as sync. |
|
Package tb exposes some handy traceback functionality buried in the runtime.
|
Package tb exposes some handy traceback functionality buried in the runtime. |
|
Package testfiles locates test files within the Vitess directory tree.
|
Package testfiles locates test files within the Vitess directory tree. |
|
Package timer provides various enhanced timer functions.
|
Package timer provides various enhanced timer functions. |
|
Package trace contains a helper interface that allows various tracing tools to be plugged in to components using this interface.
|
Package trace contains a helper interface that allows various tracing tools to be plugged in to components using this interface. |
|
vt
|
|
|
automation
Package automation contains code to execute high-level cluster operations (e.g.
|
Package automation contains code to execute high-level cluster operations (e.g. |
|
automation/resolver
Package resolver provides a mechanism to resolve a vtworker or vtctld hostname to multiple addresses.
|
Package resolver provides a mechanism to resolve a vtworker or vtctld hostname to multiple addresses. |
|
binlog/binlogplayer
Package binlogplayer contains the code that plays a filtered replication stream on a client database.
|
Package binlogplayer contains the code that plays a filtered replication stream on a client database. |
|
binlog/grpcbinlogstreamer
Package grpcbinlogstreamer contains the gRPC implementation of the binlog streamer server component.
|
Package grpcbinlogstreamer contains the gRPC implementation of the binlog streamer server component. |
|
callerid
Package callerid stores/retrives CallerIDs (immediate CallerID and effective CallerID) to/from the Context
|
Package callerid stores/retrives CallerIDs (immediate CallerID and effective CallerID) to/from the Context |
|
callinfo
Package callinfo stores custom values into the Context (related to the RPC source)
|
Package callinfo stores custom values into the Context (related to the RPC source) |
|
dbconfigs
Package dbconfigs is reusable by vt tools to load the db configs file.
|
Package dbconfigs is reusable by vt tools to load the db configs file. |
|
dbconnpool
Package dbconnpool exposes a single DBConnection object with wrapped access to a single DB connection, and a ConnectionPool object to pool these DBConnections.
|
Package dbconnpool exposes a single DBConnection object with wrapped access to a single DB connection, and a ConnectionPool object to pool these DBConnections. |
|
discovery
Package discovery provides a way to discover all tablets e.g.
|
Package discovery provides a way to discover all tablets e.g. |
|
estimator
Package estimator implements future value estimation by EWMA algorithm.
|
Package estimator implements future value estimation by EWMA algorithm. |
|
etcdtopo
Package etcdtopo implements topo.Server with etcd as the backend.
|
Package etcdtopo implements topo.Server with etcd as the backend. |
|
events
Package events defines common structures used for events dispatched from various other package.
|
Package events defines common structures used for events dispatched from various other package. |
|
mysqlctl/backupstorage
Package backupstorage contains the interface and file system implementation of the backup system.
|
Package backupstorage contains the interface and file system implementation of the backup system. |
|
mysqlctl/cephbackupstorage
Package cephbackupstorage implements the BackupStorage interface for Ceph Cloud Storage.
|
Package cephbackupstorage implements the BackupStorage interface for Ceph Cloud Storage. |
|
mysqlctl/filebackupstorage
Package filebackupstorage implements the BackupStorage interface for a local filesystem (which can be an NFS mount).
|
Package filebackupstorage implements the BackupStorage interface for a local filesystem (which can be an NFS mount). |
|
mysqlctl/gcsbackupstorage
Package gcsbackupstorage implements the BackupStorage interface for Google Cloud Storage.
|
Package gcsbackupstorage implements the BackupStorage interface for Google Cloud Storage. |
|
mysqlctl/grpcmysqlctlclient
Package grpcmysqlctlclient contains the gRPC1 version of the mysqlctl client protocol.
|
Package grpcmysqlctlclient contains the gRPC1 version of the mysqlctl client protocol. |
|
mysqlctl/grpcmysqlctlserver
Package grpcmysqlctlserver contains the gRPC implementation of the server side of the remote execution of mysqlctl commands.
|
Package grpcmysqlctlserver contains the gRPC implementation of the server side of the remote execution of mysqlctl commands. |
|
mysqlctl/mysqlctlclient
Package mysqlctlclient contains the generic client side of the remote mysqlctl protocol.
|
Package mysqlctlclient contains the generic client side of the remote mysqlctl protocol. |
|
mysqlctl/replication
Package replication contains data structures to deal with MySQL replication.
|
Package replication contains data structures to deal with MySQL replication. |
|
mysqlctl/s3backupstorage
Package s3backupstorage implements the BackupStorage interface for AWS S3.
|
Package s3backupstorage implements the BackupStorage interface for AWS S3. |
|
mysqlctl/tmutils
Package tmutils contains helper methods to deal with the tabletmanagerdata proto3 structures.
|
Package tmutils contains helper methods to deal with the tabletmanagerdata proto3 structures. |
|
proto/automation
Package automation is a generated protocol buffer package.
|
Package automation is a generated protocol buffer package. |
|
proto/automationservice
Package automationservice is a generated protocol buffer package.
|
Package automationservice is a generated protocol buffer package. |
|
proto/binlogdata
Package binlogdata is a generated protocol buffer package.
|
Package binlogdata is a generated protocol buffer package. |
|
proto/binlogservice
Package binlogservice is a generated protocol buffer package.
|
Package binlogservice is a generated protocol buffer package. |
|
proto/logutil
Package logutil is a generated protocol buffer package.
|
Package logutil is a generated protocol buffer package. |
|
proto/mysqlctl
Package mysqlctl is a generated protocol buffer package.
|
Package mysqlctl is a generated protocol buffer package. |
|
proto/query
Package query is a generated protocol buffer package.
|
Package query is a generated protocol buffer package. |
|
proto/queryservice
Package queryservice is a generated protocol buffer package.
|
Package queryservice is a generated protocol buffer package. |
|
proto/replicationdata
Package replicationdata is a generated protocol buffer package.
|
Package replicationdata is a generated protocol buffer package. |
|
proto/tableacl
Package tableacl is a generated protocol buffer package.
|
Package tableacl is a generated protocol buffer package. |
|
proto/tabletmanagerdata
Package tabletmanagerdata is a generated protocol buffer package.
|
Package tabletmanagerdata is a generated protocol buffer package. |
|
proto/tabletmanagerservice
Package tabletmanagerservice is a generated protocol buffer package.
|
Package tabletmanagerservice is a generated protocol buffer package. |
|
proto/throttlerdata
Package throttlerdata is a generated protocol buffer package.
|
Package throttlerdata is a generated protocol buffer package. |
|
proto/throttlerservice
Package throttlerservice is a generated protocol buffer package.
|
Package throttlerservice is a generated protocol buffer package. |
|
proto/topodata
Package topodata is a generated protocol buffer package.
|
Package topodata is a generated protocol buffer package. |
|
proto/vschema
Package vschema is a generated protocol buffer package.
|
Package vschema is a generated protocol buffer package. |
|
proto/vtctldata
Package vtctldata is a generated protocol buffer package.
|
Package vtctldata is a generated protocol buffer package. |
|
proto/vtctlservice
Package vtctlservice is a generated protocol buffer package.
|
Package vtctlservice is a generated protocol buffer package. |
|
proto/vtgate
Package vtgate is a generated protocol buffer package.
|
Package vtgate is a generated protocol buffer package. |
|
proto/vtgateservice
Package vtgateservice is a generated protocol buffer package.
|
Package vtgateservice is a generated protocol buffer package. |
|
proto/vtrpc
Package vtrpc is a generated protocol buffer package.
|
Package vtrpc is a generated protocol buffer package. |
|
proto/vttest
Package vttest is a generated protocol buffer package.
|
Package vttest is a generated protocol buffer package. |
|
proto/vtworkerdata
Package vtworkerdata is a generated protocol buffer package.
|
Package vtworkerdata is a generated protocol buffer package. |
|
proto/vtworkerservice
Package vtworkerservice is a generated protocol buffer package.
|
Package vtworkerservice is a generated protocol buffer package. |
|
servenv
Package servenv contains functionality that is common for all Vitess server programs.
|
Package servenv contains functionality that is common for all Vitess server programs. |
|
sqlannotation
Package sqlannotation provides functions for annotating DML statements with keyspace-id comments and parsing them.
|
Package sqlannotation provides functions for annotating DML statements with keyspace-id comments and parsing them. |
|
status
Package status defines a few useful functions for our binaries, mainly to link the status page with a vtctld instance.
|
Package status defines a few useful functions for our binaries, mainly to link the status page with a vtctld instance. |
|
tabletmanager
Package tabletmanager exports the ActionAgent object.
|
Package tabletmanager exports the ActionAgent object. |
|
tabletmanager/events
Package events contains event structs used by the tabletmanager package.
|
Package events contains event structs used by the tabletmanager package. |
|
tabletserver/customrule/filecustomrule
Package filecustomrule implements static custom rule from a config file
|
Package filecustomrule implements static custom rule from a config file |
|
tabletserver/endtoend
Package endtoend is a test-only package.
|
Package endtoend is a test-only package. |
|
tabletserver/queryservice
Package queryservice contains the interface for the service definition of the Query Service.
|
Package queryservice contains the interface for the service definition of the Query Service. |
|
tabletserver/querytypes
Package querytypes defines internal types used in the APIs to deal with queries.
|
Package querytypes defines internal types used in the APIs to deal with queries. |
|
tabletserver/sandboxconn
Package sandboxconn provides a fake TabletConn implementation for tests.
|
Package sandboxconn provides a fake TabletConn implementation for tests. |
|
tabletserver/splitquery
Package splitquery contains the logic needed for implementing the tabletserver's SplitQuery RPC.
|
Package splitquery contains the logic needed for implementing the tabletserver's SplitQuery RPC. |
|
tabletserver/tabletconntest
Package tabletconntest provides the test methods to make sure a tabletconn/queryservice pair over RPC works correctly.
|
Package tabletconntest provides the test methods to make sure a tabletconn/queryservice pair over RPC works correctly. |
|
tabletserver/tabletservermock
Package tabletservermock provides mock interfaces for tabletserver.
|
Package tabletservermock provides mock interfaces for tabletserver. |
|
throttler
Package throttler provides a client-side, local throttler which is used to throttle (and actively pace) writes during the resharding process.
|
Package throttler provides a client-side, local throttler which is used to throttle (and actively pace) writes during the resharding process. |
|
throttler/grpcthrottlerclient
Package grpcthrottlerclient contains the gRPC version of the throttler client protocol.
|
Package grpcthrottlerclient contains the gRPC version of the throttler client protocol. |
|
throttler/grpcthrottlerserver
Package grpcthrottlerserver contains the gRPC implementation of the server side of the throttler service.
|
Package grpcthrottlerserver contains the gRPC implementation of the server side of the throttler service. |
|
throttler/throttlerclient
Package throttlerclient defines the generic RPC client interface for the throttler service.
|
Package throttlerclient defines the generic RPC client interface for the throttler service. |
|
throttler/throttlerclienttest
Package throttlerclienttest contains the testsuite against which each RPC implementation of the throttlerclient interface must be tested.
|
Package throttlerclienttest contains the testsuite against which each RPC implementation of the throttlerclient interface must be tested. |
|
topo/events
Package events defines the structures used for events relating directly to individual topology elements, like keyspaces, shards, and tablets.
|
Package events defines the structures used for events relating directly to individual topology elements, like keyspaces, shards, and tablets. |
|
topo/helpers
Package helpers contains a few utility classes to handle topo.Server objects, and transitions from one topo implementation to another.
|
Package helpers contains a few utility classes to handle topo.Server objects, and transitions from one topo implementation to another. |
|
topo/test
Package test contains utilities to test topo.Impl implementations.
|
Package test contains utilities to test topo.Impl implementations. |
|
topo/test/faketopo
Package faketopo contains utitlities for tests that have to interact with a Vitess topology.
|
Package faketopo contains utitlities for tests that have to interact with a Vitess topology. |
|
topo/topoproto
Package topoproto contains utility functions to deal with the proto3 structures defined in proto/topodata.
|
Package topoproto contains utility functions to deal with the proto3 structures defined in proto/topodata. |
|
topotools
Package topotools contains high level functions based on vt/topo and vt/actionnode.
|
Package topotools contains high level functions based on vt/topo and vt/actionnode. |
|
topotools/events
Package events defines the structures used for events dispatched from the wrangler package.
|
Package events defines the structures used for events dispatched from the wrangler package. |
|
vitessdriver
Package vitessdriver contains the Vitess Go SQL driver.
|
Package vitessdriver contains the Vitess Go SQL driver. |
|
vtctl/fakevtctlclient
Package fakevtctlclient contains a fake for the vtctlclient interface.
|
Package fakevtctlclient contains a fake for the vtctlclient interface. |
|
vtctl/grpcvtctlclient
Package grpcvtctlclient contains the gRPC version of the vtctl client protocol
|
Package grpcvtctlclient contains the gRPC version of the vtctl client protocol |
|
vtctl/grpcvtctlserver
Package grpcvtctlserver contains the gRPC implementation of the server side of the remote execution of vtctl commands.
|
Package grpcvtctlserver contains the gRPC implementation of the server side of the remote execution of vtctl commands. |
|
vtctl/vtctlclient
Package vtctlclient contains the generic client side of the remote vtctl protocol.
|
Package vtctlclient contains the generic client side of the remote vtctl protocol. |
|
vtctl/vtctlclienttest
Package vtctlclienttest contains the testsuite against which each RPC implementation of the vtctlclient interface must be tested.
|
Package vtctlclienttest contains the testsuite against which each RPC implementation of the vtctlclient interface must be tested. |
|
vtctld
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. |
|
vterrors
Package vterrors provides helpers for propagating internal errors through the Vitess system (including across RPC boundaries) in a structured way.
|
Package vterrors provides helpers for propagating internal errors through the Vitess system (including across RPC boundaries) in a structured way. |
|
vtgate
Package vtgate provides query routing rpc services for vttablets.
|
Package vtgate provides query routing rpc services for vttablets. |
|
vtgate/fakerpcvtgateconn
Package fakerpcvtgateconn provides a fake implementation of vtgateconn.Impl that doesn't do any RPC, but uses a local map to return results.
|
Package fakerpcvtgateconn provides a fake implementation of vtgateconn.Impl that doesn't do any RPC, but uses a local map to return results. |
|
vtgate/gateway
Package gateway contains the routing layer of vtgate.
|
Package gateway contains the routing layer of vtgate. |
|
vtgate/gatewaytest
Package gatewaytest contains a test suite to run against a Gateway object.
|
Package gatewaytest contains a test suite to run against a Gateway object. |
|
vtgate/grpcvtgateconn
Package grpcvtgateconn provides gRPC connectivity for VTGate.
|
Package grpcvtgateconn provides gRPC connectivity for VTGate. |
|
vtgate/grpcvtgateservice
Package grpcvtgateservice provides the gRPC glue for vtgate
|
Package grpcvtgateservice provides the gRPC glue for vtgate |
|
vtgate/masterbuffer
Package masterbuffer contains experimental logic to buffer master requests in VTGate.
|
Package masterbuffer contains experimental logic to buffer master requests in VTGate. |
|
vtgate/planbuilder
Package planbuilder allows you to build execution plans that describe how to fulfill a query that may span multiple keyspaces or shards.
|
Package planbuilder allows you to build execution plans that describe how to fulfill a query that may span multiple keyspaces or shards. |
|
vtgate/vtgateconntest
Package vtgateconntest provides the test methods to make sure a vtgateconn/vtgateservice pair over RPC works correctly.
|
Package vtgateconntest provides the test methods to make sure a vtgateconn/vtgateservice pair over RPC works correctly. |
|
vtgate/vtgateservice
Package vtgateservice provides to interface definition for the vtgate service
|
Package vtgateservice provides to interface definition for the vtgate service |
|
vttest
Package vttest provides the functionality to bring up a test cluster.
|
Package vttest provides the functionality to bring up a test cluster. |
|
vttest/fakesqldb
Package fakesqldb provides a fake implementation of sqldb.Conn
|
Package fakesqldb provides a fake implementation of sqldb.Conn |
|
worker
Package worker contains the framework, utility methods and core functions for long running actions.
|
Package worker contains the framework, utility methods and core functions for long running actions. |
|
worker/fakevtworkerclient
Package fakevtworkerclient contains a fake for the vtworkerclient interface.
|
Package fakevtworkerclient contains a fake for the vtworkerclient interface. |
|
worker/grpcvtworkerclient
Package grpcvtworkerclient contains the gRPC version of the vtworker client protocol.
|
Package grpcvtworkerclient contains the gRPC version of the vtworker client protocol. |
|
worker/grpcvtworkerserver
Package grpcvtworkerserver contains the gRPC implementation of the server side of the remote execution of vtworker commands.
|
Package grpcvtworkerserver contains the gRPC implementation of the server side of the remote execution of vtworker commands. |
|
worker/vtworkerclient
Package vtworkerclient contains the generic client side of the remote vtworker protocol.
|
Package vtworkerclient contains the generic client side of the remote vtworker protocol. |
|
worker/vtworkerclienttest
Package vtworkerclienttest contains the testsuite against which each RPC implementation of the vtworkerclient interface must be tested.
|
Package vtworkerclienttest contains the testsuite against which each RPC implementation of the vtworkerclient interface must be tested. |
|
wrangler
Package wrangler contains the Wrangler object to manage complex topology actions.
|
Package wrangler contains the Wrangler object to manage complex topology actions. |
|
wrangler/testlib
Package testlib contains utility methods to include in unit tests to deal with topology common tasks, like fake tablets and action loops.
|
Package testlib contains utility methods to include in unit tests to deal with topology common tasks, like fake tablets and action loops. |
|
Package zk emulates a "global" namespace across n zk quorums.
|
Package zk emulates a "global" namespace across n zk quorums. |
|
fakezk
Package fakezk is a pretty complete mock implementation of a Zookeper connection (see go/zk/zk.Conn).
|
Package fakezk is a pretty complete mock implementation of a Zookeper connection (see go/zk/zk.Conn). |
Click to show internal directories.
Click to hide internal directories.