package
19.1.0-beta.20190304+incompatible
Repository: https://github.com/darinpp/cockroach.git
Documentation: pkg.go.dev

# Functions

DefaultRetryOptions should be used for retrying most network-dependent operations.
DefaultTestTempStorageConfig is the associated temp storage for DefaultTestStoreSpec that is in-memory.
DocsURL generates the URL to pageName in the version of the docs associated with this binary.
GetAbsoluteStorePath takes a (possibly relative) and returns the absolute path.
LookupAddr resolves the given address/host to an IP address.
NewLeaseManagerConfig initializes a LeaseManagerConfig with default values.
NewSizeSpec parses the string passed into a --size flag and returns a SizeSpec if it is correctly parsed.
NewStoreSpec parses the string passed into a --store flag and returns a StoreSpec if it is correctly parsed.
TempStorageConfigFromEnv creates a TempStorageConfig.
UpdateAddrs updates the listen and advertise port numbers with those found during the call to net.Listen().

# Constants

ChunkRaftCommandThresholdBytes is the threshold in bytes at which to chunk or otherwise limit commands being sent to Raft.
DefaultCertsDirectory is the default value for the cert directory flag.
DefaultHeartbeatInterval is how often heartbeats are sent from the transaction coordinator to a live transaction.
The default port for HTTP-for-humans.
100MB */.
DefaultMaxClockOffset is the default maximum acceptable clock offset value.
From IANA Service Name and Transport Protocol Port Number Registry.
DefaultTableDescriptorLeaseDuration is the default mean duration a lease will be acquired for.
DefaultTableDescriptorLeaseJitterFraction is the default factor that we use to randomly jitter the lease duration when acquiring a new lease and the lease renewal timeout.
DefaultTableDescriptorLeaseRenewalTimeout is the default time before a lease expires when acquisition to renew the lease begins.
32GB */.
MinimumStoreSize is the smallest size in bytes that a store can have.
NetworkTimeout is the timeout used for network operations.
ReplicationAuto means that ranges are replicated according to the production default zone config.
ReplicationManual means that the split and replication queues of all servers are stopped, and the test must manually control splitting and replication through the TestServer.
SlowRequestThreshold is the amount of time to wait before considering a request to be "slow".

# Variables

CheckEnterpriseEnabled returns a non-nil error if the requested enterprise feature is not enabled, including information or a link explaining how to enable it.
DefaultTestStoreSpec is just a single in memory store of 100 MiB with no special attributes.
DocsURLBase is the root URL for the version of the docs associated with this binary.
LicenseType returns what type of license the cluster is running with, or "OSS" if it is an OSS build.

# Structs

ClusterIDContainer is used to share a single Cluster ID instance between multiple layers.
Config is embedded by server.Config.
LeaseManagerConfig holds table lease manager parameters.
NodeIDContainer is used to share a single roachpb.NodeID instance between multiple layers.
RaftConfig holds raft tuning parameters.
SizeSpec contains size in different kinds of formats supported by CLI(%age, bytes).
StoreSpec contains the details that can be specified in the cli pertaining to the --store flag.
StoreSpecList contains a slice of StoreSpecs that implements pflag's value interface.
TempStorageConfig contains the details that can be specified in the cli pertaining to temp storage flags, specifically --temp-dir and --max-disk-temp-storage.
TestClusterArgs contains the parameters one can set when creating a test cluster.
TestingKnobs contains facilities for controlling various parts of the system for testing.
TestServerArgs contains the parameters one can set when creating a test server.

# Interfaces

ModuleTestingKnobs is an interface for testing knobs for a submodule.

# Type aliases

JoinListType is a slice of strings that implements pflag's value interface.
TestClusterReplicationMode represents the replication settings for a TestCluster.