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.
Please see GoDoc for a listing of the packages and their purposes.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package acl contains functions to enforce access control lists.
|
Package acl contains functions to enforce access control lists. |
|
Package bson implements encoding and decoding of BSON objects.
|
Package bson implements encoding and decoding of BSON objects. |
|
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. |
|
cmd
|
|
|
bsongen
bsongen will generate bson encoders and decoders for a given go type.
|
bsongen will generate bson encoders and decoders for a given go type. |
|
mysqlctl
mysqlctl initializes and controls mysqld with Vitess-specific configuration.
|
mysqlctl initializes and controls mysqld with Vitess-specific configuration. |
|
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.
|
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. |
|
vtprimecache
vtprimecache is a standalone version of primecache
|
vtprimecache is a standalone version of primecache |
|
zkctl
zkctl initializes and controls ZooKeeper with Vitess-specific configuration.
|
zkctl initializes and controls ZooKeeper with Vitess-specific configuration. |
|
zkctld
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 db defines an alternate (and simplified) db api compared to go's database/sql.
|
Package db defines an alternate (and simplified) db api compared to go's database/sql. |
|
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 executil provides information about running processes.
|
Package executil provides information about running processes. |
|
Package exit provides an alternative to os.Exit(int) that executes deferred functions before exiting.
|
Package exit provides an alternative to os.Exit(int) that executes deferred functions before exiting. |
|
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 jscfg implements a simple API for reading and writing JSON files.
|
Package jscfg implements a simple API for reading and writing JSON files. |
|
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 rpcplus provides access to the exported methods of an object across a network or other I/O connection.
|
Package rpcplus provides access to the exported methods of an object across a network or other I/O connection. |
|
jsonrpc
Package jsonrpc implements a JSON-RPC ClientCodec and ServerCodec for the rpcplus package.
|
Package jsonrpc implements a JSON-RPC ClientCodec and ServerCodec for the rpcplus package. |
|
pbrpc
Package pbrpc implements a ClientCodec and ServerCodec for the rpcplus package using Protocol Buffers.
|
Package pbrpc implements a ClientCodec and ServerCodec for the rpcplus package using Protocol Buffers. |
|
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. |
|
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 terminal detects whether a file descriptor is a terminal.
|
Package terminal detects whether a file descriptor is a terminal. |
|
Package testfiles locates test files within the Vitess directory tree.
|
Package testfiles locates test files within the Vitess directory tree. |
|
Package timer provides timer functionality that can be controlled by the user.
|
Package timer provides timer functionality that can be controlled by the user. |
|
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
|
|
|
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. |
|
callinfo
Package callinfo extracts RPC call information from context objects.
|
Package callinfo extracts RPC call information from context objects. |
|
client2/tablet
API compliant to the requirements of database/sql Open expects name to be "hostname:port/keyspace/shard" For query arguments, we assume place-holders in the query string in the form of :v0, :v1, etc.
|
API compliant to the requirements of database/sql Open expects name to be "hostname:port/keyspace/shard" For query arguments, we assume place-holders in the query string in the form of :v0, :v1, etc. |
|
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. |
|
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/gorpcmysqlctlclient
Package gorpcmysqlctlclient contains the go rpc version of the mysqlctl client protocol.
|
Package gorpcmysqlctlclient contains the go rpc version of the mysqlctl client protocol. |
|
mysqlctl/gorpcmysqlctlserver
Package gorpcmysqlctlserver contains the Go RPC implementation of the server side of the remote execution of mysqlctl commands.
|
Package gorpcmysqlctlserver contains the Go RPC 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. |
|
primecache
primecache primes the MySQL buffer cache with the rows that are going to be modified by the replication stream.
|
primecache primes the MySQL buffer cache with the rows that are going to be modified by the replication stream. |
|
rpc
Package rpc contains RPC-related structs shared between many components.
|
Package rpc contains RPC-related structs shared between many components. |
|
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 agent exports the ActionAgent object.
|
Package agent exports the ActionAgent object. |
|
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
helpers package contains a few utility classes to handle topo.Server objects, and transitions from one topo implementation to another.
|
helpers package 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.Server implementations.
|
package test contains utilities to test topo.Server implementations. |
|
topo/test/faketopo
faketopo contains utitlities for tests that have to interact with a Vitess topology.
|
faketopo contains utitlities for tests that have to interact with a Vitess topology. |
|
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. |
|
vtctl/gorpcproto
Package gorpcproto contains the Go RPC definitions of the structures used to execute remote vtctl commands.
|
Package gorpcproto contains the Go RPC definitions of the structures used to execute remote vtctl commands. |
|
vtctl/gorpcvtctlclient
Package gorpcvtctlclient contains the go rpc version of the vtctl client protocol
|
Package gorpcvtctlclient contains the go rpc version of the vtctl client protocol |
|
vtctl/gorpcvtctlserver
Package gorpcvtctlserver contains the Go RPC implementation of the server side of the remote execution of vtctl commands.
|
Package gorpcvtctlserver contains the Go RPC 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 provides testing library for vtctl implementations to use in their tests.
|
Package vtctlclienttest provides testing library for vtctl implementations to use in their tests. |
|
vtgate
Package vtgate provides query routing rpc services for vttablets.
|
Package vtgate provides query routing rpc services for vttablets. |
|
vtgate/gorpcvtgateservice
Package gorpcvtgateservice provides to go rpc glue for vtgate
|
Package gorpcvtgateservice provides to go rpc glue for vtgate |
|
worker
'worker' package contains the framework, utility methods and core functions for long running actions.
|
'worker' package contains the framework, utility methods and core functions for long running actions. |
|
wrangler
wrangler contains the Wrangler object to manage complex topology actions.
|
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. |
|
Emulate a "global" namespace across n zk quorums.
|
Emulate 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). |
|
zkns/pdns
To be used with PowerDNS (pdns) as a "pipe backend" CoProcess.
|
To be used with PowerDNS (pdns) as a "pipe backend" CoProcess. |
|
zkocc
cache for zkocc
|
cache for zkocc |
Click to show internal directories.
Click to hide internal directories.