Sintaxis de búsqueda de Knowledge Catalog

En este documento, se describe la sintaxis de la búsqueda de Knowledge Catalog.

Knowledge Catalog te permite descubrir, catalogar de forma centralizada, administrar y comprender los datos de tu organización. Para encontrar de manera eficiente recursos de datos específicos dentro de tu catálogo de datos, puedes usar potentes consultas de búsqueda. La sintaxis de las consultas de búsqueda incluye lo siguiente:

  • Búsqueda simple: Cómo encontrar recursos de datos con un solo término de búsqueda
  • Predicados calificados: Cómo definir mejor tu búsqueda con campos de metadatos específicos como nombre, ubicación o descripción.
  • Búsqueda de aspectos: Cómo buscar entradas según sus metadatos técnicos y empresariales adjuntos
  • Operadores lógicos: Cómo combinar varios criterios de búsqueda con AND y OR para crear consultas complejas Si comprendes esta sintaxis, puedes ubicar rápidamente los datos que necesitas.

Antes de comenzar

Comprende los grupos de entradas, las entradas, los vínculos de entrada, los aspectos, los tipos de entrada, los tipos de vínculo de entrada y los tipos de aspecto de Knowledge Catalog. Consulta Acerca de la administración de metadatos en Knowledge Catalog.

Knowledge Catalog ofrece una búsqueda que aprovecha la IA para comprender las consultas de lenguaje natural y el significado semántico. Te permite encontrar recursos con lenguaje cotidiano, lo que elimina la necesidad de una sintaxis compleja, al mismo tiempo que admite la concordancia de palabras clave y los filtros.

Puedes encontrar recursos si ingresas un término o una frase sin ninguna sintaxis específica. Knowledge Catalog realiza una búsqueda amplia comparando tu consulta con varios campos de metadatos, incluidos los siguientes:

  • Nombre, nombre visible o descripción de un recurso
  • Tipo de recurso
  • ID del proyecto
  • Descripción general
  • Nombre de la columna (o nombre de la columna anidada) en el esquema de un recurso
  • Descripción de la columna
  • Nombre completamente calificado
  • Contactos
  • Aspectos

Usa la sintaxis de consulta

Para realizar búsquedas más precisas, puedes crear una consulta con una sintaxis específica, incluidos calificadores, operadores lógicos y búsquedas de aspectos.

Predicados calificados

Puedes calificar un predicado si le antepones una clave que restrinja la coincidencia a una pieza de metadatos específica:

  • Un signo igual (=) restringe la búsqueda a una concordancia exacta.
  • Un signo de dos puntos (:) después de la clave hace coincidir el predicado con una substring o un token dentro del valor en los resultados de la búsqueda.

La asignación de token divide el flujo del texto en una serie de tokens, cada uno correspondiente a una sola palabra.

Por ejemplo:

  • name:foo selecciona recursos con nombres que contienen la substring foo, como foo1 y barfoo.
  • description:foo selecciona recursos con el token foo en la descripción, como bar y foo.
  • location=foo coincide con los recursos en una ubicación especificada con foo como nombre de la ubicación.

El comportamiento de estos calificadores puede variar ligeramente entre los modos de búsqueda, como se detalla en las siguientes secciones.

Las claves de predicado type, system, location y description, y la búsqueda de aspectos (sin incluir has) solo admiten el calificador de concordancia exacta (=) y no el calificador de substring (:). Por ejemplo, type=foo.

La búsqueda de Knowledge Catalog admite los siguientes calificadores:

Calificador Descripción
name:x Coincide con x como una substring del ID del recurso o el nombre visible del recurso.
displayname:x Coincide con x como una substring del nombre visible del recurso.
column:x Coincide con x como una substring del nombre de la columna (o el nombre de la columna anidada ) en el esquema del recurso.
description:x Coincide con x como un token en la descripción del recurso.
labels:bar Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de etiqueta tiene bar como una substring.
labels=bar Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de etiqueta es igual a bar como una cadena.
labels.bar:x Coincide con x como una substring en el valor de una etiqueta con clave bar conectada a un recurso de BigQuery.
labels.foo=bar Coincide con los recursos de BigQuery en los que la clave es igual a foo y el valor de la clave es igual a bar.
type=TYPE Coincide con los recursos de un tipo de entrada específico o su alias de tipo.
projectid:bar Coincide con los recursos dentro de Google Cloud proyectos que coinciden con bar como una substring en el ID.
parent:x Coincide con x como una substring de la ruta jerárquica de un recurso.
system=SYSTEM Coincide con los recursos de un sistema especificado.
location=LOCATION

