Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Búsqueda de texto completo con índices de texto

Los índices de texto (también conocidos como índices invertidos) permiten realizar búsquedas de texto completo rápidas en datos de texto. Un índice de texto almacena una correspondencia entre tokens y los números de fila que contienen cada token. Los tokens se generan mediante un proceso llamado tokenización. Por ejemplo, el tokenizador predeterminado de ClickHouse convierte la frase en inglés "The cat likes mice." en los tokens ["The", "cat", "likes", "mice"].

Como ejemplo, suponga una tabla con una sola columna y tres filas

1: The cat likes mice.
2: Mice are afraid of dogs.
3: I have two dogs and a cat.

Los tokens correspondientes son:

1: The, cat, likes, mice
2: Mice, are, afraid, of, dogs
3: I, have, two, dogs, and, a, cat

Normalmente preferimos buscar sin distinguir entre mayúsculas y minúsculas, por lo que pasamos los tokens a minúsculas:

1: the, cat, likes, mice
2: mice, are, afraid, of, dogs
3: i, have, two, dogs, and, a, cat

También eliminaremos palabras vacías como "I", "the" y "and", ya que aparecen en casi todas las filas:

1: cat, likes, mice
2: mice, afraid, dogs
3: have, two, dogs, cat

Un índice de texto contiene, por tanto, la siguiente información:

afraid : [2]
cat    : [1, 3]
dogs   : [2, 3]
have   : [3]
likes  : [1]
mice   : [1]
two    : [3]

Dado un token de búsqueda, esta estructura de índice permite encontrar rápidamente todas las filas que coinciden.

Crear un índice de texto

Los índices de texto están disponibles de forma general (GA) en ClickHouse 26.2 y versiones posteriores. En estas versiones, no es necesario configurar ninguna opción especial para usar el índice de texto. Recomendamos encarecidamente usar ClickHouse >= 26.2 para casos de uso en producción.

Para crear un índice de texto, use la siguiente sintaxis:

Querysql
CREATE TABLE table
(
    key UInt64,
    str String,
    INDEX text_idx str TYPE text(
                                -- Mandatory parameters:
                                tokenizer = splitByNonAlpha
                                            | splitByString[(S)]
                                            | splitByRegexp(re)
                                            | asciiCJK
                                            | chinese[(granularity)]
                                            | icu(locale)
                                            | japanese
                                            | ngrams[(N)]
                                            | sparseGrams[(min_length[, max_length[, min_cutoff_length]])]
                                            | array
                                -- Optional parameters:
                                [, preprocessor = expression(str)]
                                [, postprocessor = expression(str)]
                                [, support_phrase_search = 0 | 1 ] -- experimental
                                -- Optional advanced parameters:
                                [, dictionary_block_size = D]
                                [, dictionary_block_frontcoding_compression = B]
                                [, posting_list_block_size = C]
                                [, posting_list_codec = 'none' | 'bitpacking' ]
                            )
)
ENGINE = MergeTree
ORDER BY key

Los índices de texto pueden definirse en columnas de estos tipos:

También se admiten columnas de tipo Nullable(T) y LowCardinality(), incluido Array(Nullable(String or FixedString)).

Como alternativa, para añadir un índice de texto a una tabla existente:

Querysql
ALTER TABLE table
    ADD INDEX text_idx str TYPE text(
                                -- Mandatory parameters:
                                tokenizer = splitByNonAlpha
                                            | splitByString[(S)]
                                            | splitByRegexp(re)
                                            | asciiCJK
                                            | chinese[(granularity)]
                                            | icu(locale)
                                            | japanese
                                            | ngrams[(N)]
                                            | sparseGrams[(min_length[, max_length[, min_cutoff_length]])]
                                            | array
                                -- Optional parameters:
                                [, preprocessor = expression(str)]
                                [, postprocessor = expression(str)]
                                [, support_phrase_search = 0 | 1 ] -- experimental
                                -- Optional advanced parameters:
                                [, dictionary_block_size = D]
                                [, dictionary_block_frontcoding_compression = B]
                                [, posting_list_block_size = C]
                                [, posting_list_codec = 'none' | 'bitpacking' ]
                            )

Si agrega un índice a una tabla existente, le recomendamos materializar el índice en las partes existentes de la tabla (de lo contrario, las búsquedas en las partes sin índice recurrirán a búsquedas exhaustivas lentas).

Querysql
ALTER TABLE table MATERIALIZE INDEX text_idx SETTINGS mutations_sync = 2;

Para eliminar un índice de texto, ejecute

Querysql
ALTER TABLE table DROP INDEX text_idx;

