| Path | Synopsis |
|---|---|
| pkg/acceptance | |
| pkg/acceptance/cluster | |
| pkg/acceptance/localcluster | |
| pkg/acceptance/localcluster/tc | Package tc contains utility methods for using the Linux tc (traffic control) command to mess with the network links between cockroach nodes running on the local machine. |
| pkg/base | |
| pkg/bench | |
| pkg/blobs | Package blobs contains a gRPC service to be used for remote file access. |
| pkg/blobs/blobspb | |
| pkg/build | |
| pkg/ccl | |
| pkg/ccl/backupccl | |
| pkg/ccl/baseccl | |
| pkg/ccl/buildccl | |
| pkg/ccl/changefeedccl | |
| pkg/ccl/changefeedccl/cdctest | |
| pkg/ccl/cliccl | |
| pkg/ccl/cliccl/cliflagsccl | |
| pkg/ccl/followerreadsccl | Package followerreadsccl implements and injects the functionality needed to expose follower reads to clients. |
| pkg/ccl/gssapiccl | |
| pkg/ccl/importccl | |
| pkg/ccl/logictestccl | Package logictestccl houses the SQL logic tests that test CCL features. |
| pkg/ccl/partitionccl | |
| pkg/ccl/roleccl | |
| pkg/ccl/serverccl | Package serverccl houses tests that verify CCL behavior of a running CockroachDB server. |
| pkg/ccl/storageccl | |
| pkg/ccl/storageccl/engineccl | |
| pkg/ccl/storageccl/engineccl/enginepbccl | |
| pkg/ccl/utilccl | |
| pkg/ccl/utilccl/licenseccl | |
| pkg/ccl/utilccl/sampledataccl | |
| pkg/ccl/workloadccl | |
| pkg/ccl/workloadccl/allccl | |
| pkg/ccl/workloadccl/cliccl | |
| pkg/ccl/workloadccl/format | |
| pkg/ccl/workloadccl/roachmartccl | |
| pkg/cli | |
| pkg/cli/cliflags | |
| pkg/cli/syncbench | |
| pkg/cli/systembench | |
| pkg/cli/systembench/systembenchpb | |
| pkg/cmd/allocsim | |
| pkg/cmd/cmdutil | |
| pkg/cmd/cmp-protocol | cmp-protocol connects to postgres and cockroach servers and compares the binary and text pgwire encodings of SQL statements. |
| pkg/cmd/cmp-protocol/pgconnect | Package pgconnect provides a way to get byte encodings from a simple query. |
| pkg/cmd/cmp-sql | cmp-sql connects to postgres and cockroach servers and compares the results of SQL statements. |
| pkg/cmd/cockroach | This is the default entry point for a CockroachDB binary. |
| pkg/cmd/cockroach-oss | cockroach-oss is an entry point for a CockroachDB binary that excludes all CCL-licensed code. |
| pkg/cmd/cockroach-short | cockroach-short is an entry point for a CockroachDB binary that excludes certain components that are slow to build or have heavyweight dependencies. |
| pkg/cmd/cr2pg | cr2pg is a program that reads CockroachDB-formatted SQL files on stdin, modifies them to be Postgres compatible, and outputs them to stdout. |
| pkg/cmd/docgen | |
| pkg/cmd/docgen/extract | |
| pkg/cmd/fuzz | fuzz builds and executes fuzz tests. |
| pkg/cmd/generate-binary | This connects to a postgres server and crafts postgres-protocol message to encode its arguments into postgres' text and binary encodings. |
| pkg/cmd/github-post | Command github-post parses the JSON-formatted output from a Go test session, as generated by either 'go test -json' or './pkg.test | go tool test2json -t', and posts issues for any failed tests to GitHub. |
| pkg/cmd/github-pull-request-make | This utility detects new tests added in a given pull request, and runs them under stress in our CI infrastructure. |
| pkg/cmd/gossipsim | Package simulation provides tools meant to visualize or test aspects of a Cockroach cluster on a single host. |
| pkg/cmd/internal/issues | |
| pkg/cmd/prereqs | prereqs generates Make prerequisites for Go binaries. |
| pkg/cmd/protoc-gen-gogoroach | |
| pkg/cmd/publish-artifacts | |
| pkg/cmd/publish-provisional-artifacts | |
| pkg/cmd/reduce | reduce reduces SQL passed over stdin using cockroach demo. |
| pkg/cmd/returncheck | |
| pkg/cmd/roachlint | |
| pkg/cmd/roachprod | |
| pkg/cmd/roachprod/cloud | |
| pkg/cmd/roachprod/config | |
| pkg/cmd/roachprod/install | |
| pkg/cmd/roachprod/ssh | |
| pkg/cmd/roachprod-stress | |
| pkg/cmd/roachprod/ui | |
| pkg/cmd/roachprod/vm | |
| pkg/cmd/roachprod/vm/aws | |
| pkg/cmd/roachprod/vm/aws/terraformgen | Command terraformgen generate the terraform file used to configure AWS for multiregion support. |
| pkg/cmd/roachprod/vm/azure | Package azure allows roachprod to create instances within the Microsoft Azure cloud. |
| pkg/cmd/roachprod/vm/flagstub | |
| pkg/cmd/roachprod/vm/gce | |
| pkg/cmd/roachprod/vm/local | |
| pkg/cmd/roachtest | |
| pkg/cmd/smithcmp | smithcmp is a tool to execute random queries on a database. |
| pkg/cmd/smithtest | smithtest is a tool to execute sqlsmith tests on cockroach demo instances. |
| pkg/cmd/teamcity-trigger | teamcity-trigger launches a variety of nightly build jobs on TeamCity using its REST API. |
| pkg/cmd/testfilter | testfilter is a utility to manipulate JSON streams in [test2json] format. |
| pkg/cmd/uptodate | uptodate efficiently computes whether an output file is up-to-date with regard to its input files. |
| pkg/cmd/urlcheck | |
| pkg/cmd/urlcheck/lib/urlcheck | |
| pkg/cmd/workload | |
| pkg/cmd/wraprules | |
| pkg/cmd/zerosum | |
| pkg/col/coldata | |
| pkg/col/colserde | |
| pkg/col/colserde/arrowserde | Package arrowserde contains the flatbuffer generated code used for Apache Arrow serialization (and some small helpers associated with the generated code). |
| pkg/col/coltypes | |
| pkg/config | |
| pkg/config/zonepb | |
| pkg/gossip | Package gossip implements a protocol for sharing information between Cockroach nodes using an ad-hoc, peer-to-peer network. |
| pkg/gossip/resolver | |
| pkg/gossip/simulation | |
| pkg/internal/client | Package client and its KV API have been deprecated for external usage. |
| pkg/internal/client/requestbatcher | Package requestbatcher is a library to enable easy batching of roachpb requests. |
| pkg/internal/rsg | |
| pkg/internal/rsg/yacc | Package yacc parses .y files. |
| pkg/internal/sqlsmith | |
| pkg/jobs | |
| pkg/jobs/jobspb | |
| pkg/keys | Package keys manages the construction of keys for CockroachDB's key-value layer. |
| pkg/kv | Package kv provides a key-value API to an underlying cockroach datastore. |
| pkg/kv/kvbase | Package kvbase exports kv level interfaces to avoid dependency cycles. |
| pkg/roachpb | |
| pkg/rpc | |
| pkg/rpc/nodedialer | |
| pkg/security | |
| pkg/security/securitytest | Package securitytest embeds the TLS test certificates. |
| pkg/server | Package server implements the Cockroach storage node. |
| pkg/server/debug | |
| pkg/server/debug/goroutineui | |
| pkg/server/debug/pprofui | |
| pkg/server/diagnosticspb | |
| pkg/server/goroutinedumper | |
| pkg/server/heapprofiler | |
| pkg/server/serverpb | Package serverpb is a reverse proxy. |
| pkg/server/status | |
| pkg/server/status/statuspb | |
| pkg/server/telemetry | Package telemetry contains helpers for capturing diagnostics information. |
| pkg/settings | Package settings provides a central registry of runtime editable settings and accompanying helper functions for retrieving their current values. |
| pkg/settings/cluster | |
| pkg/sql | Package sql provides the user-facing API for access to a Cockroach datastore. |
| pkg/sql/backfill | |
| pkg/sql/colencoding | |
| pkg/sql/colexec | |
| pkg/sql/colexec/execerror | |
| pkg/sql/colexec/execgen | |
| pkg/sql/colexec/execpb | |
| pkg/sql/colexec/typeconv | |
| pkg/sql/colflow | |
| pkg/sql/colflow/colrpc | |
| pkg/sql/covering | |
| pkg/sql/delegate | |
| pkg/sql/distsql | |
| pkg/sql/execinfra | |
| pkg/sql/execinfrapb | |
| pkg/sql/flowinfra | |
| pkg/sql/lex | |
| pkg/sql/logictest | |
| pkg/sqlmigrations | |
| pkg/sql/mutations | |
| pkg/sql/opt | Package opt contains the Cockroach SQL optimizer. |
| pkg/sql/opt/bench | Package bench houses benchmarks for the SQL optimizer. |
| pkg/sql/opt/cat | Package cat contains interfaces that are used by the query optimizer to avoid including specifics of sqlbase structures in the opt code. |
| pkg/sql/opt/constraint | |
| pkg/sql/opt/exec | |
| pkg/sql/opt/exec/execbuilder | |
| pkg/sql/opt/idxconstraint | |
| pkg/sql/opt/memo | |
| pkg/sql/opt/norm | |
| pkg/sql/opt/opbench | |
| pkg/sql/opt/optbuilder | |
| pkg/sql/opt/optgen/exprgen | |
| pkg/sql/opt/optgen/lang | Package lang implements a language called Optgen, short for "optimizer generator". |
| pkg/sql/opt/ordering | Package ordering contains operator-specific logic related to orderings - whether ops can provide Required orderings, what orderings do they need to require from their children, etc. |
| pkg/sql/opt/props | |
| pkg/sql/opt/props/physical | |
| pkg/sql/opt/testutils | |
| pkg/sql/opt/testutils/opttester | |
| pkg/sql/opt/testutils/testcat | |
| pkg/sql/opt/testutils/testexpr | |
| pkg/sql/opt/xform | |
| pkg/sql/parser | |
| pkg/sql/parser/fuzz | |
| pkg/sql/pgwire | |
| pkg/sql/pgwire/hba | Package hba implements an hba.conf parser. |
| pkg/sql/pgwire/pgcode | Package pgcode defines the PostgreSQL 5-character support codes used throughout the CockroachDB source tree. |
| pkg/sql/pgwire/pgerror | |
| pkg/sql/pgwire/pgwirebase | Package pgwirebase contains type definitions and very basic protocol structures to be used by both the pgwire package and by others (particularly by the sql package). |
| pkg/sql/physicalplan | |
| pkg/sql/physicalplan/replicaoracle | Package replicaoracle provides functionality for physicalplan to choose a replica for a range. |
| pkg/sql/privilege | |
| pkg/sql/querycache | |
| pkg/sql/row | |
| pkg/sql/rowcontainer | |
| pkg/sql/rowexec | |
| pkg/sql/rowflow | |
| pkg/sql/schemachange | |
| pkg/sql/scrub | |
| pkg/sql/sem/builtins | |
| pkg/sql/sem/transform | |
| pkg/sql/sem/tree | |
| pkg/sql/sessiondata | |
| pkg/sql/sqlbase | |
| pkg/sql/sqltelemetry | Package sqltelemetry contains telemetry counter definitions for various SQL features. |
| pkg/sql/sqlutil | |
| pkg/sql/stats | |
| pkg/sql/tests | |
| pkg/sql/types | |
| pkg/sql/vtable | |
| pkg/storage | Package storage provides access to the Store and Range abstractions. |
| pkg/storage/abortspan | |
| pkg/storage/apply | Package apply provides abstractions and routines associated with the application of committed raft entries to a replicated state machine. |
| pkg/storage/batcheval | |
| pkg/storage/batcheval/result | |
| pkg/storage/bulk | |
| pkg/storage/closedts | Package closedts houses the interfaces and basic definitions used by the various components of the closed timestamp subsystems. |
| pkg/storage/closedts/container | |
| pkg/storage/closedts/ctpb | |
| pkg/storage/closedts/minprop | Package minprop exports a main data structure, Tracker, which checkpoints closed timestamps and associated Raft Lease Applied indexes positions for which (under additional conditions) it is legal to serve follower reads. |
| pkg/storage/closedts/provider | |
| pkg/storage/closedts/provider/testutils | |
| pkg/storage/closedts/storage | |
| pkg/storage/closedts/transport | |
| pkg/storage/closedts/transport/testutils | |
| pkg/storage/cloud | |
| pkg/storage/compactor | |
| pkg/storage/constraint | |
| pkg/storage/copysets | Package copysets provides an implementation of copysets presented in https://web.stanford.edu/~skatti/pubs/usenix13-copysets.pdf. |
| pkg/storage/diskmap | |
| pkg/storage/engine | Package engine provides low-level storage. |
| pkg/storage/engine/enginepb | |
| pkg/storage/idalloc | |
| pkg/storage/intentresolver | |
| pkg/storage/protectedts | Package protectedts exports the interface to the protected timestamp subsystem which allows clients to prevent GC of expired data. |
| pkg/storage/protectedts/ptpb | |
| pkg/storage/raftentry | Package raftentry provides a cache for entries to avoid extra deserializations. |
| pkg/storage/rangefeed | |
| pkg/storage/rditer | |
| pkg/storage/reports | |
| pkg/storage/spanlatch | Package spanlatch provides a latch management structure for serializing access to keys and key ranges. |
| pkg/storage/spanset | |
| pkg/storage/split | |
| pkg/storage/stateloader | |
| pkg/storage/storagebase | |
| pkg/storage/storagepb | |
| pkg/storage/tscache | Package tscache provides a timestamp cache structure that records the maximum timestamp that key ranges were read from and written to. |
| pkg/storage/txnrecovery | |
| pkg/storage/txnwait | |
| pkg/testutils | |
| pkg/testutils/buildutil | |
| pkg/testutils/distsqlutils | |
| pkg/testutils/gossiputil | |
| pkg/testutils/jobutils | |
| pkg/testutils/keysutils | |
| pkg/testutils/lint | Package lint tests Go code for policy and style violations, as well as detecting suspicious constructs that are typically bugs. |
| pkg/testutils/lint/passes/descriptormarshal | Package descriptormarshal defines an suite of Analyzers that detects correct setting of timestamps when unmarshaling table descriptors. |
| pkg/testutils/lint/passes/hash | Package hash defines an Analyzer that detects correct use of hash.Hash. |
| pkg/testutils/lint/passes/timer | Package timer defines an Analyzer that detects correct use of timeutil.Timer. |
| pkg/testutils/lint/passes/unconvert | Package unconvert defines an Analyzer that detects unnecessary type conversions. |
| pkg/testutils/localtestcluster | |
| pkg/testutils/pgtest | |
| pkg/testutils/physicalplanutils | |
| pkg/testutils/reduce | Package reduce implements a reducer core for reducing the size of test failure cases. |
| pkg/testutils/reduce/reducesql | |
| pkg/testutils/serverutils | |
| pkg/testutils/sqlutils | |
| pkg/testutils/storageutils | |
| pkg/testutils/testcluster | |
| pkg/testutils/zerofields | |
| pkg/ts | Package ts provides a basic time series database on top of the underlying CockroachDB key/value datastore. |
| pkg/ts/catalog | |
| pkg/ts/testmodel | |
| pkg/ts/tspb | Package tspb is a reverse proxy. |
| pkg/ui | Package ui embeds the assets for the web UI into the Cockroach binary. |
| pkg/ui/distccl | Package distccl embeds the assets for the CCL version of the web UI into the Cockroach binary. |
| pkg/ui/distoss | Package distoss embeds the assets for the OSS version of the web UI into the Cockroach binary. |
| pkg/util | |
| pkg/util/arith | |
| pkg/util/binfetcher | |
| pkg/util/bitarray | |
| pkg/util/bufalloc | |
| pkg/util/cache | |
| pkg/util/caller | |
| pkg/util/causer | |
| pkg/util/cloudinfo | |
| pkg/util/contextutil | |
| pkg/util/ctxgroup | Package ctxgroup wraps golang.org/x/sync/errgroup with a context func. |
| pkg/util/duration | |
| pkg/util/encoding | |
| pkg/util/encoding/csv | Package csv reads and writes comma-separated values (CSV) files. |
| pkg/util/envutil | |
| pkg/util/errorutil | |
| pkg/util/errorutil/unimplemented | |
| pkg/util/fileutil | |
| pkg/util/flagutil | Package flagutil facilitates creation of rich flag types. |
| pkg/util/fsm | Package fsm provides an interface for defining and working with finite-state machines. |
| pkg/util/growstack | |
| pkg/util/grpcutil | |
| pkg/util/hlc | 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. |
| pkg/util/httputil | |
| pkg/util/humanizeutil | |
| pkg/util/interval | Package interval provides two implementations for an interval tree. |
| pkg/util/ipaddr | |
| pkg/util/json | |
| pkg/util/keysutil | |
| pkg/util/leaktest | Package leaktest provides tools to detect leaked goroutines in tests. |
| pkg/util/limit | |
| pkg/util/log | Package log implements logging. |
| pkg/util/log/logflags | |
| pkg/util/metric | Package metric provides server metrics (a.k.a. |
| pkg/util/mon | |
| pkg/util/netutil | |
| pkg/util/pretty | Package pretty prints documents based on a target line width. |
| pkg/util/protoutil | |
| pkg/util/quotapool | Package quotapool provides an abstract implementation of a pool of resources to be distributed among concurrent clients. |
| pkg/util/randutil | |
| pkg/util/retry | |
| pkg/util/ring | |
| pkg/util/sdnotify | Package sdnotify implements both sides of the systemd readiness protocol. |
| pkg/util/search | |
| pkg/util/shuffle | |
| pkg/util/stop | |
| pkg/util/stringarena | |
| pkg/util/stringencoding | |
| pkg/util/syncutil | |
| pkg/util/syncutil/singleflight | Package singleflight provides a duplicate function call suppression mechanism. |
| pkg/util/sysutil | Package sysutil is a cross-platform compatibility layer on top of package syscall. |
| pkg/util/timeofday | |
| pkg/util/timetz | |
| pkg/util/timeutil | |
| pkg/util/timeutil/pgdate | Package pgdate contains parsing functions and types for dates and times in a manner that is compatible with PostgreSQL. |
| pkg/util/tracing | |
| pkg/util/treeprinter | |
| pkg/util/uint128 | |
| pkg/util/uuid | |
| pkg/util/version | |
| pkg/workload | Package workload provides an abstraction for generators of sql query loads (and requisite initial data) as well as tools for working with these generators. |
| pkg/workload/bank | |
| pkg/workload/bulkingest | Package bulkingest defines a workload that is intended to stress some edge cases in our bulk-ingestion infrastructure. |
| pkg/workload/cli | |
| pkg/workload/debug | Package debug provides a workload subcommand under which useful workload utilities live. |
| pkg/workload/examples | |
| pkg/workload/faker | |
| pkg/workload/histogram | |
| pkg/workload/indexes | |
| pkg/workload/interleavedpartitioned | |
| pkg/workload/jsonload | |
| pkg/workload/kv | |
| pkg/workload/ledger | |
| pkg/workload/movr | |
| pkg/workload/querybench | |
| pkg/workload/querylog | |
| pkg/workload/queue | |
| pkg/workload/rand | |
| pkg/workload/sqlsmith | |
| pkg/workload/tpcc | |
| pkg/workload/tpccchecks | |
| pkg/workload/tpcds | |
| pkg/workload/tpch | |
| pkg/workload/workloadimpl | Package workloadimpl provides dependency-light helpers for implementing workload.Generators. |
| pkg/workload/workloadsql | |
| pkg/workload/ycsb | Package ycsb is the workload specified by the Yahoo! Cloud Serving Benchmark. |
Updated 2019-12-15. Refresh now. Tools for package owners.