Coincide con los recursos en una ubicación especificada con un nombre exacto. Por ejemplo, location=us-central1 coincide con los recursos alojados en Iowa.

Los recursos de BigQuery Omni admiten este calificador con el nombre de ubicación de BigQuery Omni. Por ejemplo, location=aws-us-east-1 coincide con los recursos de BigQuery Omni en el norte de Virginia.

createtime

Encuentra recursos que se crearon dentro, antes o después de una fecha o hora determinadas.

Por ejemplo:

  • createtime:2019-01-01 coincide con todos los recursos creados el 1 de enero de 2019.
  • createtime<2019-02 coincide con todos los recursos creados antes del 1 de febrero de 2019 a las 00:00:00.
  • createtime>2019-02 coincide con todos los recursos creados después del 1 de febrero de 2019 a las 00:00:00.
  • createtime>-30d coincide con todos los recursos creados en los últimos 30 días.
  • createtime<=-30d coincide con todos los recursos creados hace 30 días o antes.
  • createtime<=-1d coincide con todos los recursos creados el día anterior.

Formato de marca de tiempo: YYYY-MM-DDThh:mm:ss

Todas las marcas de tiempo deben estar en GMT (no se admiten zonas horarias). Se admiten marcas de tiempo parciales y los separadores de fecha guion (-) y barra (/).

Por ejemplo:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
updatetime

Encuentra recursos que se actualizaron dentro, antes o después de una fecha o hora determinadas.

Por ejemplo:

  • updatetime:2019-01-01 coincide con todos los recursos actualizados el 1 de enero de 2019.
  • updatetime<2019-02 coincide con todos los recursos actualizados antes del 1 de febrero de 2019 a las 00:00:00.
  • updatetime>2019-02 coincide con todos los recursos actualizados después del 1 de febrero de 2019 a las 00:00:00.
  • updatetime>-30d coincide con todos los recursos actualizados en los últimos 30 días.
  • updatetime<-30d coincide con todos los recursos actualizados hace 30 días o antes.
  • updatetime=-1d coincide con todos los recursos actualizados el día anterior.
  • updatetime>=-30d coincide con todos los recursos actualizados en los últimos 30 días.
  • updatetime<=-30d coincide con todos los recursos actualizados hace 30 días o antes.

Formato de marca de tiempo: YYYY-MM-DDThh:mm:ss

Todas las marcas de tiempo deben estar en GMT (no se admiten zonas horarias). Se admiten marcas de tiempo parciales y los separadores de fecha guion (-) y barra (/).

Por ejemplo:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22

Puedes usar la sintaxis de consulta para buscar entradas según sus aspectos adjuntos.

La coincidencia de substring intenta coincidir con una cantidad limitada de aspectos. Si no puedes encontrar la entrada con un fragmento de la ruta de acceso, usa la ruta de acceso completa para acotar la búsqueda y aumentar la recuperación.

Calificador Descripción
aspect:x
o
has:x
Coincide con x como una substring de la ruta de acceso completa al tipo de aspecto de un aspecto que está conectado a la entrada, en el formato projectid.location.ASPECT_TYPE_ID
aspect=x
o
has=x
Coincide con x como la ruta de acceso completa al tipo de aspecto de un aspecto que está conectado a la entrada, en el formato projectid.location.ASPECT_TYPE_ID
x
OPERATOR
value

Busca valores de campos de aspectos. Coincide con x como una substring de la ruta de acceso completa al tipo de aspecto y al nombre de campo de un aspecto que está conectado a la entrada, en los siguientes formatos:

  • Sintaxis para tipos de aspectos del sistema:

    • ASPECT_TYPE_ID.FIELD_NAME
    • dataplex-types.ASPECT_TYPE_ID.FIELD_NAME
    • dataplex-types.LOCATION.ASPECT_TYPE_ID.FIELD_NAME

    Por ejemplo, las siguientes consultas coinciden con las entradas en las que el valor de el type campo en el bigquery-dataset aspecto es default:

    • bigquery-dataset.type=default
    • dataplex-types.bigquery-dataset.type=default
    • dataplex-types.global.bigquery-dataset.type=default
  • Sintaxis para tipos de aspectos personalizados:

    • Si el aspecto se crea en la región global: PROJECT_ID.ASPECT_TYPE_ID.FIELD_NAME
    • Si el aspecto se crea en una región específica: PROJECT_ID.REGION.ASPECT_TYPE_ID.FIELD_NAME

    Por ejemplo, las siguientes consultas coinciden con las entradas en las que el valor de el campo is-enrolled en el aspecto employee-info es true.

    • example-project.us-central1.employee-info.is-enrolled=true
    • example-project.employee-info.is-enrolled=true

    La lista de operadores compatibles depende del tipo de campo en el aspecto, de la siguiente manera:

    • String: = (concordancia exacta)
    • Todos los tipos de números: =, :, <, >, <=, >=, =>, =<
    • Enum: =
    • Fecha y hora: igual que para los números, pero los valores que se comparan se tratan como fechas y horas en lugar de números
    • Boolean: =

