# Packages
Package diagnosticspb is a generated protocol buffer package.
Package serverpb is a reverse proxy.
Package status is a generated protocol buffer package.
# Functions
ExpectedInitialRangeCount returns the expected number of ranges that should be on the server after initial (asynchronous) splits have been completed, assuming no additional information is added outside of the normal bootstrap process.
GetBootstrapSchema returns the schema which will be used to bootstrap a new server.
GetTotalMemory returns either the total system memory or if possible the cgroups available memory.
MakeConfig returns a Context with default values.
MakeTempStoreSpecFromStoreSpec creates a spec for a temporary store under the given StoreSpec's path.
NewNode returns a new instance of Node.
NewServer creates a Server from a server.Context.
SetOpenFileLimitForOneStore sets the soft limit for open file descriptors when there is only one store.
WaitForInitialSplits waits for the expected number of initial ranges to be populated in the meta2 table.
# Constants
DebugRemoteAny allows all access to /debug/requests.
DebugRemoteLocal allows only host-local access to /debug/requests.
DebugRemoteOff disallows access to /debug/requests.
128 MB.
100MB */.
FirstNodeID is the node ID of the first node in a new cluster.
TestUser is a fixed user used in unittests.
# Variables
ClusterSettings is populated by pkg/cli at init time.
GracefulDrainModes is the standard succession of drain modes entered for a graceful shutdown.
LicenseCheckFn is used to check if the current cluster has any enterprise features enabled.
TestServerFactory can be passed to serverutils.InitTestServerFactory.
# Structs
Config holds parameters needed to setup a server.
ListenError is returned from Start when we fail to start listening on either the main Cockroach port or the HTTP port, so that the CLI can instruct the user on what might have gone wrong.
A Node manages a map of stores (by store ID) for which it serves traffic.
Server is the cockroach server node.
A TestServer encapsulates an in-memory instantiation of a cockroach node with a single store.
# Type aliases
DebugRemoteMode controls who can access /debug/requests.
Engines is a container of engines, allowing convenient closing.
MaxOffsetType stores the configured MaxOffset.