package
20.2.19+incompatible
Repository: https://github.com/cockroachdb/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
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.
MakeBaseConfig returns a BaseConfig with default values.
MakeConfig returns a Config for the system tenant with default values.
MakeKVConfig returns a KVConfig with default values.
MakeSQLConfig returns a SQLConfig 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.
StartTenant starts a stand-alone SQL server against a KV backend.

# Constants

128 MB.
Context defaults.
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

ConfigureOIDC is a hook for the `oidcccl` library to add OIDC login support.
DeprecatedDrainParameter the special value that must be passed in DrainRequest.DeprecatedProbeIndicator to signal the drain request is not a probe.
ErrClusterInitialized is reported when the Bootstrap RPC is run on a node that is already part of an initialized cluster.
ErrIncompatibleBinaryVersion is returned when a CRDB node with a binary version X attempts to join a cluster with an active version that's higher.
TestServerFactory can be passed to serverutils.InitTestServerFactory.

# Structs

BaseConfig holds parameters that are needed to setup either a KV or a SQL server.
Config holds the parameters needed to set up a combined KV and SQL server.
KVConfig holds the parameters that (together with a BaseConfig) allow setting up a KV 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.
SQLConfig holds the parameters that (together with a BaseConfig) allow setting up a SQL server.
SQLServer encapsulates the part of a CRDB server that is dedicated to SQL processing.
TestingKnobs groups testing knobs for the Server.
A TestServer encapsulates an in-memory instantiation of a cockroach node with a single store.
TestTenant is an in-memory instantiation of the SQL-only process created for each active Cockroach tenant.

# Interfaces

OIDC is an interface that an OIDC-based authentication module should implement to integrate with the rest of the node's functionality.
StmtDiagnosticsRequester is the interface into *stmtdiagnostics.Registry used by AdminUI endpoints.

# Type aliases

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