Argumento tokenizador (obligatorio). El argumento tokenizer especifica el tokenizador:

  • splitByNonAlpha divide cadenas por caracteres ASCII no alfanuméricos (consulte la función splitByNonAlpha).
  • splitByString(S) divide cadenas usando determinadas cadenas separadoras S definidas por el usuario (consulte la función splitByString). Los separadores pueden especificarse mediante un parámetro opcional; por ejemplo, tokenizer = splitByString([', ', '; ', '\n', '\\']). Tenga en cuenta que cada cadena puede constar de varios caracteres (', ' en el ejemplo). La lista de separadores predeterminada, si no se especifica explícitamente (por ejemplo, tokenizer = splitByString), es un único espacio en blanco [' '].
  • splitByRegexp(re) divide cadenas usando un separador de expresión regular re definido por el usuario (consulte la función splitByRegexp). El argumento re es obligatorio; por ejemplo, tokenizer = splitByRegexp('[^\p{L}\p{N}#+]+'). A diferencia de las cadenas separadoras fijas de splitByString, un separador de expresión regular puede conservar tokens que contienen caracteres especiales (como C++ o C#) que los demás tokenizadores dividirían.
  • asciiCJK divide cadenas en tokens usando reglas de límites de palabra de Unicode (similares a Unicode Text Segmentation (UAX #29)). Los caracteres ASCII alfanuméricos y los guiones bajos forman tokens con conectores (ASCII : para letras, . y ' para caracteres del mismo tipo). Los caracteres Unicode no ASCII, incluidos los caracteres CJK, se convierten en tokens de un solo carácter.
  • chinese[(granularity)] segmenta texto chino en palabras mediante un diccionario y un modelo oculto de Markov (el algoritmo sigue jieba; los datos del diccionario y del modelo integrados derivan de cppjieba). A diferencia de asciiCJK, que trata cada carácter no ASCII como un token de un solo carácter, chinese agrupa caracteres chinos consecutivos en palabras (por ejemplo, 北京大学 se convierte en un token 北京大学 en lugar de cuatro tokens de un solo carácter). Esto genera tokens más significativos para texto chino y una mayor calidad de búsqueda. Para texto general o mixto, use asciiCJK; para texto exclusivamente chino, use chinese. El argumento opcional granularity es 'coarse_grained' (el valor predeterminado si no se especifica) o 'fine_grained'. Este último además enumera subpalabras superpuestas; por ejemplo, 北京邮电大学 también genera 北京, 邮电, 大学. La tokenización de granularidad fina mejora la exhaustividad a costa de un índice más grande. Busque en un índice de texto chinese con hasAnyTokens / hasAllTokens (que tokenizan el patrón con el tokenizador chinese), no con hasToken (que solo divide en separadores ASCII).
  • icu(locale) divide cadenas en tokens de palabras mediante la segmentación de palabras Unicode (UAX #29) de la biblioteca ICU. Para sistemas de escritura que no separan las palabras con espacios en blanco (por ejemplo, chino, japonés o tailandés), ICU aplica una segmentación basada en diccionarios, por lo que, a diferencia de asciiCJK, este texto se divide en palabras significativas de varios caracteres en lugar de caracteres individuales. Aquí, «diccionario» se refiere a las listas de palabras incluidas en ICU para esos sistemas de escritura (consulte brkitr/dictionaries); ICU elige la división más probable entre esas palabras. locale es la configuración regional de ICU que se pasa al segmentador; la segmentación depende principalmente del sistema de escritura y del diccionario, y la configuración regional selecciona la adaptación específica de ICU. Es un parámetro obligatorio; por ejemplo, tokenizer = icu('ja') o tokenizer = icu('zh'). Las configuraciones regionales disponibles pueden enumerarse con SELECT * FROM system.collations.
  • japanese divide el texto japonés en palabras mediante el analizador morfológico MeCab. A diferencia de asciiCJK, que emite tokens de un solo carácter para entradas CJK, este tokenizador realiza una segmentación adecuada en palabras. Requiere un diccionario que se carga en tiempo de ejecución desde la configuración del servidor (consulte Japanese tokenizer dictionary).
  • ngrams(N) divide cadenas en N-grams del mismo tamaño (consulte la función ngrams). La longitud del ngram puede especificarse mediante un parámetro entero opcional entre 1 y 8; por ejemplo, tokenizer = ngrams(3). El tamaño predeterminado del ngram, si no se especifica explícitamente (por ejemplo, tokenizer = ngrams), es 3.
  • sparseGrams(min_length, max_length, min_cutoff_length) divide cadenas en n-grams de longitud variable de al menos min_length y como máximo max_length caracteres (inclusive) (consulte la función sparseGrams). A menos que se especifique explícitamente, min_length y max_length toman los valores predeterminados 3 y 100. Si se proporciona el parámetro min_cutoff_length, solo se devuelven n-grams con una longitud mayor o igual que min_cutoff_length. En comparación con ngrams(N), el tokenizador sparseGrams produce N-grams de longitud variable, lo que permite una representación más flexible del texto original. Por ejemplo, tokenizer = sparseGrams(3, 5, 4) genera internamente 3-, 4- y 5-grams a partir de la cadena de entrada, pero solo se devuelven los 4- y 5-grams.
  • array no realiza tokenización; es decir, cada valor de fila es un token (consulte la función array). Para garantizar la compatibilidad con otros sistemas, keyword está disponible como alias de array.

Todos los tokenizadores disponibles se enumeran en system.tokenizers.

Diccionario del tokenizador japonés

No es compatible con ClickHouse Cloud

El tokenizador japanese requiere un diccionario MeCab, que no se incluye con ClickHouse. Proporcione uno en la configuración del servidor:

<tokenizer>
    <japanese>
        <dictionary_location>https://example.com/dictionary.tar.zst</dictionary_location>
        <dictionary_sha>0123...cdef</dictionary_sha>
    </japanese>
</tokenizer>
  • dictionary_location es la ubicación de un archivo comprimido de un diccionario MeCab compilado. Puede utilizarse cualquier diccionario oficial, como IPADIC o UniDic. La ubicación debe terminar con una extensión de archivo compatible (por ejemplo, .tar.gz, .tar.zst o .zip), a partir de la cual se detecta el tipo de archivo; por lo tanto, se rechaza una URL sin dicha extensión (p. ej., https://example.com/download). Ubicaciones compatibles:
    • una ruta local file://;
    • una URL http(s)://, descargada directamente (úsela para un objeto público o prefirmado);
    • un almacén de objetos compatible con S3 — AWS S3, GCS, MinIO, local, etc. (no solo AWS) — especificado como s3:///gs:///oss:// o como una URL completa http(s)://endpoint/bucket/key. Para un bucket privado, proporcione las credenciales de S3 como elementos secundarios de <japanese> (consulte el ejemplo a continuación).
  • dictionary_sha es el SHA-256 de ese archivo comprimido. Se verifica antes de cargar el diccionario; si no coincide, el diccionario no se carga y se genera un error.

El archivo comprimido se descarga y extrae una vez, y luego se almacena localmente en caché. Dado que el diccionario determina cómo se tokenizan los documentos, se debe configurar el mismo dictionary_sha en todas las réplicas.

Para leer desde un bucket privado compatible con S3, agregue la configuración de S3 como elementos secundarios de <japanese>, junto a dictionary_location y dictionary_sha:

<tokenizer>
    <japanese>
        <dictionary_location>s3://my-bucket/dictionary.tar.zst</dictionary_location>
        <dictionary_sha>0123...cdef</dictionary_sha>
        <access_key_id>...</access_key_id>
        <secret_access_key>...</secret_access_key>
        <region>us-east-1</region>
    </japanese>
</tokenizer>

Las opciones de configuración reconocidas (access_key_id, secret_access_key, region, no_sign_request, use_environment_credentials, …) son las mismas opciones de autenticación de S3 que se usan en otras partes de ClickHouse. Su presencia también hace que una URL http(s):// se obtenga mediante el client de S3 (con firma de solicitudes) en lugar de descargarse directamente.

Una vez configurado el diccionario, el tokenizador japanese puede usarse de esta forma:

Querysql
CREATE TABLE docs
(
    id UInt64,
    body String,
    INDEX body_idx body TYPE text(tokenizer = 'japanese')
)
ENGINE = MergeTree
ORDER BY id;

INSERT INTO docs VALUES (1, '日本語の形態素解析エンジン'), (2, 'これはテストの文章です');

SELECT id FROM docs WHERE hasAllTokens(body, '形態 解析', 'japanese') ORDER BY id;
Responsetext
┌─id─┐
│  1 │
└────┘

Para entender cómo un tokenizador divide la cadena de entrada, puede usar las funciones tokens y tokensForLikePattern:

Ejemplo:

Querysql
SELECT tokens('abc def', 'ngrams', 3);
Responseresult
['abc','bc ','c d',' de','def']

Uso con entradas no ASCII. Los índices de texto pueden crearse a partir de datos de texto en cualquier idioma y conjunto de caracteres. Para texto no ASCII, se recomienda el tokenizador asciiCJK, ya que gestiona correctamente los límites de palabra de Unicode, incluidos los caracteres CJK. Para idiomas que no separan las palabras mediante espacios en blanco (por ejemplo, chino, japonés o tailandés), el tokenizador icu(locale) genera tokens de palabras significativos de varios caracteres mediante la segmentación de palabras basada en diccionarios de ICU. En el caso del japonés, el tokenizador japanese (MeCab) segmenta el texto en palabras en lugar de caracteres individuales y, por lo general, ofrece mejores resultados de búsqueda. En el caso del chino, el tokenizador chinese (jieba) segmenta el texto en palabras en lugar de caracteres individuales y, por lo general, ofrece mejores resultados de búsqueda.

Argumento del preprocesador (opcional). El preprocesador hace referencia a una expresión que se aplica a la cadena de entrada antes de la tokenización.

Los casos de uso habituales del argumento del preprocesador incluyen

  1. Conversión a minúsculas o mayúsculas, o case folding para habilitar la coincidencia sin distinción entre mayúsculas y minúsculas, p. ej., lower, lowerUTF8, caseFoldUTF8.
  2. Normalización en UTF-8, p. ej. normalizeUTF8NFC, normalizeUTF8NFD, normalizeUTF8NFKC, normalizeUTF8NFKD, normalizeUTF8NFKCCasefold, toValidUTF8.
  3. Eliminación o transformación de caracteres o subcadenas no deseados, como los acentos, p. ej. extractTextFromHTML, substring, idnaEncode, translate, removeDiacriticsUTF8.

La expresión del preprocesador debe transformar un valor de entrada de tipo String o FixedString en un valor del mismo tipo. Si el índice de texto se construyó sobre una columna de tipo Nullable(T) o LowCardinality(T), la expresión del preprocesador debe aceptar valores anulables o de baja cardinalidad (es decir, no debe lanzar una excepción).

Ejemplos:

  • INDEX idx col TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = lower(col))
  • INDEX idx col TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = substringIndex(col, '\n', 1))
  • INDEX idx col TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = lower(extractTextFromHTML(col)))
  • INDEX idx col TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = removeDiacriticsUTF8(caseFoldUTF8(col)))

Además, la expresión del preprocesador solo debe hacer referencia a la columna o expresión sobre la que está definido el índice de texto.

Ejemplos:

  • INDEX idx lower(col) TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = upper(lower(col)))
  • INDEX idx lower(col) TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = concat(lower(col), lower(col)))
  • No permitido: INDEX idx lower(col) TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = concat(col, col))

No se permite el uso de funciones no deterministas.

Las funciones hasToken, hasAllTokens, hasAnyTokens y hasPhrase usan el preprocesador para transformar primero el término de búsqueda antes de tokenizarlo. Tenga en cuenta que, dado que el preprocesador solo se aplica en la ruta del índice de texto, los resultados de estas funciones pueden diferir entre las consultas que usan el índice de texto y las que no lo usan (p. ej., SETTINGS use_skip_indexes = 0).

Por ejemplo,

Querysql
CREATE TABLE table
(
    str String,
    INDEX idx str TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = lower(str))
)
ENGINE = MergeTree
ORDER BY tuple();

SELECT count() FROM table WHERE hasToken(str, 'Foo');

equivale a:

Querysql
CREATE TABLE table
(
    str String,
    INDEX idx lower(str) TYPE text(tokenizer = 'splitByNonAlpha')
)
ENGINE = MergeTree
ORDER BY tuple();

SELECT count() FROM table WHERE hasToken(str, lower('Foo'));

En este caso, la expresión del preprocesador transforma los elementos del array individualmente.

Ejemplo:

Querysql
CREATE TABLE table
(
    arr Array(String),
    INDEX idx arr TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = lower(arr))

    -- This is not legal:
    INDEX idx_illegal arr TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = arraySort(arr))
)
ENGINE = MergeTree
ORDER BY tuple();

SELECT count() FROM tab WHERE hasAllTokens(arr, 'foo');

Para definir un preprocesador en un índice de texto al crear columnas de tipo Map, los usuarios deben decidir si el índice se crea a partir de las claves o de los valores del mapa.

Ejemplo:

Querysql
CREATE TABLE table
(
    map Map(String, String),
    INDEX idx mapKeys(map)  TYPE text(tokenizer = 'splitByNonAlpha', preprocessor = lower(mapKeys(map)))
)
ENGINE = MergeTree
ORDER BY tuple();

SELECT count() FROM tab WHERE hasAllTokens(mapKeys(map), 'foo');

Argumento de posprocesamiento (opcional). El posprocesamiento es una expresión que se aplica a cada token de salida después de la tokenización.

A diferencia del preprocesador, que transforma toda la cadena de entrada antes de que el tokenizador la divida en tokens, el posprocesamiento actúa sobre los propios tokens, uno a uno. Este es el lugar natural para las transformaciones que son intrínsecamente a nivel de token.

Los casos de uso típicos del argumento de posprocesamiento incluyen:

  1. Filtrado de palabras vacías (tokens extremadamente frecuentes). Los tokens muy comunes como "the", "a" e "is" aportan poca relevancia a la búsqueda e inflan el índice. Puede usar el posprocesamiento para descartarlos convirtiéndolos en tokens vacíos; los tokens vacíos se ignoran, es decir, no se añaden al índice. Ejemplo: if(str IN ('the', 'a', 'an', 'of', 'in', 'is', 'it'), '', str)
  2. Eliminación de marcas de tiempo. Las líneas de log suelen empezar con una marca de tiempo estructurada como 2024-01-15T10:23:45 o contenerla. Indexar tokens de marcas de tiempo hincha el índice con cadenas que no aportan relevancia para la búsqueda. Hay dos enfoques complementarios para ignorar las marcas de tiempo:
    • Enfoque con posprocesamiento: use el tokenizador splitByString (división por espacios en blanco) para que la marca de tiempo completa se convierta en un único token y, a continuación, use parseDateTimeOrNull para detectarlo y descartarlo. Ejemplo: if(isNull(parseDateTimeOrNull(str, '%Y-%m-%dT%H:%i:%S')), str, '') Para marcas de tiempo con desplazamientos de zona horaria o segundos fraccionarios, use parseDateTimeBestEffortOrNull(str) sin una cadena de formato explícita.
    • Enfoque con preprocesador: elimine la marca de tiempo de la línea de log completa antes de la tokenización mediante una expresión regular. Ejemplo: replaceRegexpAll(str, '^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2} ', '') Esto funciona con cualquier tokenizador y es más eficiente, ya que los caracteres de la marca de tiempo nunca se tokenizan. Ambos enfoques pueden combinarse: el preprocesador elimina la marca de tiempo, mientras que el posprocesamiento normaliza o filtra los tokens restantes (p. ej., convierte a minúsculas + elimina palabras de severidad como ERROR o INFO).
  3. Stemming. Asignar a cada token su raíz mejora la exhaustividad de la búsqueda al hacer coincidir variantes morfológicas que comparten la misma raíz. Por ejemplo, con stemming en inglés, "running", "runs" y "run" se reducen todos a "run", por lo que una consulta de cualquiera de estas variantes coincide con todas ellas. ClickHouse proporciona una función stem integrada para varios idiomas. Ejemplo: stem(str, 'en')
  4. Normalización de mayúsculas y minúsculas. Convertir los tokens a minúsculas o mayúsculas para permitir la coincidencia sin distinción entre mayúsculas y minúsculas, p. ej. lower, lowerUTF8. Para convertir a minúsculas o mayúsculas, recomendamos usar un preprocesador en lugar del posprocesamiento.

