avgValueIntegerSumTupleSketch

This section contains reference documentation for the AVGVALUEINTEGERSUMTUPLESKETCH function.

The Tuple Sketch is an extension of the Theta Sketch. Tuple sketches store an additional summary value with each retained entry which makes the sketch ideal for summarizing attributes such as impressions or clicks. Tuple sketches are interoperable with the Theta Sketch and enable set operations over a stream of data, and can also be used for cardinality estimation.

Signature

avgValueIntegerSumTupleSketch(<tupleSketchColumn>, <tupleSketchParams>) -> Long

• tupleSketchColumn (required): Name of the column to aggregate on. This must be an existing tuple sketch serialized as bytes.

• tupleSketchParams (required): Semicolon-separated parameter string for constructing the intermediate tuple-sketches.

  • The supported parameters are:

  • nominalEntries: The nominal entries used to create the sketch. (Default 65536)

  • accumulatorThreshold: How many sketches should be kept in memory before merging. (Default 2)

These examples are based on the Batch Quick Start. A new Tuple Sketch metric called playerHomeRuns was created during ingestion by updating the ingestion config as follows:

	"ingestionConfig": {
		"transformConfigs": [
			{
				"columnName": "playerHomeRuns",
				"transformFunction": "toIntegerSumTupleSketch(playerID, homeRuns)"
			}
		]
	}

The avgValueIntegerSumTupleSketch function can be used to combine the summary values from the random sample stored within the Tuple sketch and formulate an estimate for an average that applies to the entire dataset. The average should be interpreted as applying to each key tracked by the sketch - for example, average home runs per player.

select avgValueIntegerSumTupleSketch(playerHomeRuns) as value
from baseballStats 

value
16

select avgValueIntegerSumTupleSketch(playerHomeRuns, 'nominalEntries=4096;accumulatorThreshold=10') as value
from baseballStats 

value
12