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 "vitess.io/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 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
|
|
|
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. |
|
vtcombo
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. |
|
vtgateclienttest
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. |
|
vttestserver
vttestserver is a native Go implementation of `run_local_server.py`.
|
vttestserver is a native Go implementation of `run_local_server.py`. |
|
vtworker
vtworker is the main program to run a worker job.
|
vtworker is the main program to run a worker job. |
|
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 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 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 json2 provides some improvements over the original json.
|
Package json2 provides some improvements over the original json. |
|
Package jsonutil contains json-related utility functions
|
Package jsonutil contains json-related utility functions |
|
Package memcache is a client for memcached.
|
Package memcache is a client for memcached. |
|
Package mysql is a library to support MySQL binary protocol, both client and server sides.
|
Package mysql is a library to support MySQL binary protocol, both client and server sides. |
|
endtoend
Package endtoend is a test-only package.
|
Package endtoend is a test-only package. |
|
fakesqldb
Package fakesqldb provides a MySQL server for tests.
|
Package fakesqldb provides a MySQL server for tests. |
|
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 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). |
|
opentsdb
Package opentsdb adds support for pushing stats to opentsdb.
|
Package opentsdb adds support for pushing stats to opentsdb. |
|
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. |
|
binlog/binlogplayer
Package binlogplayer contains the code that plays a vreplication stream on a client database.
|
Package binlogplayer contains the code that plays a vreplication stream on a client database. |
|
binlog/eventtoken
Package eventtoken includes utility methods for event token handling.
|
Package eventtoken includes utility methods for event token handling. |
|
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 provides the registration for command line options to collect db connection parameters.
|
Package dbconfigs provides the registration for command line options to collect db connection parameters. |
|
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. |
|
dtids
Package dtids contains dtid convenience functions.
|
Package dtids contains dtid convenience functions. |
|
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. |
|
grpcclient
Package grpcclient contains utility methods for gRPC client implementations to use.
|
Package grpcclient contains utility methods for gRPC client implementations to use. |
|
logz
Package logz provides an infrastructure to expose a list of entries as a sortable table on a webpage.
|
Package logz provides an infrastructure to expose a list of entries as a sortable table on a webpage. |
|
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/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. |
|
mysqlproxy
Package mysqlproxy is a basic module that proxies a mysql server session to appropriate calls in a queryservice back end, with optional query normalization.
|
Package mysqlproxy is a basic module that proxies a mysql server session to appropriate calls in a queryservice back end, with optional query normalization. |
|
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. |
|
srvtopo
Package srvtopo contains a set of helper methods and classes to use the topology service in a serving environment.
|
Package srvtopo contains a set of helper methods and classes to use the topology service in a serving environment. |
|
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. |
|
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. |
|
tlstest
Package tlstest contains utility methods to create test certificates.
|
Package tlstest contains utility methods to create test certificates. |
|
topo
Package topo is the module responsible for interacting with the topology service.
|
Package topo is the module responsible for interacting with the topology service. |
|
topo/consultopo
Package consultopo implements topo.Server with consul as the backend.
|
Package consultopo implements topo.Server with consul as the backend. |
|
topo/etcd2topo
Package etcd2topo implements topo.Server with etcd as the backend.
|
Package etcd2topo implements topo.Server with etcd as the backend. |
|
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/memorytopo
Package memorytopo contains an implementation of the topo.Factory / topo.Conn interfaces based on an in-memory tree of data.
|
Package memorytopo contains an implementation of the topo.Factory / topo.Conn interfaces based on an in-memory tree of data. |
|
topo/test
Package test contains utilities to test topo.Conn implementations.
|
Package test contains utilities to test topo.Conn implementations. |
|
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. |
|
topo/topotests
Package topotests contains all the unit tests for the topo.Server code that is based on topo.Conn.
|
Package topotests contains all the unit tests for the topo.Server code that is based on topo.Conn. |
|
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. |
|
vtaclcheck
Package vtaclcheck analyzes a set of sql statements and returns the corresponding vtgate and vttablet query plans that will be executed on the given statements
|
Package vtaclcheck analyzes a set of sql statements and returns the corresponding vtgate and vttablet query plans that will be executed on the given statements |
|
vtctl
Package vtctl contains the implementation of all the Vitess management commands.
|
Package vtctl contains the implementation of all the Vitess management commands. |
|
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. |
|
vtexplain
Package vtexplain analyzes a set of sql statements and returns the corresponding vtgate and vttablet query plans that will be executed on the given statements
|
Package vtexplain analyzes a set of sql statements and returns the corresponding vtgate and vttablet query plans that will be executed on the given statements |
|
vtgate
Package vtgate provides query routing rpc services for vttablets.
|
Package vtgate provides query routing rpc services for vttablets. |
|
vtgate/buffer
Package buffer provides a buffer for MASTER traffic during failovers.
|
Package buffer provides a buffer for MASTER traffic during failovers. |
|
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/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 |
|
vtgate/vtgateservice/vtgateservice_testing
Package vtgateservice_testing is a generated GoMock package.
|
Package vtgateservice_testing is a generated GoMock package. |
|
vtqueryserver
Package vtqueryserver is a standalone version of the tablet server that only implements the queryservice interface without any of the topology, replication management, or other features of the full vttablet.
|
Package vtqueryserver is a standalone version of the tablet server that only implements the queryservice interface without any of the topology, replication management, or other features of the full vttablet. |
|
vttablet/customrule/filecustomrule
Package filecustomrule implements static custom rule from a config file
|
Package filecustomrule implements static custom rule from a config file |
|
vttablet/customrule/topocustomrule
Package topocustomrule implements a topo service backed listener for query rules.
|
Package topocustomrule implements a topo service backed listener for query rules. |
|
vttablet/endtoend
Package endtoend is a test-only package.
|
Package endtoend is a test-only package. |
|
vttablet/filelogger
Package filelogger implements an optional plugin that logs all queries to syslog.
|
Package filelogger implements an optional plugin that logs all queries to syslog. |
|
vttablet/heartbeat
Package heartbeat contains a writer and reader of heartbeats for a master-slave cluster.
|
Package heartbeat contains a writer and reader of heartbeats for a master-slave cluster. |
|
vttablet/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. |
|
vttablet/sandboxconn
Package sandboxconn provides a fake QueryService implementation for tests.
|
Package sandboxconn provides a fake QueryService implementation for tests. |
|
vttablet/sysloglogger
Package sysloglogger implements an optional plugin that logs all queries to syslog.
|
Package sysloglogger implements an optional plugin that logs all queries to syslog. |
|
vttablet/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. |
|
vttablet/tabletmanager
Package tabletmanager exports the ActionAgent object.
|
Package tabletmanager exports the ActionAgent object. |
|
vttablet/tabletmanager/events
Package events contains event structs used by the tabletmanager package.
|
Package events contains event structs used by the tabletmanager package. |
|
vttablet/tabletserver/schema/schematest
Package schematest provides support for testing packages that depend on schema
|
Package schematest provides support for testing packages that depend on schema |
|
vttablet/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. |
|
vttablet/tabletserver/splitquery/splitquery_testing
Package splitquery_testing is a generated GoMock package.
|
Package splitquery_testing is a generated GoMock package. |
|
vttablet/tabletserver/tabletenv
Package tabletenv maintains environment variables and types that are common for all packages of tabletserver.
|
Package tabletenv maintains environment variables and types that are common for all packages of tabletserver. |
|
vttablet/tabletserver/txserializer
Package txserializer provides the vttablet hot row protection.
|
Package txserializer provides the vttablet hot row protection. |
|
vttablet/tabletservermock
Package tabletservermock provides mock interfaces for tabletserver.
|
Package tabletservermock provides mock interfaces for tabletserver. |
|
vttest
Package vttest contains helpers to set up Vitess for testing.
|
Package vttest contains helpers to set up Vitess for testing. |
|
vttime
Package vttime contains the definitions and implementations for the Vitess time library.
|
Package vttime contains the definitions and implementations for the Vitess time library. |
|
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. |
|
workflow/topovalidator
Package topovalidator contains a workflow that validates the topology data.
|
Package topovalidator contains a workflow that validates the topology data. |
|
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. |
Click to show internal directories.
Click to hide internal directories.