La expresión de posprocesamiento transforma tokens de tipo String en tokens del mismo tipo. Además, la expresión de posprocesamiento solo debe hacer referencia a la columna o expresión sobre la que se define el índice de texto. Cuando la columna es de tipo Array(String), el posprocesamiento sigue operando sobre tokens individuales como valores String simples.

No se permite el uso de funciones no deterministas.

El posprocesamiento se aplica a cada token generado durante la creación del índice (para el tokenizador array, cada elemento del array es un token). En tiempo de consulta, el comportamiento depende de la función:

  • Para hasToken, hasAllTokens, hasAnyTokens y hasPhrase (con cualquier tokenizador compatible): el posprocesamiento se aplica tanto a los tokens del texto en el que se busca como al término de búsqueda, lo que permite una coincidencia completamente normalizada (p. ej., búsqueda sin distinción entre mayúsculas y minúsculas). Para hasPhrase, los tokens posprocesados se posicionan de forma contigua, por lo que un token que el posprocesamiento descarta no deja ningún hueco posicional y la frase sigue coincidiendo a través de él; p. ej., con un posprocesamiento de palabras vacías que descarta the, hasPhrase(col, 'see cat') coincide con un documento see the cat. La única excepción es hasPhrase en un índice splitByRegexp, que no admite un posprocesamiento (la combinación se rechaza con una excepción).
  • Para todas las demás funciones (=, IN, has, hasAny, hasAll, mapContains*): solo se posprocesa el término de búsqueda para la consulta mediante indicación de índice; el predicado a nivel de fila sigue comparando con los valores originales de la columna.

Ejemplos:

  • Elimine palabras vacías mediante una expresión de posprocesamiento:
CREATE TABLE table
(
    str String,
    INDEX idx(str) TYPE text(
        tokenizer = 'splitByNonAlpha',
        postprocessor = if(str IN ('the', 'a', 'an', 'of', 'in', 'is', 'it'), '', str)
    )
)
ENGINE = MergeTree
ORDER BY tuple();
  • Elimine las marcas de tiempo mediante una expresión de posprocesamiento:
-- Log lines: '2024-01-15T10:23:45 ERROR connection failed'
-- The splitByString tokenizer (default: whitespace) keeps the full timestamp as one token.
-- parseDateTimeOrNull detects and drops it; non-timestamp words are kept.
CREATE TABLE logs
(
    id   UInt64,
    line String,
    INDEX idx(line) TYPE text(
        tokenizer    = 'splitByString',
        postprocessor = if(isNull(parseDateTimeOrNull(line, '%Y-%m-%dT%H:%i:%S')), line, '')
    )
)
ENGINE = MergeTree ORDER BY id;

-- Only message-level words are indexed; timestamp tokens are not stored.
SELECT count() FROM logs WHERE hasAllTokens(line, ['ERROR']);       -- fast index lookup
SELECT count() FROM logs WHERE hasAllTokens(line, ['2024-01-15T10:23:45']);  -- returns 0: token was never indexed
  • Elimine las marcas de tiempo mediante una expresión de preprocesador:
-- The preprocessor strips the ISO timestamp prefix before tokenization.
-- Any tokenizer can be used; timestamp characters are never seen by the tokenizer.
CREATE TABLE logs
(
    id   UInt64,
    line String,
    INDEX idx(line) TYPE text(
        tokenizer   = 'splitByNonAlpha',
        preprocessor = replaceRegexpAll(line, '^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2} ', '')
    )
)
ENGINE = MergeTree ORDER BY id;
  • Elimine las marcas de tiempo mediante una expresión combinada de preprocesador y posprocesamiento:
-- Preprocessor strips the timestamp, then lowercases the remainder.
-- Postprocessor drops the severity word (error, info, warn, debug) after tokenization.
-- Result: only substantive message words are stored in the index.
CREATE TABLE logs
(
    id   UInt64,
    line String,
    INDEX idx(line) TYPE text(
        tokenizer    = 'splitByNonAlpha',
        preprocessor = lower(replaceRegexpAll(line, '^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2} ', '')),
        postprocessor = if(line IN ('error', 'info', 'warn', 'warning', 'debug', 'critical'), '', line)
    )
)
ENGINE = MergeTree ORDER BY id;

-- Example log line: '2024-01-15T10:23:45 ERROR connection failed'
-- After preprocessor:  'error connection failed'
-- After tokenization:  ['error', 'connection', 'failed']
-- After postprocessor: ['connection', 'failed']   ← 'error' dropped as severity word
SELECT count() FROM logs WHERE hasAllTokens(line, ['connection']);
  • Aplica stemming a los tokens mediante una expresión de posprocesamiento:
CREATE TABLE table
(
    str String,
    INDEX idx(str) TYPE text(
        tokenizer = 'splitByNonAlpha',
        postprocessor = stem(str, 'en')
    )
)
ENGINE = MergeTree
ORDER BY tuple();

-- The query token 'running' is stemmed to 'run' before the lookup,
-- matching rows that contain 'run', 'runs', 'ran', 'running', etc.
SELECT count() FROM table WHERE hasAllTokens(str, ['running']);

Compatibilidad con funciones.

Para los predicados que consultan el índice de texto, el preprocesador y el posprocesamiento se aplican al valor de búsqueda antes de la comprobación a nivel de gránulo, de modo que la búsqueda en el índice use los mismos tokens que se almacenaron al crear el índice. Para la mayoría de las funciones (=, IN, startsWith, endsWith, LIKE, mapContains*), el índice de texto se usa solo para omitir bloques de datos irrelevantes; ClickHouse sigue verificando cada fila resultante con el predicado original sobre los datos originales de la columna. Para las funciones de búsqueda de tokens (hasToken, hasAllTokens, hasAnyTokens), el índice de texto es la vía principal de evaluación: ClickHouse normaliza el término buscado mediante el mismo preprocesador, tokenizador y posprocesamiento que se aplicaron al crear el índice, y usa esta forma normalizada tanto para las partes de tabla indexadas como para las no indexadas. Con un posprocesamiento, el texto en el que se busca también se normaliza en tiempo de consulta (para cualquier tokenizador, no solo array), de modo que ambos lados de la comparación se transforman de forma coherente y el resultado no depende de si el índice se lee directamente (ajuste query_plan_direct_read_from_text_index) ni de si una parte determinada tiene un índice materializado; por ejemplo, habilitar la coincidencia sin distinción entre mayúsculas y minúsculas para hasAllTokens(col, ['FOO']) con un posprocesamiento lower. Sin support_phrase_search, hasPhrase usa el índice solo como indicación y verifica cada fila resultante con el predicado original; además, un posprocesamiento normaliza de la misma manera tanto la frase como los tokens del texto buscado, por lo que el resultado es independiente de la ruta de lectura, y los tokens que el posprocesamiento descarta no rompen la adyacencia de la frase. Con support_phrase_search = 1, hasPhrase usa lecturas directas exactas (y sigue aplicando el posprocesamiento, si lo hay). Esta compatibilidad con el posprocesamiento no se extiende al tokenizador splitByRegexp: se rechaza hasPhrase en un índice splitByRegexp combinado con un posprocesamiento (consulte la nota al pie ³ a continuación). Los tokens de búsqueda que el posprocesamiento convierte en una cadena vacía se ignoran; es decir, se tratan como ausentes de la frase de búsqueda.

Función Admite un preprocesador Tokenizadores compatibles Admite un posprocesamiento
= todos
IN todos
hasToken todos (diseñado para splitByNonAlpha)
hasAnyTokens(col, str) todos
hasAllTokens(col, str) todos
hasAnyTokens(col, arr) no (los elementos del array se tratan como tokens tal cual) todos
hasAllTokens(col, arr) no (los elementos del array se tratan como tokens tal cual) todos
hasPhrase splitByNonAlpha, splitByString, splitByRegexp³, ngrams, asciiCJK, icu sí³
startsWith splitByNonAlpha, ngrams, sparseGrams, asciiCJK
endsWith splitByNonAlpha, ngrams, sparseGrams, asciiCJK
like sí¹ splitByNonAlpha, ngrams, sparseGrams, asciiCJK¹ sí¹
match sí¹ splitByNonAlpha, ngrams, sparseGrams, asciiCJK¹ sí¹
ilike sí² (lower/upper solamente) splitByNonAlpha, array² no²
mapContainsKey todos
mapContainsValue todos
mapContainsKeyLike splitByNonAlpha, ngrams, sparseGrams, asciiCJK
mapContainsValueLike splitByNonAlpha, ngrams, sparseGrams, asciiCJK
has array
hasAny array
hasAll array

¹ LIKE y match usan lectura directa como indicación para los tokenizadores listados; de lo contrario, recurren a una búsqueda exhaustiva. Además, LIKE admite lectura directa (sin indicación) (habilitada mediante use_text_index_like_evaluation_by_dictionary_scan) para los tokenizadores splitByNonAlpha y array sin preprocesador ni posprocesamiento.

