package
20.1.0-beta.2+incompatible
Repository: https://github.com/mgartner/cockroach.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package serverpb is a reverse proxy.
No description provided by the author
Package telemetry contains helpers for capturing diagnostics information.

# Functions

CloseAllStickyInMemEngines closes and removes all sticky in memory engines.
CloseStickyInMemEngine closes the underlying engine and removes the sticky engine keyed by the given id.
CreateAuthSecret creates a secret, hash pair to populate a session auth token.
EncodeSessionCookie encodes a SessionCookie proto into an http.Cookie.
ExpectedInitialRangeCount returns the expected number of ranges that should be on the server after bootstrap.
GetBootstrapSchema returns the schema which will be used to bootstrap a new server.
IsWaitingForInit checks whether the provided error is because the node is still waiting for initialization.
MakeConfig returns a Context with default values.
NewNode returns a new instance of Node.
NewServer creates a Server from a server.Config.
SetOpenFileLimitForOneStore sets the soft limit for open file descriptors when there is only one store.

# Constants

128 MB.
Context defaults.
NB: this can't easily become a variable as the UI hard-codes it to 10s.
FirstNodeID is the node ID of the first node in a new cluster.
SessionCookieName is the name of the cookie used for HTTP auth.
TempDirPrefix is the filename prefix of any temporary subdirectory created.
TempDirsRecordFilename is the filename for the record file that keeps track of the paths of the temporary directories created.
TestUser is a fixed user used in unittests.

# Variables

ErrClusterInitialized is reported when the Boostrap RPC is ran on a node already part of an initialized cluster.
GracefulDrainModes is the standard succession of drain modes entered for a graceful shutdown.
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.
TestingKnobs groups testing knobs for the Server.
A TestServer encapsulates an in-memory instantiation of a cockroach node with a single store.

# Type aliases

Engines is a container of engines, allowing convenient closing.
MaxOffsetType stores the configured MaxOffset.