package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

MakeSystemDatabaseDesc constructs a copy of the system database descriptor.
MakeSystemTables produces a list of all tables in the system database.

# Constants

comments stores comments(database, table, column...).
These system tables are not part of the system config.
These system tables are part of the system config.
These system tables are part of the system config.
system.eventlog contains notable events from the cluster.
JobMessageTableSchema is the table that contains a history of messages a job wishes to be visible to a human inspecting that specific job.
JobProgressHistoryTableSchema is identical to job_progress, but is allowed to contain multiple rows for the same job_id.
JobProgressTableSchema is a table that contains one row per job reflecting that job's current progress for human consumption (e.g.
JobsRunStatsIdxPredicate is the predicate in jobs_run_stats_idx in JobsTable.
Note: this schema is changed in a migration (a progress column is added in a separate family).
JobStatusTableSchema is the table that contains the current, user-visible status of a job, which is typically its current phase of execution such as such as "backfilling" or "waiting for GC".
These system tables are not part of the system config.
Note: the column "nodeID" refers to the SQL instance ID.
LeaseTableSchema_V24_1 is the new session based leasing table format.
locations are used to map a locality specified by a node to geographic latitude, longitude coordinates, specified as degrees.
system.migrations stores completion records for upgrades performed by the upgrade package.
These system tables are part of the system config.
These system tables are not part of the system config.
protected_ts_meta stores a single row of metadata for the protectedts subsystem.
These system tables are not part of the system config.
rangelog is currently envisioned as a wide table; many different event types can be recorded to the table.
RegionLivenessTableSchema stores the liveness for a region.
replication_constraint_stats stores replication constraint statistics.
replication_critical_localities stores replication critical localities.
replication_stats stores replication statistics.
reports_meta stores reports metadata.
RoleIDSequenceSchema starts at 100 so we have reserved IDs for special roles such as root and admin.
role_members stores relationships between roles (role->role and role->user).
These system tables are part of the system config.
These system tables are not part of the system config.
These system tables are part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
SpanStatsBucketsTableSchema defines the schema to store keyvispb.SpanStats objects.
SpanStatsSamplesTableSchema defines the schema to store a keyvispb.Sample.
SpanStatsTenantBoundariesTableSchema stores the boundaries that a tenant wants KV to collect statistics for.
SpanStatsUniqueKeysTableSchema defines the schema to store the set of unique keys of all samples in SpanStatsSamplesTableSchema.
These system tables are not part of the system config.
These system tables are not part of the system config.
SQLStatsHashShardBucketCount is the number of buckets used in the hash sharded primary key in the sql stats tables.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
TODO(azhng): Currently we choose number of bucket for hash-sharding to be 8 for both statement statistics table and transaction statistics table.
StmtStatsHashColumnName is the name of the hash column of system.statement_statistics.
SystemDatabaseName is the name of the system database.
These system tables are not part of the system config.
SystemJobInfoTableSchema is the schema for the system.job_info table, which is used by jobs to store arbitrary "info".
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
table_statistics is used to track statistics collected about individual columns or groups of columns from every table in the database.
These system tables are part of the system config.
These system tables are not part of the system config.
Note: the "active" column is deprecated.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
These system tables are not part of the system config.
TxnStatsHashColumnName is the name of the hash column of system.transaction_statistics.
These system tables are not part of the system config.
UsersTableSchema represents the system.users table.
web_sessions are used to track authenticated user actions over stateless connections, such as the cookie-based authentication used by the Admin UI.
Zone settings per DB/Table.

# Variables

CommentsTable is the descriptor for the comments table.
DatabaseRoleSettingsTable holds default values for session variables for each role and database combination.
DescIDSequence is the descriptor for the descriptor ID sequence.
DescriptorTable is the descriptor for the descriptor table.
EventLogTable is the descriptor for the event log table.
JobsTable is the descriptor for the jobs table.
JoinTokensTable is the descriptor for the join tokens table.
LeaseTable is the descriptor for the leases table with a session based leasing table format.
LeaseTable_V23_2 is the descriptor for the leases table with an expiry based format.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
LocationsTable is the descriptor for the locations table.
MigrationsTable is the descriptor for the migrations table.
NamespaceTable is the descriptor for the namespace table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
RangeEventTable is the descriptor for the range log table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
TODO(andrei): In 20.1 we should add a foreign key reference to the reports_meta table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
TODO(andrei): In 20.1 we should add a foreign key reference to the reports_meta table.
TODO(andrei): In 20.1 we should add a foreign key reference to the reports_meta table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
RoleIDSequence is the descriptor for the role id sequence.
RoleMembersTable is the descriptor for the role_members table.
RoleOptionsTable is the descriptor for the role_options table.
ScheduledJobsTable is the descriptor for the scheduled jobs table.
SettingsTable is the descriptor for the settings table.
SpanConfigurationsTable is the descriptor for the system tenant's span configurations table.
SpanConfigurationsTableName represents system.span_configurations.
SpanCountTable is the descriptor for the split count table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
SQLInstancesTable is the descriptor for the sqlinstances table.
SqllivenessTable is the descriptor for the sqlliveness table.
StatementActivityTable is the descriptor for the SQL statement stats table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
TODO(andrei): Add a foreign key reference to the statement_diagnostics table when it no longer requires us to create an index on statement_diagnostics_id.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
StatementStatisticsTable is the descriptor for the SQL statement stats table.
SystemDatabaseSchemaBootstrapVersion is the system database schema version that should be used during bootstrap.
SystemDB is the descriptor for the system database.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
SystemJobProgressHistoryTable is described in comment on JobProgressHistoryTableSchema.
SystemJobProgressTable is described in comment on JobProgressTableSchema.
SystemJobStatusTable is described in comment on JobStatusTableSchema.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
TableStatistics table to hold statistics about columns and column groups.
TenantIDSequence is the descriptor for the descriptor ID sequence.
TenantSettingsTable is the descriptor for the tenant settings table.
These system config descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements.
TenantUsageTable is the descriptor for the tenant_usage table.
The tenant_usage table receives periodic updates from all SQL pods.
TransactionActivityTable is the descriptor for the SQL transaction stats table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
TransactionStatisticsTable is the descriptor for the SQL transaction stats table.
UITable is the descriptor for the ui table.
UsersTable is the descriptor for the users table.
These system descpb.TableDescriptor literals should match the descriptor that would be produced by evaluating one of the above `CREATE TABLE` statements for system tables that are not system config tables.
WebSessions table to authenticate sessions over stateless connections.
ZonesTable is the descriptor for the zones table.

# Structs

SystemTable wraps the catalog descriptor with extra fields that are used to validate the descriptor.