Descripción general de las consultas

En esta página, se describe la función SEARCH y el modo de consulta mejorado, que se usan para realizar consultas de búsqueda en el texto completo en tablas de Spanner.

Cómo consultar un índice de búsqueda

Spanner proporciona la función SEARCH para usar en las consultas del índice de búsqueda. Un ejemplo de caso de uso sería una aplicación en la que los usuarios ingresan texto en un cuadro de búsqueda y la aplicación envía la entrada del usuario directamente a la función SEARCH. Luego, la función SEARCH usaría un índice de búsqueda para encontrar ese texto.

La función SEARCH requiere dos argumentos:

  • Un nombre de índice de búsqueda
  • Una búsqueda

La función SEARCH solo funciona cuando se define un índice de búsqueda. La función SEARCH se puede combinar con cualquier construcción SQL arbitraria, como filtros, agregaciones o uniones.

La función SEARCH no se puede usar con consultas de transacciones.

En la siguiente consulta, se usa la función SEARCH para mostrar todos los álbumes que tengan friday o monday en el título:

GoogleSQL

SELECT AlbumId
FROM Albums
WHERE SEARCH(AlbumTitle_Tokens, 'friday OR monday')

PostgreSQL

En este ejemplo, se usa spanner.search.

SELECT albumid
FROM albums
WHERE spanner.search(albumtitle_tokens, 'friday OR monday')

Búsqueda

Las consultas de búsqueda usan la sintaxis de búsqueda sin procesar de forma predeterminada. Se pueden especificar sintaxis alternativas con el argumento SEARCH dialect.

Dialecto de rquery

El dialecto predeterminado es búsqueda sin procesar. Spanner usa un lenguaje específico de dominio (DSL) llamado rquery.

El lenguaje de rquery sigue las mismas reglas que el analizador de texto sin formato cuando divide la búsqueda de entrada en términos distintos. Esto incluye la segmentación de idiomas asiáticos.

Para obtener información sobre el uso de rquery, consulta Sintaxis de rquery.

dialecto de palabras

El dialecto de palabras es como rquery, pero más simple. No usa operadores especiales. Por ejemplo, OR se trata como un término de búsqueda en lugar de un operador de disyunción. Las comillas dobles se manejan como signos de puntuación en lugar de una búsqueda de frase y se ignoran.

Con el dialecto de palabras, AND se aplica de forma implícita a todos los términos y es obligatoria durante la coincidencia. Sigue las mismas reglas que el analizador de texto sin formato cuando divide la búsqueda de entrada en términos.

Para obtener información sobre el uso del dialecto de palabras, consulta sintaxis de palabras.

dialecto de words_phrase

El dialecto words_phrase no usa operadores especiales y todos los términos se tratan como una frase, lo que significa que los términos deben estar adyacentes y en el orden especificado.

Al igual que rquery, el dialecto words_phrase sigue las mismas reglas que el analizador de texto sin formato cuando divide la búsqueda de entrada en términos.

Para obtener información sobre el uso del dialecto words_phrase, consulta sintaxis de palabras.

Modo de consulta mejorado

Spanner ofrece dos modos de búsqueda en el texto completo: una búsqueda básica basada en tokens y un modo más avanzado llamado enhance_query. Cuando está habilitada, enhance_query expande la búsqueda para incluir términos y sinónimos relacionados, lo que aumenta la probabilidad de encontrar resultados relevantes.

Para habilitar esta opción, configura el argumento opcional enhance_query=>true en la función SEARCH. Por ejemplo, la búsqueda hotl cal coincide con el álbum Hotel California.

GoogleSQL

SELECT AlbumId
FROM Albums
WHERE SEARCH(AlbumTitle_Tokens, 'hotl cal', enhance_query=>true)

PostgreSQL

SELECT albumid
FROM albums
WHERE spanner.search(albumtitle_tokens, 'hotl cal', enhance_query=>true)

El modo enhance_query es una opción de tiempo de consulta. No afecta la tokenización. Puedes usar el mismo índice de búsqueda con o sin enhance_query.

Google mejora continuamente los algoritmos de mejora de consultas. Como resultado, una consulta con enhance_query == true podría generar resultados ligeramente diferentes con el tiempo.

Cuando se habilita el modo enhance_query, es posible que aumente la cantidad de términos que busca la función SEARCH, lo que podría aumentar ligeramente la latencia.

