package
2.1.0-alpha.20180416+incompatible
Repository: https://github.com/coyle/cockroach.git
Documentation: pkg.go.dev
# Functions
DefaultDBContext returns (a copy of) the default options for NewDBWithContext.
IncrementValRetryable increments a key's value by a specified amount and returns the new value.
LegacyRangeLookup performs the same operation as RangeLookup, but does so using a DeprecatedRangeLookupRequest.
NewDB returns a new DB.
NewDBWithContext returns a new DB with the given parameters.
NewLeaseManager allocates a new LeaseManager.
NewTxn returns a new txn.
NewTxnWithProto is like NewTxn, except it returns a new txn with the provided Transaction proto.
RangeLookup is used to look up RangeDescriptors - a RangeDescriptor is a metadata structure which describes the key range and replica locations of a distinct range in the cluster.
RangeLookupForVersion performs the same operation as RangeLookup, but does so using either RangeLookup or LegacyRangeLookup, depending on the provided cluster version.
SendWrapped is identical to SendWrappedWith with a zero header.
SendWrappedWith is a convenience function which wraps the request in a batch and sends it via the provided Sender and headers.
TestingIsRangeLookup returns if the provided BatchRequest looks like a single RangeLookup scan.
TestingIsRangeLookupRequest returns if the provided Request looks like a single RangeLookup scan.
Wrap returns a Sender which applies the given function before delegating to the supplied Sender.
# Constants
DefaultLeaseDuration is the duration a lease will be acquired for if no duration was specified in a LeaseManager's options.
LeafTxn specifies this sender is for one of potentially many distributed client transactions.
RootTxn specifies this sender is the root transaction, and is responsible for aggregating all transactional state (see TxnCoordMeta) and finalizing the transaction.
# Variables
No description provided by the author
No description provided by the author
# Structs
AutoCommitError wraps a non-retryable error coming from auto-commit.
Batch provides for the parallel execution of a number of database operations.
DB is a database handle to a single cockroach cluster.
DBContext contains configuration parameters for DB.
KeyValue represents a single key/value pair.
Lease contains the state of a lease on a particular key.
LeaseManager provides functionality for acquiring and managing leases via the kv api.
LeaseManagerOptions are used to configure a new LeaseManager.
LeaseNotAvailableError indicates that the lease the caller attempted to acquire is currently held by a different client.
No description provided by the author
Result holds the result for a single DB or Txn operation (e.g.
Txn is an in-progress distributed database transaction.
TxnExecOptions controls how Exec() runs a transaction and the corresponding closure.
# Interfaces
Sender is the interface used to call into a CockroachDB instance.
TxnSender is the interface used to call into a CockroachDB instance when sending transactional requests.
TxnSenderFactory is the interface used to create new instances of TxnSender.
# Type aliases
SenderFunc is an adapter to allow the use of ordinary functions as Senders.
TxnSenderFactoryFunc is an adapter to allow the use of ordinary functions as TxnSenderFactories.
TxnSenderFunc is an adapter to allow the use of ordinary functions as TxnSenders with GetMeta or AugmentMeta panicing with unimplemented.
TxnType specifies whether a transaction is the root (parent) transaction, or a leaf (child) in a tree of client.Txns, as is used in a DistSQL flow.