package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Packages
Package assetbundle can expose a very rudimentary fs.FS given a .tar.zst-encoded source file.
Package buildutil provides a constant CrdbTestBuild.
Package container provides three container types: heap, list, and ring.
Package ctxgroup wraps golang.org/x/sync/errgroup with a context func.
Package encoding exposes some utilities for encoding data as bytes.
Package flagutil facilitates creation of rich flag types.
Package fsm provides an interface for defining and working with finite-state
machines.
Package grunning is a library that's able to retrieve on-CPU running time for individual goroutines.
Package hlc implements the Hybrid Logical Clock outlined in "Logical Physical
Clocks and Consistent Snapshots in Globally Distributed Databases", available
online at http://www.cse.buffalo.edu/tech-reports/2014-04.pdf.
Package interval provides two implementations for an interval tree.
Package leaktest provides tools to detect leaked goroutines in tests.
Package log implements logging.
Package metric provides server metrics (a.k.a.
Package num32 contains basic numeric functions that operate on scalar, vector,
and matrix float32 values.
Package pretty prints documents based on a target line width.
Package quantile computes approximate quantiles over an unbounded data stream within low memory and CPU bounds.
Package quotapool provides an abstract implementation of a pool of resources to be distributed among concurrent clients.
Package sdnotify implements both sides of the systemd readiness protocol.
Package span contains utilities for working with sets of spans.
Package startup provides functionality for retrying kv operations on server startup.
Package sysutil is a cross-platform compatibility layer on top of package syscall.
Package tracing encapsulates all tracing facilities used in CockroachDB.
# Functions
CombineUnique merges two ordered slices.
CRC32 computes the Castagnoli CRC32 of the given data.
EnableRacePreemptionPoints enables goroutine preemption points declared with RacePreempt for builds using the race build tag.
EqualPtrFields uses reflection to check two "mirror" structures for matching pointer fields that point to the same object.
Every is a convenience constructor for an EveryN object that allows a log message every n duration.
ExpandTabsInRedactableBytes expands tabs in the redactable byte slice, so that columns are aligned.
Filter returns a new slice that only contains elements from collection that satisfy predicate.
GetSingleRune decodes the string s as a single rune if possible.
GetSmallTrace returns a comma-separated string containing the top 5 callers from a given skip level.
InsertUnique inserts an element into an ordered slice if the element is not already present while maintaining the ordering property.
MakeFNV64 initializes a new FNV64 hash state.
MakeStringListBuilder creates a StringListBuilder, which is used to print out lists of items.
MakeUnresolvedAddr populates an UnresolvedAddr from a network and raw address string.
MakeUnresolvedAddrWithDefaults creates a new UnresolvedAddr from a network and raw address string, using the following defaults if not given:
- Network: tcp - Host: local hostname or 127.0.0.1 - Port: given default port.
Map returns a new slice containing the results of fn for each element within collection.
MapFrom returns a map populated with keys and values returned by fn.
MoveTopKToFront moves the top K elements to the front.
NewUnresolvedAddr creates a new UnresolvedAddr from a network and raw address string.
Pluralize returns a single character 's' unless n == 1.
RacePreempt adds a goroutine preemption point if CockroachDB was built with the race build tag and preemption points have been enabled.
RandString generates a random string of the desired length from the input alphabet.
RemoveTrailingSpaces splits the input string into lines, trims any trailing spaces from each line, then puts the lines back together.
ToLowerSingleByte returns the lowercase of a given single ASCII byte.
TruncateString truncates a string to a given number of runes.
# Constants
RaceEnabled is true if CockroachDB was built with the race build tag.
# Variables
IsolatedTestAddr is an address to use for tests that need extra isolation by using more addresses than 127.0.0.1 (support for this is platform-specific and only enabled on Linux).
TestAddr is an address to use for test servers.
# Structs
EveryN provides a way to rate limit spammy events.
FastIntMap is a replacement for map[int]int which is more efficient when both keys and values are small.
FNV64 encapsulates the hash state.
NoCopy may be embedded into structs which must not be copied after the first use.
StringListBuilder helps printing out lists of items.