package
3.0.0-rc.3+incompatible
Repository: https://github.com/vitessio/vitess.git
Documentation: pkg.go.dev

# Functions

GetMySQLOptions returns the default option set for the given MySQL flavor.
GetShardName returns an appropriate shard name, as a string.
GetShardNames creates a slice of shard names for N shards.
LoadSQLFile loads a parses a .sql file from disk, removing all the different comments that mysql/mysqldump inserts in these, and returning each individual SQL statement as its own string.
NewLocalTestEnv returns an instance of the default test environment used for local testing Vitess.
NewLocalTestEnvWithDirectory returns a new instance of the default test environment with a directory explicitly specified.
SeedConfigDefaults returns the default values for SeedConfig.
VtcomboProcess returns a VtProcess handle for a local `vtcombo` service, configured with the given Config.

# Constants

DefaultCharset is the default charset used by MySQL instances.
DefaultMySQLFlavor is the MySQL flavor used by vttest when MYSQL_FLAVOR is not set in the environment.

# Variables

NewDefaultEnv is an user-configurable callback that returns a new Environment instance with the default settings.
QueryServerArgs are the default arguments passed to all Vitess query servers.

# Structs

Config are the settings used to configure the self-contained Vitess cluster.
LocalCluster controls a local Vitess setup for testing, containing a MySQL instance and one or more vtgate-equivalent access points.
LocalTestEnv is an Environment implementation for local testing See: NewLocalTestEnv().
Mysqlctl implements MySQLManager through Vitess' mysqlctld tool.
SeedConfig are the settings to enable the initialization of the local cluster with random data.
VtProcess is a generic handle for a running Vitess process.

# Interfaces

Environment is the interface that customizes the global settings for the test cluster.
MySQLManager is an interface to a mysqld process manager, capable of starting/shutting down mysqld services and initializing them.

# Type aliases

FieldGenerator is a callback that generates the value of a random field in when seeding the database with random data.
HealthChecker is a callback that impements a service-specific health check It must return true if the service at the given `addr` is reachable, false otherwerise.