Por ejemplo, la siguiente consulta usa un tiempo de espera de tres segundos y falla si enhance_query no está disponible:

GoogleSQL

@{require_enhance_query=true, enhance_query_timeout_ms=3000}
SELECT AlbumId
FROM Albums
WHERE SEARCH(AlbumTitle_Tokens, 'fast car', enhance_query=>true)

PostgreSQL

/*@require_enhance_query=true, enhance_query_timeout_ms=3000*/
SELECT albumid
FROM albums
WHERE spanner.search(albumtitle_tokens, 'fast car', enhance_query=>true)

Requisitos de las consultas de SQL

Existen varias condiciones que debe cumplir una consulta de SQL para usar un índice de búsqueda. Si no se cumplen estas condiciones, la consulta usa un plan de consulta alternativo o falla si no existe un plan alternativo.

Las consultas deben cumplir con las siguientes condiciones:

  • Las funciones SEARCH y SEARCH_SUBSTRING requieren un índice de búsqueda. Spanner no admite estas funciones en consultas a la tabla base ni a los índices secundarios.

  • Los índices particionados deben tener todas las columnas de partición vinculadas por una condición de igualdad en la cláusula WHERE de la consulta.

    Por ejemplo, si un índice de búsqueda se define como PARTITION BY x, y, la consulta debe tener un conectivo en la cláusula WHERE de x = <parameter or constant> AND y = <parameter or constant>. El optimizador de consultas no considera ese índice de búsqueda si falta esa condición.

  • Todas las columnas TOKENLIST a las que hacen referencia los operadores SEARCH y SEARCH_SUBSTRING deben indexarse en el mismo índice de búsqueda.

    Por ejemplo, considera la siguiente definición de tabla y de índice:

    GoogleSQL

    CREATE TABLE Albums (
        AlbumId STRING(MAX) NOT NULL,
        AlbumTitle STRING(MAX),
        AlbumStudio STRING(MAX),
        AlbumTitle_Tokens TOKENLIST AS (TOKENIZE_FULLTEXT(AlbumTitle)) HIDDEN,
        AlbumStudio_Tokens TOKENLIST AS (TOKENIZE_FULLTEXT(AlbumStudio)) HIDDEN
    ) PRIMARY KEY(AlbumId);
    
    CREATE SEARCH INDEX AlbumsTitleIndex ON Albums(AlbumTitle_Tokens);
    CREATE SEARCH INDEX AlbumsStudioIndex ON Albums(AlbumStudio_Tokens);
    

    PostgreSQL

    CREATE TABLE albums (
        albumid character varying NOT NULL,
        albumtitle character varying,
        albumstudio character varying,
        albumtitle_tokens spanner.tokenlist GENERATED ALWAYS AS (spanner.tokenize_fulltext(albumtitle)) VIRTUAL HIDDEN,
        albumstudio_tokens spanner.tokenlist GENERATED ALWAYS AS (spanner.tokenize_fulltext(albumstudio)) VIRTUAL HIDDEN,
    PRIMARY KEY(albumid));
    
    CREATE SEARCH INDEX albumstitleindex ON albums(albumtitle_tokens);
    CREATE SEARCH INDEX albumsstudioindex ON albums(albumstudio_tokens);
    

    La siguiente consulta falla porque no hay un solo índice de búsqueda que indexe AlbumTitle_Tokens y AlbumStudio_Tokens:

    GoogleSQL

    SELECT AlbumId
    FROM Albums
    WHERE SEARCH(AlbumTitle_Tokens, @p1)
        AND SEARCH(AlbumStudio_Tokens, @p2)
    

    PostgreSQL

    En este ejemplo, se usan los parámetros de consulta $1 y $2, que están vinculados a "auto rápido" y "nota azul", respectivamente.

    SELECT albumid
    FROM albums
    WHERE spanner.search(albumtitle_tokens, $1)
        AND spanner.search(albumstudio_tokens, $2)
    
  • Si la columna de orden es anulable, tanto el esquema como la consulta deben excluir las filas en las que la columna de orden es NULL. Para obtener más detalles, consulta Orden de clasificación del índice de búsqueda.

  • Si el índice de búsqueda está filtrado como NULL, la consulta debe incluir la misma expresión de filtrado de NULL que se usa en un índice. Consulta Índices de búsqueda con filtro de NULL para obtener más información.

  • Los índices de búsqueda y las funciones de búsqueda no son compatibles con DML, DML particionado ni consultas particionadas.

  • Los índices de búsqueda y las funciones de búsqueda suelen usarse en transacciones de solo lectura. Si los requisitos de la aplicación permiten resultados inactivos, es posible que puedas mejorar la latencia ejecutando búsquedas con una duración de inactividad de 10 segundos o más. Para obtener más información, consulta Lee datos inactivos. Esto es muy útil para las búsquedas que se expanden a muchas divisiones de índices.

