package
0.0.0-20160920194302-ad86efcaa21b
Repository: https://github.com/a10y/cockroach.git
Documentation: pkg.go.dev

# Packages

Package distsql is a generated protocol buffer package.
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 sqlbase is a generated protocol buffer package.
No description provided by the author

# Functions

Backup exports a snapshot of every kv entry into ranged sstables.
CreateTestTableDescriptor converts a SQL string to a table for test purposes.
GetTableDesc returns the table descriptor for the table with 'id'.
GetZoneConfig returns the zone config for the object with 'id'.
Ingest loads some data in an sstable into an empty range.
IntersectHalfOpen returns the common range between two key intervals or (nil, nil) if there is no common range.
IsVirtualDatabase checks if the provided name corresponds to a virtual database.
MakeEventLogger constructs a new EventLogger.
MakeRekeyMVCCKeyValFunc takes an iterator function for MVCCKeyValues and returns a new iterator function where the keys are rewritten inline to the have the given table ID.
NewDummyExecutor creates an empty Executor that is used for certain tests.
NewExecutor creates an Executor and registers a callback on the system config.
NewLeaseManager creates a new LeaseManager.
NewSchemaChangeManager returns a new SchemaChangeManager.
NewSchemaChangerForTesting only for tests.
NewSession creates and initializes new Session object.
Restore imports a SQL table (or tables) from a set of non-overlapping sstable files.
TestDisableTableLeases disables table leases and returns a function that can be used to enable it.

# Constants

The txn has encoutered a (non-retriable) error.
CheckDeletes checks if rows reference a changed value.
CheckInserts checks if a new/changed value references an existing row.
CheckUpdates checks all references (CheckDeletes+CheckInserts).
ColumnTruncateAndBackfillChunkSize is the maximum number of rows of keys processed per chunk during the column truncate or backfill.
The KV txn has been committed successfully through a RELEASE.
EventLogAlterTable is recorded when a table is altered.
EventLogCreateDatabase is recorded when a database is created.
EventLogCreateIndex is recorded when an index is created.
EventLogCreateTable is recorded when a table is created.
EventLogCreateView is recorded when a view is created.
EventLogDropDatabase is recorded when a database is dropped.
EventLogDropIndex is recorded when an index is dropped.
EventLogDropTable is recorded when a table is dropped.
EventLogDropView is recorded when a view is dropped.
EventLogFinishSchemaChange is recorded when a previously initiated schema change has completed.
EventLogNodeJoin is recorded when a node joins the cluster.
EventLogNodeRestart is recorded when an existing node rejoins the cluster after being offline.
EventLogReverseSchemaChange is recorded when an in-progress schema change encounters a problem and is reversed.
IndexBackfillChunkSize is the maximum number of rows processed per chunk during the index backfill.
No txn is in scope.
A txn is in scope.
The txn has encoutered a retriable error.
TableTruncateChunkSize is the size of a chunk during a table truncation/drop operation.

# Variables

LeaseDuration is the mean duration a lease will be acquired for.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
Fully-qualified names for metrics.
MinLeaseDuration is the minimum duration a lease will have remaining upon acquisition.
MinSchemaChangeLeaseDuration is the minimum duration a lease will have remaining upon acquisition.
SchemaChangeLeaseDuration is the duration a lease will be acquired for.

# Structs

CopyDataBlock represents a data block of a COPY FROM statement.
An EventLogger exposes methods used to record events to the event table.
An Executor executes SQL statements.
An ExecutorConfig encompasses the auxiliary objects and configuration required to create an executor.
ExecutorTestingKnobs is part of the context used to control parts of the system during testing.
InternalExecutor can be used internally by cockroach to execute SQL statements without needing to open a SQL connection.
LeaseManager manages acquiring and releasing per-table leases.
LeaseManagerTestingKnobs contains test knobs.
LeaseState holds the state for a lease.
LeaseStore implements the operations for acquiring and releasing leases and publishing a new version of a descriptor.
LeaseStoreTestingKnobs contains testing knobs.
PreparedPortal is a PreparedStatement that has been bound with query arguments.
PreparedPortals is a mapping of PreparedPortal names to their corresponding PreparedPortals.
PreparedStatement is a SQL statement that has been parsed and the types of arguments and results have been determined.
PreparedStatements is a mapping of PreparedStatement names to their corresponding PreparedStatements.
Result corresponds to the execution of a single SQL statement.
ResultColumn contains the name and type of a SQL "cell".
RowContainer is a container for rows of DTuples which tracks the approximate amount of memory allocated for row data.
SchemaChangeManager processes pending schema changes seen in gossip updates.
SchemaChangeManagerTestingKnobs for the SchemaChangeManager.
SchemaChanger is used to change the schema on a table.
Session contains the state of a SQL client connection.
SessionArgs contains arguments for creating a new Session with NewSession().
StatementResults represents a list of results from running a batch of SQL statements, plus some meta info about the batch.
TestingSchemaChangerCollection is an exported (for testing) version of schemaChangerCollection.
WrappableMemoryAccount encapsulates a MemoryAccount to give it the W() method below.
WrappedMemoryAccount is the transient structure that carries the extra argument to the MemoryAccount APIs.

# Interfaces

DatabaseAccessor provides helper methods for using SQL database descriptors.
DescriptorAccessor provides helper methods for using descriptors to SQL objects.
SchemaAccessor provides helper methods for using the SQL schema.

# Type aliases

EventLogType represents an event type that can be recorded in the event log.
FKCheck indicates a kind of FK check (delete, insert, or both).
ResultColumns is the type used throughout the sql module to describe the column types of a table.
ResultList represents a list of results for a list of SQL statements.
StatementFilter is the type of callback that ExecutorTestingKnobs.StatementFilter takes.
SyncSchemaChangersFilter is the type of a hook to be installed through the ExecutorContext for blocking or otherwise manipulating schema changers run through the sync schema changers path.
TxnStateEnum represents the state of a SQL txn.