² ILIKE solo es compatible mediante lectura directa (sin indicación) (use_text_index_like_evaluation_by_dictionary_scan = 1, tokenizador splitByNonAlpha o array). No hay fallback al uso del índice como indicación: si la configuración está deshabilitada o el tokenizador no está en el conjunto compatible, el índice no se usa para ILIKE. El preprocesador, si está presente, debe ser lower o upper; los posprocesamientos no son compatibles.

³ hasPhrase en un índice de texto splitByRegexp no admite un posprocesamiento: la combinación se rechaza con una excepción, porque la reescritura a nivel de fila del posprocesamiento presupone tokens de estilo splitByNonAlpha divididos por espacios en blanco. Sin un posprocesamiento, splitByRegexp es totalmente compatible con hasPhrase.

Experimental: soporte para el argumento de búsqueda de frases (opcional).

El parámetro experimental support_phrase_search (predeterminado: 0) controla si el índice almacena las posiciones de los tokens. Cuando se establece en 1, el índice también almacena datos de posición (en un archivo .pos), lo que permite la coincidencia exacta de frases mediante lecturas directas para la función hasPhrase. Almacenar posiciones aumenta el tamaño del índice en disco y el costo de escritura, por lo que es una opción de activación explícita. El formato en disco aún no es estable, por lo que este parámetro es experimental y puede cambiar en una versión futura. Por lo tanto, crear un índice con support_phrase_search = 1 requiere que esté habilitado el ajuste de MergeTree allow_experimental_text_index_phrase_search. Establezca support_phrase_search = 0 (el valor predeterminado) para conservar el almacenamiento solo con posting lists; los índices de texto creados sin este argumento siguen sin posiciones.

Parámetros avanzados opcionales

Los valores predeterminados de los siguientes parámetros avanzados funcionan bien prácticamente en cualquier situación. No recomendamos modificarlos.

El parámetro opcional dictionary_block_size (predeterminado: 512) especifica el tamaño de los bloques del diccionario en filas.

El parámetro opcional dictionary_block_frontcoding_compression (predeterminado: 1) especifica si los bloques del diccionario usan front coding para la compresión.

El parámetro opcional posting_list_block_size (predeterminado: 1048576) especifica el tamaño de los bloques de posting lists en filas.

El parámetro opcional posting_list_codec (predeterminado: none) especifica el códec de la posting list:

  • none - las posting lists se almacenan sin compresión adicional.
  • bitpacking - aplica codificación diferencial (delta) y, a continuación, bit-packing (cada uno dentro de bloques de tamaño fijo). Ralentiza las consultas SELECT; no se recomienda por el momento.

Los parámetros avanzados anteriores también pueden establecerse alternativamente a nivel de tabla mediante los ajustes de MergeTree correspondientes: text_index_dictionary_block_size, text_index_dictionary_block_frontcoding_compression, text_index_posting_list_block_size y text_index_posting_list_codec. Se aplican a cada índice de texto de la tabla que no especifique el parámetro explícitamente.

El principal caso de uso de los ajustes a nivel de tabla es cambiar los parámetros de índice de una tabla existente sin eliminar y volver a crear el índice de texto en todas las partes de la tabla. Cambiar un ajuste a nivel de tabla aplica los nuevos parámetros solo a los índices de texto creados para nuevas partes; las partes existentes conservan su layout actual.

Un argumento proporcionado en la definición del índice tiene prioridad sobre el ajuste de la tabla; por ejemplo:

CREATE TABLE table(
    s String,
    -- Este índice usa 'bitpacking', anulando el valor predeterminado a nivel de tabla que aparece abajo:
    INDEX idx_a s TYPE text(tokenizer = 'splitByNonAlpha', posting_list_codec = 'bitpacking'),
    -- Este índice hereda 'none' del ajuste de la tabla:
    INDEX idx_b lower(s) TYPE text(tokenizer = 'splitByNonAlpha'))
ENGINE = MergeTree()
ORDER BY tuple()
SETTINGS text_index_posting_list_codec = 'none';

Granularidad del índice. Los índices de texto se implementan en ClickHouse como un tipo de índices de omisión. Sin embargo, a diferencia de otros índices de omisión, los índices de texto usan una granularidad infinita (100 millones). Esto puede verse en la definición de tabla de un índice de texto.

Ejemplo:

Querysql
CREATE TABLE table(
    k UInt64,
    s String,
    INDEX idx s TYPE text(tokenizer = ngrams(2)))
ENGINE = MergeTree()
ORDER BY k;

SHOW CREATE TABLE table;
Responseresult
┌─statement──────────────────────────────────────────────────────────────┐
│ CREATE TABLE default.table                                            ↴│
│↳(                                                                     ↴│
│↳    `k` UInt64,                                                       ↴│
│↳    `s` String,                                                       ↴│
│↳    INDEX idx s TYPE text(tokenizer = ngrams(2)) GRANULARITY 100000000↴│ <-- here
│↳)                                                                     ↴│
│↳ENGINE = MergeTree                                                    ↴│
│↳ORDER BY k                                                            ↴│
│↳SETTINGS index_granularity = 8192                                      │
└────────────────────────────────────────────────────────────────────────┘

La granularidad de índice tan alta garantiza que el índice de texto se cree para toda la parte. Se ignora cualquier granularidad de índice especificada explícitamente.

Uso de un índice de texto

Usar un índice de texto en las consultas SELECT es sencillo, ya que las funciones habituales de búsqueda de cadenas aprovechan el índice automáticamente. Si no existe ningún índice en una columna o en una parte de la tabla, las funciones de búsqueda de cadenas recurren a búsquedas exhaustivas lentas.

Funciones compatibles

El índice de texto se puede usar si se utilizan funciones de texto en la cláusula WHERE o en las cláusulas PREWHERE:

SELECT [...]
FROM [...]
WHERE string_search_function(column_with_text_index)

=

= (equals) coincide con el término de búsqueda completo.

Ejemplo:

SELECT * from table WHERE str = 'Hello';

IN

IN (in) es similar a equals, pero coincide con cualquiera de los términos de búsqueda.

Ejemplo:

SELECT * from table WHERE str IN ('Hello', 'World');

LIKE and match

Para usar LIKE (like) y la función match con índices de texto, ClickHouse debe poder extraer tokens completos del término de búsqueda. En el caso del índice con el tokenizador ngrams, esto ocurre si la longitud de las cadenas buscadas entre comodines es igual o mayor que la longitud del ngram.

Ejemplo de índice de texto con el tokenizador splitByNonAlpha:

SELECT count() FROM table WHERE comment LIKE 'support%';

support en el ejemplo podría coincidir con support, supports, supporting, etc. Este tipo de consulta es una consulta por subcadena y un índice de texto no puede acelerarla.

Para aprovechar un índice de texto en consultas LIKE, el patrón LIKE debe reescribirse de la siguiente manera:

SELECT count() FROM table WHERE comment LIKE ' support %'; -- o `% support %`

Los espacios a la izquierda y a la derecha de support garantizan que el término pueda extraerse como token.

Afortunadamente, hay un caso especial en el que ClickHouse puede aprovechar el índice invertido para acelerar significativamente las consultas LIKE.

Consulta la sección sobre optimización del rendimiento de LIKE/ILIKE para obtener más información.

multiSearchAny and multiMatchAny

multiSearchAny y su variante UTF-8 multiSearchAnyUTF8 comprueban si alguna de varias subcadenas literales aparece en el texto de entrada, y multiMatchAny comprueba si alguna de varias expresiones regulares coincide. Estas funciones usan el índice de texto en las mismas condiciones que LIKE y match (véase arriba): ClickHouse debe poder extraer tokens completos de cada subcadena buscada, y la lista de subcadenas buscadas debe ser constante. Se lee un gránulo si alguna subcadena buscada puede estar presente en él.

En multiMatchAny, si un patrón no puede reducirse a un requisito de token (por ejemplo, .*, que coincide con cualquier documento), no se puede usar el índice de texto y la consulta recurre a un escaneo completo.

Al igual que con LIKE y match, la búsqueda de subcadenas y expresiones regulares funciona mejor con los tokenizadores ngrams y sparseGrams. Estos tokenizadores indexan n-grams de caracteres superpuestos, por lo que una subcadena buscada se descompone en n-grams presentes en el índice allí donde aparece como subcadena, independientemente de si empieza o termina en medio de una palabra. Por tanto, una subcadena buscada puede usarse tal cual, siempre que tenga al menos la misma longitud que el tamaño del n-gram.

Ejemplo del índice de texto con el tokenizador ngrams:

SELECT count() FROM table WHERE multiSearchAny(comment, ['clickhouse', 'support']);

El tokenizador splitByNonAlpha, en cambio, solo indexa tokens completos (palabras enteras). Como una cadena de búsqueda puede empezar o terminar en medio de una palabra, ClickHouse descarta los tokens inicial y final de cada cadena de búsqueda, de modo que el índice solo pueda descartar gránulos usando tokens completos. Para que la búsqueda por subcadenas y expresiones regulares use el índice con splitByNonAlpha, rodea cada cadena de búsqueda con caracteres separadores (como espacios) para que forme uno o más tokens completos.

Ejemplo del índice de texto con el tokenizador splitByNonAlpha:

SELECT count() FROM table WHERE multiSearchAny(comment, [' clickhouse ', ' support ']);

startsWith and endsWith

Al igual que LIKE, las funciones startsWith y endsWith solo pueden usar un índice de texto si se pueden extraer tokens completos del término de búsqueda. En el caso del índice con el tokenizador ngrams, esto sucede si la longitud de las cadenas buscadas entre comodines es igual o mayor que la longitud del ngram. Cuando un índice de texto usa un posprocesador, estas funciones aún pueden usar el índice en modo Hint si los tokens de hint extraídos siguen siendo no vacíos después de la normalización. Si la normalización elimina todos los tokens de hint, el índice no se usa para ese predicado.

Ejemplo del índice de texto con el tokenizador splitByNonAlpha:

SELECT count() FROM table WHERE startsWith(comment, 'clickhouse support');

En el ejemplo, solo clickhouse se considera un token. support no es un token, porque puede coincidir con support, supports, supporting, etc.

