# FrequentStringsSketch

`FREQUENTSTRINGSSKETCH` is an estimation data-sketch function which can be used to estimate the frequency of an item. It is based on [Apache Datasketches library](https://datasketches.apache.org/docs/Frequency/FrequentItemsOverview.html) and returns a serialized sketch object which can be merged with other sketches.

## Signature

> FREQUENTSTRINGSSKETCH(column, maxMapSize=256) -> Base64 encoded sketch object

* `column` (required): Name of the column to aggregate on. Needs to be a type which can be cast into 'STRING'.
* `maxMapSize`: This value specifies the maximum physical length of the internal hash map. The maxMapSize must be a power of 2 and the default value is 256.

## Usage Example

```sql
select FREQUENTSTRINGSSKETCH(AirlineID, 16) from airlineStats
```

| frequentstringssketch(AirlineID) |
| -------------------------------- |
| BAEKCAUAAAAOAA...                |

Which can be used, for example in Java as:

```java
byte[] byteArr = Base64.getDecoder().decode(encodedSketch);
ItemsSketch<String> sketch = ItemsSketch.getInstance(Memory.wrap(byteArr), new ArrayOfStringsSerDe());

ItemsSketch.Row[] items = sketch.getFrequentItems(ErrorType.NO_FALSE_NEGATIVES);
for (int i = 0; i < items.length; i++) {
  ItemsSketch.Row item = items[i];
  System.out.printf("Airline: %s, Frequency: %d %n", item.getItem(), item.getEstimate());
}
```

For more examples on the sketch API, refer to the Datasketches [documentation](https://datasketches.apache.org/docs/Frequency/FrequentItemsJavaExample.html).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pinot.apache.org/release-1.3.0/configuration-reference/functions/frequentstringssketch.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.