No se recomiendan los índices de búsqueda ni las funciones de búsqueda en las transacciones de lectura y escritura. Durante la ejecución, las consultas de búsqueda bloquean una partición de índice completa. Como resultado, una tasa alta de consultas de búsqueda en transacciones de lectura y escritura puede causar conflictos de bloqueo que generan aumentos repentinos de latencia. De forma predeterminada, los índices de búsqueda no se seleccionan automáticamente en las transacciones de lectura y escritura. Si se obliga a una consulta a usar un índice de búsqueda en una transacción de lectura y escritura, falla de forma predeterminada. También falla si la consulta contiene alguna de las funciones de búsqueda. Este comportamiento se puede anular con la sugerencia a nivel de la instrucción @{ALLOW_SEARCH_INDEXES_IN_TRANSACTION=TRUE} de GoogleSQL (pero las consultas siguen siendo propensas a conflictos de bloqueo).

Una vez que se cumplen las condiciones de elegibilidad del índice, el optimizador de consultas intenta acelerar las condiciones de consulta que no son de texto (como Rating > 4). Si el índice de búsqueda no incluye la columna TOKENLIST adecuada, la condición no se acelera y sigue siendo una condición residual.

Parámetros de consulta

Los argumentos de la búsqueda se especifican como un literal o un parámetro de búsqueda. Te recomendamos que uses parámetros de búsqueda para la búsqueda de texto completo en lugar de literales de cadena cuando los argumentos permitan el valor del parámetro de búsqueda.

Selección de índices

Por lo general, Spanner selecciona el índice más eficiente para una consulta con el modelado basado en costos. Sin embargo, la sugerencia FORCE_INDEX le indica de forma explícita a Spanner que use un índice de búsqueda específico. Por ejemplo, en lo siguiente, se muestra cómo forzar a Spanner a usar AlbumsIndex:

GoogleSQL

SELECT AlbumId
FROM Albums @{FORCE_INDEX=AlbumsIndex}
WHERE SEARCH(AlbumTitle_Tokens, "fifth symphony")

PostgreSQL

SELECT albumid
FROM albums/*@force_index=albumsindex*/
WHERE spanner.search(albumtitle_tokens, 'fifth symphony')

Si el índice de búsqueda especificado no es apto, la consulta falla, incluso si hay otros índices de búsqueda aptos.

Fragmentos en los resultados de la búsqueda

Un fragmento es un texto extraído de una cadena determinada que les brinda a los usuarios una idea de lo que contiene un resultado de la búsqueda y por qué es relevante para su consulta.

Por ejemplo, Gmail usa fragmentos para indicar la parte de un correo electrónico que coincide con la búsqueda:

Lista de fragmentos

Hacer que la base de datos genere un fragmento tiene varios beneficios:

  1. Comodidad: No necesitas implementar lógica para generar fragmentos a partir de una búsqueda.
  2. Eficiencia: Los fragmentos reducen el tamaño de salida del servidor.

La función SNIPPET crea el fragmento. Devuelve la parte relevante del valor de la cadena original junto con las posiciones de los caracteres que se destacarán. Luego, el cliente puede elegir cómo mostrar el fragmento al usuario final (por ejemplo, con texto destacado o en negrita).

Por ejemplo, en el siguiente código, se usa SNIPPET para recuperar texto de AlbumTitle:

GoogleSQL

SELECT AlbumId, SNIPPET(AlbumTitle, "Fast Car")
FROM Albums
WHERE SEARCH(AlbumTitle_Tokens, "Fast Car")

PostgreSQL

En este ejemplo, se usa spanner.snippet.

SELECT albumid, spanner.snippet(albumtitle, 'Fast Car')
FROM albums
WHERE spanner.search(albumtitle_tokens, 'Fast Car')

¿Qué sigue?