Para encontrar todas las filas que comienzan con clickhouse supports, termine el patrón de búsqueda con un espacio final:

startsWith(comment, 'clickhouse supports ')`

Del mismo modo, endsWith debe usarse con un espacio inicial:

SELECT count() FROM table WHERE endsWith(comment, ' olap engine');

hasToken

La función hasToken busca la coincidencia de un único token dado.

A diferencia de las funciones mencionadas anteriormente, no tokenizan el término de búsqueda (asumen que la entrada es un único token).

Ejemplo:

SELECT count() FROM table WHERE hasToken(comment, 'clickhouse');

hasAnyTokens and hasAllTokens

Las funciones hasAnyTokens y hasAllTokens buscan coincidencias con uno o con todos los tokens proporcionados.

Estas dos funciones aceptan los tokens de búsqueda como una cadena, que se tokenizará con el mismo tokenizador que se usa para la columna del índice, o como un array de tokens ya procesados, al que no se aplicará tokenización antes de la búsqueda. Consulta la documentación de la función para obtener más información.

Ejemplo:

-- Tokens de búsqueda pasados como argumento de tipo String
SELECT count() FROM table WHERE hasAnyTokens(comment, 'clickhouse olap');
SELECT count() FROM table WHERE hasAllTokens(comment, 'clickhouse olap');

-- Tokens de búsqueda pasados como Array(String)
SELECT count() FROM table WHERE hasAnyTokens(comment, ['clickhouse', 'olap']);
SELECT count() FROM table WHERE hasAllTokens(comment, ['clickhouse', 'olap']);

hasPhrase

La función hasPhrase busca una frase: todos los tokens deben aparecer de forma consecutiva y en el mismo orden que en la cadena de búsqueda.

A diferencia de hasAllTokens, que solo requiere que todos los tokens estén presentes en algún lugar, hasPhrase exige que aparezcan como una secuencia consecutiva. La frase de búsqueda se tokeniza con el mismo tokenizador configurado para la columna del índice. Cuando el índice de texto usa un posprocesamiento, la frase de búsqueda también se normaliza antes de la búsqueda en el índice. Ten en cuenta que la función requiere uno de estos tokenizadores: splitByNonAlpha, splitByString, splitByRegexp, ngrams, asciiCJK o icu.

Ejemplo:

-- Matches: 'clickhouse' and 'olap' must appear consecutively in that order
SELECT count() FROM table WHERE hasPhrase(comment, 'clickhouse olap');

-- Does NOT match a row containing 'olap clickhouse' (wrong order)
-- Does NOT match a row containing 'clickhouse fast olap' (non-consecutive)

has

La función de array has coincide con un solo token en el array de cadenas.

Ejemplo:

SELECT count() FROM table WHERE has(array, 'clickhouse');

hasAny y hasAll

Las funciones de array hasAny y hasAll comprueban si la columna de array indexada contiene alguna o todas las cadenas buscadas de un conjunto constante.

Ejemplo:

SELECT count() FROM table WHERE hasAny(tags, ['clickhouse', 'olap']);
SELECT count() FROM table WHERE hasAll(tags, ['clickhouse', 'olap']);

mapContains

La función mapContains (es un alias de mapContainsKey) busca coincidencias entre los tokens extraídos de la cadena buscada y las claves de un mapa. El comportamiento es similar al de la función equals con una columna String. El índice de texto solo se utiliza si se creó sobre una expresión mapKeys(map).

Ejemplo:

SELECT count() FROM table WHERE mapContainsKey(map, 'clickhouse');
-- O
SELECT count() FROM table WHERE mapContains(map, 'clickhouse');

mapContainsValue

La función mapContainsValue busca coincidencias entre los tokens extraídos de la cadena buscada y los valores de un map. El comportamiento es similar al de la función equals con una columna String. El índice de texto solo se utiliza si se creó sobre una expresión mapValues(map).

Ejemplo:

SELECT count() FROM table WHERE mapContainsValue(map, 'clickhouse');

mapContainsKeyLike and mapContainsValueLike

Las funciones mapContainsKeyLike y mapContainsValueLike comparan un patrón con todas las claves o todos los valores (respectivamente) de un Map.

Ejemplo:

SELECT count() FROM table WHERE mapContainsKeyLike(map, '% clickhouse %');
SELECT count() FROM table WHERE mapContainsValueLike(map, '% clickhouse %');

operator[]

El operator[] de acceso puede usarse con el índice de texto para filtrar claves y valores. El índice de texto solo se utiliza si se crea sobre las expresiones mapKeys(map) o mapValues(map), o sobre ambas.

Ejemplo:

SELECT count() FROM table WHERE map['engine'] = 'clickhouse';

Consulte los siguientes ejemplos de uso de columnas de tipo Array(T) y Map(K, V) con el índice de texto.

Indexación de columnas Array(String)

Piense en una plataforma de blogs, donde los autores clasifican las entradas de su blog mediante palabras clave. Queremos que los usuarios descubran contenido relacionado buscando temas o haciendo clic en ellos.

Considere esta definición de tabla:

CREATE TABLE posts
(
    post_id UInt64,
    title String,
    content String,
    keywords Array(String)
)
ENGINE = MergeTree
ORDER BY (post_id);

Sin un índice de texto, encontrar posts con una palabra clave específica (p. ej., clickhouse) obliga a escanear todas las entradas:

SELECT count() FROM posts WHERE has(keywords, 'clickhouse'); -- exploración completa de la tabla lenta - comprueba cada palabra clave en cada publicación

A medida que la plataforma crece, esto se vuelve cada vez más lento porque la consulta debe examinar el array keywords de cada fila. Para solucionar este problema de rendimiento, definimos un índice de texto para la columna keywords:

ALTER TABLE posts ADD INDEX keywords_idx(keywords) TYPE text(tokenizer = splitByNonAlpha);
ALTER TABLE posts MATERIALIZE INDEX keywords_idx; -- No olvides reconstruir el índice para los datos existentes

Indexación de columnas de tipo Map

En muchos casos de uso de observabilidad, los mensajes de log se dividen en "componentes" y se almacenan con los tipos de datos adecuados, p. ej., fecha y hora para el timestamp, enum para el nivel de log, etc. Los campos de métricas se almacenan mejor como pares clave-valor. Los equipos de operaciones necesitan buscar de forma eficiente en los logs para depuración, incidentes de seguridad y monitorización.

Considere la siguiente tabla de logs:

CREATE TABLE logs
(
    id UInt64,
    timestamp DateTime,
    message String,
    attributes Map(String, String)
)
ENGINE = MergeTree
ORDER BY (timestamp);

Sin un índice de texto, buscar en datos de tipo Map requiere un escaneo completo de la tabla:

-- Encuentra todos los logs con datos de rate limiting:
SELECT * FROM logs WHERE has(mapKeys(attributes), 'rate_limit'); -- escaneo lento de tabla completa

-- Encuentra todos los logs de una IP específica:
SELECT * FROM logs WHERE has(mapValues(attributes), '192.168.1.1'); -- escaneo lento de tabla completa

A medida que aumenta el volumen de logs, estas consultas se vuelven lentas.

La solución es crear un índice de texto para las claves y los valores de Map. Usa mapKeys para crear un índice de texto cuando necesites encontrar logs por nombres de campos o tipos de atributos:

ALTER TABLE logs ADD INDEX attributes_keys_idx mapKeys(attributes) TYPE text(tokenizer = array);
ALTER TABLE posts MATERIALIZE INDEX attributes_keys_idx;

Usa mapValues para crear un índice de texto cuando necesites buscar dentro del contenido propiamente dicho de los atributos:

ALTER TABLE logs ADD INDEX attributes_vals_idx mapValues(attributes) TYPE text(tokenizer = array);
ALTER TABLE posts MATERIALIZE INDEX attributes_vals_idx;

Consultas de ejemplo:

-- Encuentra todas las solicitudes con límite de tasa:
SELECT * FROM logs WHERE mapContainsKey(attributes, 'rate_limit'); -- rápido

-- Encuentra todos los logs de una IP específica:
SELECT * FROM logs WHERE has(mapValues(attributes), '192.168.1.1'); -- rápido

-- Encuentra todos los logs donde algún atributo incluye un error:
SELECT * FROM logs WHERE mapContainsValueLike(attributes, '% error %'); -- rápido

Indexación de columnas JSON

Los índices de texto pueden usarse con columnas JSON de tres formas:

  1. Índices en subcolumnas específicas — crea un índice de texto en una ruta JSON conocida, igual que en una columna normal. Esto indexa los valores de esa ruta.
  2. Índices basados en rutas con JSONAllPaths — indexan todas las rutas presentes en cada gránulo para omitir los gránulos que no pueden contener la ruta consultada. Es similar a las columnas Map.
  3. Índices basados en valores con JSONAllValues — indexan todos los valores de todas las rutas JSON para acelerar la búsqueda de texto completo en cualquier subcolumna JSON con un solo índice.

Índices sobre subcolumnas específicas

Se puede crear un índice de omisión en cualquier subcolumna de JSON con la misma sintaxis que para las columnas normales.

Hay dos formas de hacer referencia a una subcolumna de JSON en una expresión de índice:

  • Ruta tipada declarada en la indicación de tipo de JSON: acceda directamente por nombre: json.a.
  • Ruta dinámica con conversión explícita: use la sintaxis de conversión ::: json.b::String.

Ejemplo de definición de índice:

Querysql
CREATE TABLE sensor_data
(
    data JSON(sensor_id String),
    INDEX idx_sensor data.sensor_id TYPE text(tokenizer = splitByNonAlpha),
    INDEX idx_location data.location::String TYPE text(tokenizer = splitByNonAlpha)
)
ENGINE = MergeTree
ORDER BY tuple()
SETTINGS index_granularity = 1;

INSERT INTO sensor_data SELECT toJSONString(map('sensor_id', 'id_' || number , 'location', 'room_' || toString(number))) FROM numbers(4);
INSERT INTO sensor_data SELECT toJSONString(map('sensor_id', 'id_' || number, 'location', 'room_' || toString(number))) FROM numbers(4, 4);

Ejemplo de consulta:

Querysql
EXPLAIN indexes = 1 SELECT * FROM sensor_data WHERE data.sensor_id = 'id_5';
Responsetext
...
    Indexes:
      Skip
        Name: idx_sensor
        Description: text
        Condition: (mode: All; tokens: ["5", "id"])
        Parts: 1/2
        Granules: 1/8

Ejemplo de consulta:

Querysql
EXPLAIN indexes = 1 SELECT * FROM sensor_data WHERE data.location::String = 'room_5';
Responsetext
...
    Indexes:
      Skip
        Name: idx_location
        Description: text
        Condition: (mode: All; tokens: ["5", "room"])
        Parts: 1/2
        Granules: 1/8

Índices basados en rutas con JSONAllPaths

Al igual que con las columnas Map, se pueden crear índices de texto en columnas JSON mediante JSONAllPaths. El índice almacena el conjunto de rutas JSON presentes en cada gránulo y las utiliza para omitir los gránulos en los que no está presente la ruta consultada.

Definición de ejemplo del índice:

Querysql
CREATE TABLE events
(
    data JSON,
    INDEX idx JSONAllPaths(data) TYPE text(tokenizer = array)
)
ENGINE = MergeTree
ORDER BY tuple();

INSERT INTO events VALUES ('{"user": {"name": "Alice"}, "action": "login"}');
INSERT INTO events VALUES ('{"metric": {"cpu": 0.95}, "host": "srv1"}');

Puede usar EXPLAIN indexes = 1 para verificar que se está utilizando el índice de omisión. Cuando una ruta existe solo en una parte, el índice se salta la otra parte.

Ejemplo:

Querysql
EXPLAIN indexes = 1 SELECT * FROM events WHERE data.user.name = 'Alice';
Responsetext
...
    Indexes:
      Skip
        Name: idx
        Description: text
        Condition: (mode: All; tokens: ["user.name"])
        Parts: 1/2
        Granules: 1/2

Cuando una ruta no existe en ninguna parte, se omiten todas las partes y todos los gránulos.

Ejemplo:

Querysql
EXPLAIN indexes = 1 SELECT * FROM events WHERE data.nonexistent = 1;
Responsetext
...
    Indexes:
      Skip
        Name: idx
        Description: text
        Condition: (mode: All; tokens: ["nonexistent"])
        Parts: 0/2
        Granules: 0/2

IS NOT NULL también usa el índice: omite los gránulos en los que la ruta no existe (ya que el valor sería NULL):

Ejemplo:

Querysql
EXPLAIN indexes = 1 SELECT * FROM events WHERE data.user.name IS NOT NULL;
Responsetext
...
    Indexes:
      Skip
        Name: idx
        Description: text
        Condition: (mode: All; tokens: ["user.name"])
        Parts: 1/2
        Granules: 1/2

Índices basados en valores con JSONAllValues

Los índices de texto pueden utilizarse para acelerar las búsquedas en columnas JSON mediante la función JSONAllValues.

JSONAllValues devuelve todos los valores de una columna JSON como Array(String). Los valores de tipos de datos que no son cadenas (p. ej., enteros y arrays) se convierten a su representación textual. Un índice de texto creado con JSONAllValues indexa estas representaciones textuales en todas las rutas JSON de cada fila. Este índice puede acelerar después las consultas que filtran por subcolumnas JSON individuales. Cuando una consulta filtra por una subcolumna específica (p. ej., data.user_name = 'alice'), el índice de texto puede descartar rápidamente las filas (y los gránulos) que no contienen los tokens de búsqueda en ninguno de sus valores JSON.

Creación del índice

Ejemplo de definición del índice:

CREATE TABLE events
(
    id UInt64,
    data JSON,
    INDEX json_idx JSONAllValues(data) TYPE text(tokenizer = splitByNonAlpha)
)
ENGINE = MergeTree
ORDER BY id;
Patrones de consulta admitidos

Una vez creado el índice, puede acelerar las consultas sobre subcolumnas JSON usando las mismas funciones que para las columnas String y la función equals para todas las columnas.

Acceso a las subcolumnas:

SELECT * FROM events WHERE data.user_name = 'alice';
SELECT * FROM events WHERE data.message LIKE '% error %';
SELECT * FROM events WHERE startsWith(data.status, 'fail');
SELECT * FROM events WHERE hasToken(data.title, 'clickhouse');

Acceso a subcolumnas mediante CAST explícito:

SELECT * FROM events WHERE hasAllTokens(data.message::String, 'connection timeout');
SELECT * FROM events WHERE data.status_code::UInt64 = 404;
SELECT * FROM events WHERE has(data.tags::Array(String), 'bug')

Operador IN:

SELECT * FROM events WHERE data.level IN ('error', 'critical');

Una búsqueda habitual en un índice de texto, por ejemplo

SELECT *
FROM tab
WHERE hasAllTokens(col, 'weather in Tokyo')

coincide con todas las filas que contienen los tokens indicados en cualquier orden. En el ejemplo, la fila While she stayed in Tokyo, the weather was great. cumple el filtro.

En cambio, la búsqueda de frases consiste en hacer coincidir los tokens en el orden dado. Por ejemplo,

SELECT *
FROM tab
WHERE hasPhrase(col, 'weather in Tokyo')

coincide con cualquier fila que contenga la secuencia de tokens weather in Tokyo, como en How is the weather in Tokyo??

El índice de texto acelera la búsqueda de frases al intersectar las listas de postings de todos los tokens de la frase para identificar los gránulos candidatos. Dentro de esos gránulos, ClickHouse verifica la adyacencia exacta de los tokens. Este proceso es relativamente costoso y más lento que las consultas normales de búsqueda de texto. Para acelerar las consultas de búsqueda de frases, habilite el almacenamiento de posiciones en el índice de texto (consulte Optional parameters más arriba).

hasPhrase puede usarse junto con los tokenizadores splitByNonAlpha, splitByString, splitByRegexp, ngrams, asciiCJK e icu. La cadena de la frase indicada se tokeniza usando el tokenizador del índice. Los caracteres separadores de la frase se ignoran: hasPhrase(text, 'quick+brown') es equivalente a hasPhrase(text, 'quick brown'), siempre que splitByNonAlpha se use como tokenizador.

Ejemplo

CREATE TABLE tab (
    id UInt32,
    text String,
    INDEX idx text TYPE text(tokenizer = splitByNonAlpha)
)
ENGINE = MergeTree
ORDER BY id;

INSERT INTO tab VALUES
    (1, 'weather in New York'),
    (2, 'New weather in York'),
    (3, 'weather in New Orleans');
Querysql
SELECT id, text FROM tab WHERE hasPhrase(text, 'weather in New York');
Responseresult
   ┌─id─┬─text────────────────┐
1. │  1 │ weather in New York │
   └────┴─────────────────────┘

La fila 2 ('New weather in York') no coincide porque los tokens no están en el orden correcto. La fila 3 ('weather in New Orleans') no coincide porque no contiene el token 'York'.

Optimización del rendimiento

Lectura directa

Ciertos tipos de consultas de texto pueden acelerarse considerablemente gracias a una optimización llamada "lectura directa".

Ejemplo:

SELECT column_a, column_b, ...
FROM [...]
WHERE string_search_function(column_with_text_index)

La optimización de lectura directa responde a la consulta exclusivamente mediante el índice de texto (es decir, búsquedas en el índice de texto), sin acceder a la columna de texto subyacente. Las búsquedas en el índice de texto leen relativamente pocos datos y, por tanto, son mucho más rápidas que los índices de omisión habituales en ClickHouse (que hacen una búsqueda en un índice de omisión, seguida de la carga y el filtrado de los gránulos restantes).

Lectura directa se controla con dos ajustes:

Funciones compatibles

La optimización de lectura directa admite las funciones hasToken, hasAllTokens y hasAnyTokens. Si el índice de texto se define con un tokenizador array, lectura directa también es compatible con las funciones equals, has, hasAny, hasAll, mapContainsKey y mapContainsValue. Estas funciones también pueden combinarse mediante los operadores AND, OR y NOT. Las cláusulas WHERE o PREWHERE también pueden contener filtros adicionales distintos de las funciones de búsqueda de texto (para columnas de texto u otras columnas); en ese caso, la optimización de lectura directa seguirá utilizándose, pero será menos eficaz (solo se aplica a las funciones de búsqueda de texto compatibles).

Para comprobar si una consulta utiliza lectura directa, ejecute la consulta con EXPLAIN PLAN actions = 1. Por ejemplo, una consulta con lectura directa deshabilitado

EXPLAIN PLAN actions = 1
SELECT count()
FROM table
WHERE hasToken(col, 'some_token')
SETTINGS query_plan_direct_read_from_text_index = 0, -- disable direct read

devuelve

[...]
Filter ((WHERE + Change column names to column identifiers))
Filter column: hasToken(__table1.col, 'some_token'_String) (removed)
Actions: INPUT : 0 -> col String : 0
         COLUMN Const(String) -> 'some_token'_String String : 1
         FUNCTION hasToken(col :: 0, 'some_token'_String :: 1) -> hasToken(__table1.col, 'some_token'_String) UInt8 : 2
[...]

mientras que la misma consulta, ejecutada con query_plan_direct_read_from_text_index = 1

EXPLAIN PLAN actions = 1
SELECT count()
FROM table
WHERE hasToken(col, 'some_token')
SETTINGS query_plan_direct_read_from_text_index = 1, -- enable direct read

devuelve

[...]
Expression (Before GROUP BY)
Positions:
  Filter
  Filter column: __text_index_idx_hasToken_94cc2a813036b453d84b6fb344a63ad3 (removed)
  Actions: INPUT :: 0 -> __text_index_idx_hasToken_94cc2a813036b453d84b6fb344a63ad3 UInt8 : 0
[...]

La segunda salida de EXPLAIN PLAN contiene una columna virtual __text_index_<index_name>_<function_name>_<id>. Si esta columna está presente, significa que se usa lectura directa.

Si la cláusula de filtro WHERE solo contiene funciones de búsqueda de texto, la consulta puede evitar por completo leer los datos de la columna y obtener el mayor beneficio de rendimiento con lectura directa. Sin embargo, incluso si se accede a la columna de texto en otra parte de la consulta, lectura directa seguirá aportando una mejora del rendimiento.

Lectura directa como pista

Lectura directa como pista se basa en los mismos principios que lectura directa normal, pero añade un filtro adicional generado a partir de los datos del índice de texto sin dejar de usar la columna de texto subyacente. Se utiliza en funciones para las que leer solo desde el índice de texto produciría falsos positivos.

Las funciones compatibles son: like, startsWith, endsWith, equals, has, hasPhrase, mapContainsKey y mapContainsValue.

El filtro adicional puede aportar más selectividad y, en combinación con otros filtros, restringir aún más el conjunto de resultados, lo que ayuda a reducir la cantidad de datos leídos de otras columnas.

Lectura directa como pista se controla mediante la configuración query_plan_text_index_add_hint (habilitada de forma predeterminada).

Ejemplo de consulta sin pista:

EXPLAIN actions = 1
SELECT count()
FROM table
WHERE (col LIKE '%some-token%') AND (d >= today())
SETTINGS query_plan_text_index_add_hint = 0
FORMAT TSV

devuelve

[...]
Prewhere filter column: and(like(__table1.col, \'%some-token%\'_String), greaterOrEquals(__table1.d, _CAST(20440_Date, \'Date\'_String))) (removed)
[...]

mientras que la misma consulta, ejecutada con query_plan_text_index_add_hint = 1

EXPLAIN actions = 1
SELECT count()
FROM table
WHERE col LIKE '%some-token%'
SETTINGS query_plan_text_index_add_hint = 1

devuelve

[...]
Prewhere filter column: and(__text_index_idx_col_like_d306f7c9c95238594618ac23eb7a3f74, like(__table1.col, \'%some-token%\'_String), greaterOrEquals(__table1.d, _CAST(20440_Date, \'Date\'_String))) (removed)
[...]

En la segunda salida de EXPLAIN PLAN, puedes ver que se ha añadido una conjunción adicional (__text_index_...) a la condición del filtro. Gracias a la optimización PREWHERE, la condición del filtro se descompone en tres conjunciones independientes, que se aplican en orden de complejidad computacional creciente. Para esta consulta, el orden de aplicación es __text_index_..., luego greaterOrEquals(...) y, por último, like(...). Este orden permite omitir todavía más gránulos de datos que los que ya omiten el índice de texto y el filtro original, antes de leer las columnas pesadas utilizadas en la consulta tras la cláusula WHERE, lo que reduce aún más la cantidad de datos que hay que leer.

Consultas LIKE/ILIKE

Cuando un patrón de consulta LIKE/ILIKE es %<alpha-numeric-characters-without-spaces>% y el tokenizador del índice de texto es splitByNonAlpha o array, ClickHouse aprovecha el índice invertido para acelerar significativamente las consultas LIKE/ILIKE. Para ello, ClickHouse examina el diccionario del índice invertido en lugar de hacer un escaneo completo de la tabla para encontrar el patrón coincidente.

Cuando la optimización está habilitada, las consultas LIKE/ILIKE deberían ser significativamente más rápidas que un escaneo completo de la tabla. Sin embargo, cuando el patrón coincide con la mayoría de los tokens del diccionario, el rendimiento puede ser peor que con un escaneo completo de la tabla. Afortunadamente, existe un mecanismo de fallback para evitarlo.

La optimización se controla mediante una configuración:

El mecanismo de fallback se controla mediante dos configuraciones:

Esta optimización solo admite las funciones like e ilike.

Consultas de recuento simples

Una consulta que solo cuenta las filas que cumplen un predicado de búsqueda de texto

SELECT count()
FROM [...]
WHERE hasToken(column_with_text_index, 'token')
-- or: hasAllTokens(column_with_text_index, ['token', ...])
-- or: hasAnyTokens(column_with_text_index, ['token', ...])

se responde desde el índice de texto, sin leer las filas coincidentes. ClickHouse obtiene el recuento a partir de las cardinalidades de las listas de postings del índice, sin consultar la columna virtual que marca las filas coincidentes ni realizar la agregación sobre ella. Un único token solo requiere la cardinalidad de su diccionario, por lo que no se lee ninguna lista de postings; los predicados con varios tokens leen los postings únicamente para unirlos (hasAnyTokens) o intersecarlos (hasAllTokens). Como un índice de texto cubre toda la parte, el recuento es exacto y se mantiene rápido incluso en partes muy grandes.

La optimización se aplica a un count() simple filtrado por un único predicado hasToken, hasAnyTokens o hasAllTokens (o un equivalente de Array/Map). Los predicados combinados con AND/OR/NOT, un filtro adicional (p. ej., ... AND id > 10), un predicado en modo pista como m['key'] = 'value', seleccionar cualquier elemento además del recuento o una búsqueda de frases o por LIKE/patrón hacen que la consulta lea filas en su lugar. Las partes sin un índice materializado se siguen contando correctamente mediante la lectura de sus filas.

Para confirmar que la optimización está activada, busque ReadFromTextIndexCount en el plan de consulta:

EXPLAIN
SELECT count() FROM table WHERE hasToken(col, 'sometoken')
[...]
Aggregating
└──ReadFromTextIndexCount (Trivial count from text index (idx, token = 'sometoken'))

La optimización se controla mediante query_plan_optimize_count_from_text_index (habilitada de forma predeterminada). Se basa en la lectura directa, por lo que query_plan_direct_read_from_text_index, use_skip_indexes y optimize_trivial_count_query también deben estar habilitadas (todas lo están de forma predeterminada).

Almacenamiento en caché

Hay diferentes cachés de servidor disponibles para almacenar en búfer partes del índice de texto en memoria (consulte la sección Detalles de implementación): Actualmente, existen cachés para los encabezados deserializados, los tokens y las listas de postings del índice de texto, con el fin de reducir la E/S. Use las configuraciones use_text_index_header_cache, use_text_index_tokens_cache y use_text_index_postings_cache para deshabilitar la lectura y escritura de las cachés individuales por parte de las consultas. El almacenamiento en caché de tokens que no están presentes en una parte de datos está habilitado de forma predeterminada y se puede controlar de forma independiente con use_text_index_negative_tokens_cache.

Para limpiar las cachés, use la sentencia SYSTEM CLEAR TEXT INDEX CACHES

Consulte las siguientes configuraciones del servidor para ajustar las cachés.

Configuración de la caché de tokens

Configuración Descripción
text_index_tokens_cache_policy Nombre de la política de la caché de tokens del índice de texto.
text_index_tokens_cache_size Tamaño máximo de la caché en bytes.
text_index_tokens_cache_max_entries Número máximo de tokens deserializados en la caché.
text_index_tokens_cache_size_ratio Tamaño de la cola protegida en la caché de tokens del índice de texto en relación con el tamaño total de la caché.

Configuración de la caché de encabezados

Setting Description
text_index_header_cache_policy Nombre de la política de caché de encabezados del índice de texto.
text_index_header_cache_size Tamaño máximo de la caché en bytes.
text_index_header_cache_max_entries Número máximo de encabezados deserializados en la caché.
text_index_header_cache_size_ratio Tamaño de la cola protegida en la caché de encabezados del índice de texto en relación con el tamaño total de la caché.

Configuración de la caché de listas de postings

Configuración Descripción
text_index_postings_cache_policy Nombre de la política de caché de las listas de postings del índice de texto.
text_index_postings_cache_size Tamaño máximo de la caché en bytes.
text_index_postings_cache_max_entries Número máximo de listas de postings deserializadas en la caché.
text_index_postings_cache_size_ratio Tamaño de la cola protegida en la caché de listas de postings del índice de texto en relación con el tamaño total de la caché.

Limitaciones

El índice de texto presenta actualmente las siguientes limitaciones:

  • La materialización de índices de texto con un número elevado de tokens (p. ej., 10 mil millones de tokens) puede consumir cantidades significativas de memoria. La materialización de índices de texto puede producirse directamente (ALTER TABLE <table> MATERIALIZE INDEX <index>) o indirectamente durante las fusiones de partes.
  • No es posible materializar índices de texto en partes con más de 4.294.967.296 (= 2^32 = aprox. 4,2 mil millones) filas. Sin un índice de texto materializado, las consultas recurren a una búsqueda exhaustiva lenta dentro de la parte. Como estimación del peor caso, suponga que una parte contiene una única columna de tipo String y que la configuración de MergeTree max_bytes_to_merge_at_max_space_in_pool (valor predeterminado: 150 GB) no se ha modificado. En este caso, esto ocurre si la columna contiene, de media, menos de 29,5 caracteres por fila. En la práctica, las tablas también contienen otras columnas y el umbral es varias veces menor (según el número, el tipo y el tamaño de las demás columnas).

Notas de actualización

La versión del formato en disco de los índices de texto se controla mediante la configuración de tabla text_index_serialization_version (valor predeterminado: v2_with_positions). La configuración es una preferencia, no una restricción estricta: si la versión configurada no puede representar un índice, se elige automáticamente una versión más reciente que pueda hacerlo, por lo que la escritura de un índice de texto nunca falla debido a esta configuración. Durante una actualización progresiva, fije el formato mediante la configuración compatibility en los servidores que ya se hayan actualizado: cuando se establece en una versión anterior a la que introdujo el formato correspondiente, text_index_serialization_version vuelve automáticamente a un valor anterior y los servidores más recientes siguen escribiendo en un formato que los servidores más antiguos aún pueden leer.

Índices de texto frente a índices basados en filtros Bloom

Los predicados sobre cadenas pueden acelerarse mediante índices de texto e índices basados en filtros Bloom (tipos de índice bloom_filter, ngrambf_v1, tokenbf_v1, sparse_grams), pero ambos difieren fundamentalmente en su diseño y en los casos de uso a los que están destinados:

Índices de filtros Bloom

  • Se basan en estructuras de datos probabilísticas que pueden producir falsos positivos.
  • Solo pueden responder preguntas de pertenencia a conjuntos; es decir, si la columna puede contener el token X o si definitivamente no lo contiene.
  • Almacenan información a nivel de gránulo para permitir omitir rangos amplios durante la ejecución de consultas.
  • Son difíciles de ajustar correctamente (consulta aquí un ejemplo).
  • Son bastante compactos (unos pocos kilobytes o megabytes por parte).

Índices de texto

  • Construyen un índice invertido determinista sobre tokens. El propio índice no puede producir falsos positivos.
  • Están optimizados específicamente para cargas de trabajo de búsqueda de texto.
  • Almacenan información a nivel de fila, lo que permite una búsqueda eficiente de términos.
  • Son bastante grandes (de decenas a cientos de megabytes por parte).

Los índices basados en filtros Bloom solo admiten la búsqueda de texto completo como un "efecto secundario":

  • No admiten tokenización ni preprocesamiento avanzados.
  • No admiten búsquedas con varios tokens.
  • No ofrecen las características de rendimiento esperadas de un índice invertido.

Los índices de texto, en cambio, están diseñados específicamente para la búsqueda de texto completo:

  • Proporcionan tokenización y preprocesamiento
  • Ofrecen soporte eficiente para hasAllTokens, LIKE, match y funciones similares de búsqueda de texto.
  • Tienen una escalabilidad significativamente mayor para grandes corpus de texto.

Detalles de implementación

Cada índice de texto consta de dos estructuras de datos (abstractas):

  • un diccionario que asigna cada token a una lista de postings, y
  • un conjunto de listas de postings, cada una de las cuales representa un conjunto de números de fila.

El índice de texto se construye para toda la parte. A diferencia de otros índices de omisión, el índice de texto puede fusionarse en lugar de reconstruirse durante la fusión de las partes de datos (véase más abajo).

Durante la creación del índice, se crean tres archivos (por parte):

Archivo de bloques de diccionario (.dct)

Los tokens del índice de texto se ordenan y se almacenan en bloques de diccionario de 512 tokens cada uno (el tamaño del bloque se puede configurar con el parámetro dictionary_block_size). Un archivo de bloques de diccionario (.dct) consta de todos los bloques de diccionario de todos los gránulos de índice de una parte.

Archivo de encabezado del índice (.idx)

El archivo de encabezado del índice contiene, para cada bloque de diccionario, el primer token del bloque y su desplazamiento relativo dentro del archivo de bloques de diccionario.

Esta estructura de índice disperso es similar al índice de clave primaria disperso) de ClickHouse.

Archivo de listas de postings (.pst)

Las listas de postings de todos los tokens se almacenan secuencialmente en el archivo de listas de postings. Para ahorrar espacio y, al mismo tiempo, permitir operaciones rápidas de intersección y unión, las listas de postings se almacenan como bitmaps Roaring. Si la lista de postings es más grande que posting_list_block_size, se divide en varios bloques que se almacenan secuencialmente en el archivo de listas de postings.

Archivo de posiciones (.pos)

Opcional, solo si el argumento del índice support_phrase_search = 1. Almacena las posiciones de los tokens dentro de las filas coincidentes.

Fusión de índices de texto

Cuando se fusionan partes de datos, no es necesario reconstruir el índice de texto desde cero; en su lugar, puede fusionarse eficientemente en una etapa independiente del proceso de fusión. Durante esta etapa, los diccionarios ordenados de los índices de texto de cada parte de entrada se leen y se combinan en un nuevo diccionario unificado. Los números de fila de las listas de postings también se recalculan para reflejar sus nuevas posiciones en la parte de datos fusionada, usando una correspondencia entre los números de fila antiguos y los nuevos que se crea durante la fase inicial de la fusión. Este método de fusionar índices de texto es similar a cómo se fusionan las projections con la columna _part_offset. Si el índice no está materializado en la parte de origen, se construye, se escribe en un archivo temporal y luego se fusiona junto con los índices de las otras partes y de otros archivos de índice temporales.

Depuración

La table function mergeTreeTextIndex puede usarse para inspeccionar índices de texto.

Ejemplo: conjunto de datos de Hacker News

Veamos las mejoras del rendimiento de los índices de texto en un conjunto de datos grande con mucho contenido textual. Usaremos 28.7M filas de comentarios del popular sitio web Hacker News. Esta es la tabla sin índice de texto:

CREATE TABLE hackernews (
    id UInt64,
    deleted UInt8,
    type String,
    author String,
    timestamp DateTime,
    comment String,
    dead UInt8,
    parent UInt64,
    poll UInt64,
    children Array(UInt32),
    url String,
    score UInt32,
    title String,
    parts Array(UInt32),
    descendants UInt32
)
ENGINE = MergeTree
ORDER BY (type, author);

Los 28,7 millones de filas están en un archivo Parquet en S3; vamos a insertarlas en la tabla hackernews:

INSERT INTO hackernews
    SELECT * FROM s3Cluster(
        'default',
        'https://datasets-documentation.s3.eu-west-3.amazonaws.com/hackernews/hacknernews.parquet',
        'Parquet',
        '
    id UInt64,
    deleted UInt8,
    type String,
    by String,
    time DateTime,
    text String,
    dead UInt8,
    parent UInt64,
    poll UInt64,
    kids Array(UInt32),
    url String,
    score UInt32,
    title String,
    parts Array(UInt32),
    descendants UInt32');

Usaremos ALTER TABLE para añadir un índice de texto en la columna comment y luego materializarlo:

-- Add the index
ALTER TABLE hackernews ADD INDEX comment_idx comment TYPE text(tokenizer = splitByNonAlpha);

-- Materialize the index for existing data
ALTER TABLE hackernews MATERIALIZE INDEX comment_idx SETTINGS mutations_sync = 2;

Ahora, ejecutemos consultas con las funciones hasToken, hasAnyTokens y hasAllTokens. Los siguientes ejemplos mostrarán la gran diferencia de rendimiento entre un análisis estándar del índice y la optimización de lectura directa.

1. Uso de hasToken

hasToken comprueba si el texto contiene un token específico. Buscaremos el token sensible a mayúsculas y minúsculas 'ClickHouse'.

Lectura directa deshabilitada (escaneo estándar) De forma predeterminada, ClickHouse usa el índice de omisión para filtrar gránulos y luego lee los datos de la columna de esos gránulos. Podemos simular este comportamiento deshabilitando la lectura directa.

SELECT count()
FROM hackernews
WHERE hasToken(comment, 'ClickHouse')
SETTINGS query_plan_direct_read_from_text_index = 0;

Lectura directa habilitada (lectura rápida del índice) Ahora ejecutamos la misma consulta con la lectura directa habilitada (opción predeterminada).

SELECT count()
FROM hackernews
WHERE hasToken(comment, 'ClickHouse')
SETTINGS query_plan_direct_read_from_text_index = 1;

La consulta de lectura directa es más de 45 veces más rápida (0.362s frente a 0.008s) y procesa significativamente menos datos (9.51 GB frente a 3.15 MB) al leer únicamente del índice.

2. Uso de hasAnyTokens

hasAnyTokens comprueba si el texto contiene al menos uno de los tokens indicados. Buscaremos comentarios que contengan 'love' o 'ClickHouse'.

Direct read desactivado (Exploración estándar)

SELECT count()
FROM hackernews
WHERE hasAnyTokens(comment, 'love ClickHouse')
SETTINGS query_plan_direct_read_from_text_index = 0;

Lectura directa habilitada (lectura rápida del índice)

SELECT count()
FROM hackernews
WHERE hasAnyTokens(comment, 'love ClickHouse')
SETTINGS query_plan_direct_read_from_text_index = 1;

La mejora de velocidad es aún más espectacular para esta búsqueda habitual con "OR". La consulta es casi 89 veces más rápida (1.329s frente a 0.015s) al evitar el escaneo de toda la columna.

3. Uso de hasAllTokens

hasAllTokens comprueba si el texto contiene todos los tokens indicados. Buscaremos comentarios que contengan tanto 'love' como 'ClickHouse'.

Lectura directa deshabilitada (escaneo estándar) Incluso con lectura directa deshabilitada, el índice de omisión estándar sigue siendo eficaz. Reduce las 28.7M filas a solo 147.46K filas, pero aun así debe leer 57.03 MB de la columna.

SELECT count()
FROM hackernews
WHERE hasAllTokens(comment, 'love ClickHouse')
SETTINGS query_plan_direct_read_from_text_index = 0;

Lectura directa activada (lectura rápida del índice) La lectura directa resuelve la consulta usando los datos del índice y solo lee 147.46 KB.

SELECT count()
FROM hackernews
WHERE hasAllTokens(comment, 'love ClickHouse')
SETTINGS query_plan_direct_read_from_text_index = 1;

Para esta búsqueda "AND", la optimización de lectura directa es más de 26 veces más rápida (0.184s frente a 0.007s) que el escaneo estándar del índice de omisión.

La optimización de lectura directa también se aplica a las expresiones booleanas compuestas. Aquí, realizaremos una búsqueda de 'ClickHouse' OR 'clickhouse' sin distinguir entre mayúsculas y minúsculas.

Lectura directa deshabilitada (Escaneo estándar)

SELECT count()
FROM hackernews
WHERE hasToken(comment, 'ClickHouse') OR hasToken(comment, 'clickhouse')
SETTINGS query_plan_direct_read_from_text_index = 0;

Lectura directa activada (lectura rápida del índice)

SELECT count()
FROM hackernews
WHERE hasToken(comment, 'ClickHouse') OR hasToken(comment, 'clickhouse')
SETTINGS query_plan_direct_read_from_text_index = 1;

Al combinar los resultados del índice, la consulta de lectura directa es 34 veces más rápida (0.450s frente a 0.013s) y evita leer 9.58 GB de datos de la columna. Para este caso concreto, hasAnyTokens(comment, ['ClickHouse', 'clickhouse']) sería la sintaxis recomendada y más eficiente.

Material obsoleto

Navigation