Solo se pueden buscar los campos de nivel superior del aspecto.

Operadores lógicos

Una consulta puede constar de varios predicados con operadores lógicos.

  • Si no especificas un operador, lógico AND está implícito. Por ejemplo, foo bar muestra recursos que coinciden con el predicado foo y el predicado bar.
  • Se admiten AND lógico y OR lógico. Por ejemplo, foo OR bar.
  • Puedes anular un predicado con un prefijo - (guion) o NOT. Por ejemplo, -name:foo muestra recursos con nombres que no coinciden con el predicado foo.

Sintaxis abreviada

También hay una sintaxis de búsqueda abreviada disponible que usa | (barra vertical) para los operadores OR y , (coma) para los operadores AND.

Por ejemplo, para buscar entradas dentro de uno de varios proyectos con el operador OR, puedes usar la siguiente sintaxis abreviada:

projectid:(id1|id2|id3|id4)

La misma búsqueda sin usar la sintaxis abreviada se ve de la siguiente manera:

projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4

Para buscar entradas con nombres de columnas coincidentes, usa lo siguiente:

  • AND: column:(name1,name2,name3)
  • OR: column:(name1|name2|name3)

Esta sintaxis abreviada funciona para los predicados calificados excepto para label en la búsqueda de palabras clave.

Knowledge Catalog proporciona el modo de búsqueda solo por palabras clave para la retrocompatibilidad, y el modo de búsqueda estándar admite la concordancia semántica y de palabras clave. Te recomendamos que uses el modo de búsqueda estándar, a menos que se requiera la búsqueda solo por palabras clave para la retrocompatibilidad.

En la siguiente tabla, se resumen las diferencias clave en los calificadores que debes tener en cuenta cuando usas la búsqueda solo por palabras clave.

Calificador Diferencias clave
name:x Coincide con x como una substring del ID del recurso únicamente.
Calificadores label

Usa el label prefijo en lugar de labels. Los formatos de sintaxis admitidos incluyen lo siguiente:

  • label:bar
  • label=bar
  • label:bar:x
  • label=foo:bar
  • label.foo=bar
  • label.foo
orgid=number Coincide con los recursos dentro de una Google Cloud organización con el valor de ID exacto de number, que solo se admite en la búsqueda solo por palabras clave.
fully_qualified_name Admite fully_qualified_name:x (coincidencia de substring) y fully_qualified_name=x (concordancia exacta) (solo se admite en la búsqueda solo por palabras clave).
createtime y updatetime Solo admite operadores de fecha exacta (:) y de comparación básica (<, >). No admite filtros de tiempo relativos (como -30d o -1d) ni operadores de comparación como <=, >=, =, =>, =<.
Restricción de concordancia exacta Las claves de predicado type, system, location, y orgid solo admiten la concordancia exacta (=) y no la coincidencia de substring (:).

Búsqueda de aspectos para la búsqueda solo por palabras clave

En la siguiente tabla, se resumen las diferencias clave en la búsqueda de aspectos que debes tener en cuenta cuando usas la búsqueda solo por palabras clave.

Elemento de búsqueda de aspectos Diferencias clave
Prefijo del calificador Admite aspect: y aspect=. No admite has: ni has=.
Sintaxis de búsqueda de valores de campos de aspectos Requiere el prefijo aspect: cuando se buscan valores de campos de aspectos (formato: aspect:x OPERATOR value, como aspect:employee-info.is-enrolled=true o aspect:employee=true).
Operadores de campos de cadenas Los campos de cadenas admiten la concordancia exacta (=) y la coincidencia de substring (:).
Abreviaturas de tipos de aspectos del sistema No admite abreviaturas de tipos de aspectos del sistema, como ASPECT_TYPE_ID.FIELD_NAME o dataplex-types...).

¿Qué sigue?