package
20.1.0-rc.2+incompatible
Repository: https://github.com/cargillb/cockroachdb.git
Documentation: pkg.go.dev

# Functions

BinOpCounter creates a telemetry counter for a scalar binary operator.
BuiltinCounter creates a telemetry counter for a built-in function.
CastOpCounter creates a telemetry counter for a scalar cast operator.
CmpOpCounter creates a telemetry counter for a scalar comparison operator.
IncIAMAlterCounter is to be incremented every time an ALTER ROLE happens.
IncIAMCreateCounter is to be incremented every time a CREATE ROLE happens.
IncIAMDropCounter is to be incremented every time a DROP ROLE happens.
IncIAMGrantCounter is to be incremented every time a GRANT ROLE happens.
IncIAMGrantPrivilegesCounter is to be incremented every time a GRANT <privileges> happens.
IncIAMOptionCounter is to be incremented every time a CREATE/ALTER role with an OPTION (ie.
IncIAMRevokeCounter is to be incremented every time a REVOKE ROLE happens.
IncIAMRevokePrivilegesCounter is to be incremented every time a REVOKE <privileges> happens.
IncrementPartitioningCounter is used to increment the telemetry counter for a particular partitioning operation.
IncrementShowCounter is used to increment the telemetry counter for a particular show command.
OptNodeCounter should be incremented every time a node of the given type is encountered at the end of the query optimization (i.e.
RecordError processes a SQL error.
ReportJoinReorderLimit is to be called whenever the reorder joins session variable is set.
SchemaChangeAlterCounter behaves the same as SchemaChangeAlterCounterWithExtra but with no extra metadata.
SchemaChangeAlterCounterWithExtra is to be incremented for ALTER schema changes.
SchemaChangeCreateCounter is to be incremented every time a CREATE schema change was made.
SchemaChangeDropCounter is to be incremented every time a DROP schema change was made.
SchemaJobControlCounter is to be incremented every time a job control action is taken.
SchemaNewColumnTypeQualificationCounter is to be incremented every time a new qualification is used for a newly created column.
SchemaNewTypeCounter is to be incremented every time a new data type is used in a schema, i.e.
SchemaSetAuditModeCounter is to be incremented every time an audit mode is set.
SchemaSetZoneConfigCounter is to be incremented every time a ZoneConfig argument is parsed.
SerialColumnNormalizationCounter is to be incremented every time a SERIAL type is processed in a column definition.
UnaryOpCounter creates a telemetry counter for a scalar unary operator.
UnimplementedClientStatusParameterCounter is to be incremented every time a client attempts to configure a status parameter that's not supported upon session initialization.
UnimplementedSessionVarValueCounter is to be incremented every time a client attempts to set a compatitibility session var to an unsupported value.
VecModeCounter is to be incremented every time the vectorized execution mode is changed (including turned off).
WindowFunctionCounter is to be incremented every time a window function is being planned.

# Constants

AlterAllPartitions represents an ALTER ALL PARTITIONS statement (ALTER PARTITION OF INDEX t@*).
AlterRole is used when an ALTER ROLE / USER is the operation.
Constraints represents the SHOW CONSTRAINTS command.
Create represents the SHOW CREATE command.
CreateRole is used when an CREATE ROLE / USER is the operation.
Indexes represents the SHOW INDEXES command.
Jobs represents the SHOW JOBS command.
Locality represents the SHOW LOCALITY command.
OnDatabase is used when a GRANT/REVOKE is happening on a database.
OnTable is used when a GRANT/REVOKE is happening on a table.
PartitionConstrainedScan represents when the optimizer was able to use partitioning to constrain a scan.
Partitions represents the SHOW PARTITIONS command.
Queries represents the SHOW QUERIES command.
RangeForRow represents the SHOW RANGE FOR ROW command.
Ranges represents the SHOW RANGES command.
Role is used when the syntax used is the ROLE version (ie.
Roles represents the SHOW ROLES command.
User is used when the syntax used is the USER version (ie.

# Variables

ArrayCastCounter is to be incremented when type checking all casts that involve arrays.
ArrayConstructorCounter is to be incremented upon type checking of ARRAY[...] expressions/.
ArrayFlattenCounter is to be incremented upon type checking of ARRAY(...) expressions.
ArraySubscriptCounter is to be incremented upon type checking an array subscript expression x[...].
BinaryDecimalInfinityCounter is to be incremented every time a client requests the binary encoding for a decimal infinity, which is not well defined in the pg protocol (#32489).
CancelRequestCounter is to be incremented every time a pgwire-level cancel request is received from a client.
CorrelatedSubqueryUseCounter is to be incremented every time a correlated subquery has been processed during planning.
CreateInterleavedTableCounter is to be incremented every time an interleaved table is being created.
CreateStatisticsUseCounter is to be incremented whenever a non-automatic run of CREATE STATISTICS occurs.
CreateTempSequenceCounter is to be incremented every time a TEMP SEQUENCE has been created.
CreateTempTableCounter is to be incremented every time a TEMP TABLE has been created.
CreateTempViewCounter is to be incremented every time a TEMP VIEW has been created.
CteUseCounter is to be incremented every time a CTE (WITH ...) is planned without error in a query (this includes both recursive and non-recursive CTEs).
DefaultIntSize4Counter is to be incremented every time a client change the default_int_size variable to its non-default value 4.
DistSQLExecCounter is to be incremented whenever a query is distributed across multiple nodes.
ExplainAnalyzeDebugUseCounter is to be incremented whenever EXPLAIN ANALYZE (DEBUG) is run.
ExplainAnalyzeUseCounter is to be incremented whenever EXPLAIN ANALYZE is run.
ExplainDistSQLUseCounter is to be incremented whenever EXPLAIN (DISTSQL) is run.
ExplainOptUseCounter is to be incremented whenever EXPLAIN (OPT) is run.
ExplainOptVerboseUseCounter is to be incremented whenever EXPLAIN (OPT, VERBOSE) is run.
ExplainPlanUseCounter is to be incremented whenever vanilla EXPLAIN is run.
ExplainVecUseCounter is to be incremented whenever EXPLAIN (VEC) is run.
ForceSavepointRestartCounter is to be incremented every time a client customizes the session variable force_savepoint_restart to a non-empty string.
ForeignKeyCascadesUseCounter is to be incremented every time a mutation involves a cascade.
ForeignKeyChecksUseCounter is to be incremented every time a mutation has foreign key checks and the checks are planned by the optimizer.
ForeignKeyLegacyUseCounter is to be incremented every time a mutation involves foreign key checks or cascades but uses the legacy execution path (either because it has cascades or because the optimizer_foreign_keys setting is off).
HashJoinHintUseCounter is to be incremented whenever a query specifies a hash join via a query hint.
HashShardedIndexCounter is to be incremented every time a hash sharded index is created.
IfErrCounter is to be incremented upon type checking an IFERROR(...) expression or analogous.
IndexHintDeleteUseCounter is to be incremented whenever a query specifies an index hint in a DELETE.
IndexHintSelectUseCounter is to be incremented whenever a query specifies an index hint in a SELECT.
IndexHintUpdateUseCounter is to be incremented whenever a query specifies an index hint in an UPDATE.
IndexHintUseCounter is to be incremented whenever a query specifies an index hint.
InterleavedPortalRequestCounter is to be incremented every time an open portal attempts to interleave work with another portal.
InterleavedTableJoinCounter is to be incremented whenever an InterleavedTableJoin is planned.
InvertedIndexCounter is to be incremented every time an inverted index is created.
JoinAlgoCrossUseCounter is to be incremented whenever a cross join node is planned.
JoinAlgoHashUseCounter is to be incremented whenever a hash join node is planned.
JoinAlgoLookupUseCounter is to be incremented whenever a lookup join node is planned.
JoinAlgoMergeUseCounter is to be incremented whenever a merge join node is planned.
JoinTypeAntiUseCounter is to be incremented whenever an anti-join node is planned.
JoinTypeFullUseCounter is to be incremented whenever a full outer join node is planned.
JoinTypeInnerUseCounter is to be incremented whenever an inner join node is planned.
JoinTypeLeftUseCounter is to be incremented whenever a left or right outer join node is planned.
JoinTypeSemiUseCounter is to be incremented whenever a semi-join node is planned.
LargeLShiftArgumentCounter is to be incremented upon evaluating a scalar expressions a << b when b is larger than 64 or negative.
LargeRShiftArgumentCounter is to be incremented upon evaluating a scalar expressions a >> b when b is larger than 64 or negative.
LateralJoinUseCounter is to be incremented whenever a query uses the LATERAL keyword.
LookupJoinHintUseCounter is to be incremented whenever a query specifies a lookup join via a query hint.
MergeJoinHintUseCounter is to be incremented whenever a query specifies a merge join via a query hint.
PortalWithLimitRequestCounter is to be incremented every time a portal request is made.
RecursiveCteUseCounter is to be incremented every time a recursive CTE (WITH RECURSIVE...) is planned without error in a query.
SchemaChangeInExplicitTxnCounter is to be incremented every time a schema change is scheduled using an explicit transaction.
SecondaryIndexColumnFamiliesCounter is a counter that is incremented every time a secondary index that is separated into different column families is created.
StatementDiagnosticsCollectedCounter is to be incremented whenever a query is run with diagnostic collection (as a result of a user request through the UI).
SubqueryUseCounter is to be incremented every time a subquery is planned.
TempObjectCleanerDeletionCounter is to be incremented every time a temporary schema has been deleted by the temporary object cleaner.
TurnAuthAuditingOffUseCounter counts how many time connection audit logs were disabled.
TurnAuthAuditingOnUseCounter counts how many time connection audit logs were enabled.
TurnAutoStatsOffUseCounter is to be incremented whenever automatic stats collection is explicitly disabled.
TurnAutoStatsOnUseCounter is to be incremented whenever automatic stats collection is explicitly enabled.
TurnConnAuditingOffUseCounter counts how many time connection audit logs were disabled.
TurnConnAuditingOnUseCounter counts how many time connection audit logs were enabled.
UncategorizedErrorCounter is to be incremented every time an error flows to the client without having been decorated with a pg error.
VecExecCounter is to be incremented whenever a query runs with the vectorized execution engine.

# Type aliases

PartitioningTelemetryType is an enum used to represent the different partitioning related operations that we are recording telemetry for.
ShowTelemetryType is an enum used to represent the different show commands that we are recording telemetry for.