package
19.2.11-5-g2ecba8f+incompatible
Repository: https://github.com/hydgladiator/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.
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.
SchemaNewTypeCounter is to be implemented every time a new data type is used in a schema, i.e.
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.

# Constants

AlterAllPartitions represents an ALTER ALL PARTITIONS statement (ALTER PARTITION OF INDEX t@*).
Create represents the SHOW CREATE command.
Locality represents the SHOW LOCALITY command.
PartitionConstrainedScan represents when the optimizer was able to use partitioning to constrain a scan.
Partitions represents the SHOW PARTITIONS command.
Ranges represents the SHOW RANGES command.

# 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.
CreateStatisticsUseCounter is to be incremented whenever a non-automatic run of CREATE STATISTICS occurs.
CteUseCounter is to be incremented every time a CTE (WITH ...) is planned without error in a query.
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.
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.
HashJoinHintUseCounter is to be incremented whenever a query specifies a hash join via a query hint.
IfErrCounter is to be incremented upon type checking an IFERROR(...) expression or analogous.
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.
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.
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.
SubqueryUseCounter is to be incremented every time a subquery is planned.
TurnAutoStatsOffUseCounter is to be incremented whenever automatic stats collection is explicitly disabled.
TurnAutoStatsOnUseCounter is to be incremented whenever automatic stats collection is explicitly 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.