package
23.2.20+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultStartOpts returns a StartOpts populated with default values.
DefaultStopOpts returns a StopOpts populated with default values.
Graceful performs a graceful stop of the cockroach process.
InMemoryDB can be used to configure StartOpts that start in-memory cockroach processes.
NewNodeListOptionRange returns a NodeListOption between start and end inclusive.
NewStartOpts returns a StartOpts populated with default values when called with no options.
NewStopOpts returns a StopOpts populated with default values when called with no options.
NoBackupSchedule can be used to generate StartOpts that skip the creation of the default backup schedule.
No description provided by the author
No description provided by the author
DefaultStartSharedVirtualClusterOpts returns StartOpts for starting a shared process virtual cluster with the given name.
StartVirtualClusterOpts returns StartOpts for starting an external process virtual cluster with the given name and on the given nodes.
StopSharedVirtualClusterOpts creates StopOpts that can be used to stop the shared process virtual cluster with the given name.
StopVirtualClusterOpts returns stop options that can be used to stop the SQL instance process serving the virtual cluster with the given name.
StorageCluster indicates the set of nodes in the cluster that should be used as storage cluster when starting a separate process virtual cluster.
No description provided by the author
VirtualClusterInstance can be used to indicate the SQL instance to start or stop.
No description provided by the author
WithInitTarget allows the caller to configure which node is used as `InitTarget` when starting cockroach.

# Structs

No description provided by the author
NodeLister is a helper to create `option.NodeListOption`s.
StartOpts is a type that combines the start options needed by roachprod and roachtest.
StopOpts is a type that combines the stop options needed by roachprod and roachtest.

# Interfaces

Option is an interface used to configure operations against a Cluster.

# Type aliases

A NodeListOption is a slice of roachprod node identifiers.
StartStopOption allows us to apply optional customizations to start or stop options.