Sintaxis de búsqueda de Dataplex Universal Catalog

En este documento se describe la sintaxis de las consultas de búsqueda de Dataplex Universal Catalog. Antes de leer este documento, es importante que conozcas los conceptos de gestión de metadatos en el catálogo universal de Dataplex, como las entradas, los aspectos, los tipos de aspectos, los grupos de entradas y los tipos de entradas. Para obtener más información, consulta el artículo Acerca de la gestión de metadatos en Dataplex Universal Catalog.

Dataplex Universal Catalog ofrece dos modos de búsqueda: búsqueda por palabras clave y búsqueda en lenguaje natural (vista previa).

La búsqueda por palabras clave te permite encontrar recursos mediante palabras clave, filtros y una sintaxis definida.

La búsqueda en lenguaje natural amplía la búsqueda por palabras clave para admitir consultas en lenguaje natural. Te permite encontrar recursos usando un lenguaje cotidiano, sin necesidad de usar una sintaxis compleja.

En este documento se explica la sintaxis de la búsqueda por palabras clave y por lenguaje natural.

Para lanzar una consulta de búsqueda de Dataplex Universal Catalog en la consolaGoogle Cloud , ve a la página Búsqueda de Dataplex Universal Catalog y selecciona Dataplex Universal Catalog como plataforma de búsqueda.

Ir a la búsqueda

Para obtener más información, consulta Buscar recursos en Dataplex Universal Catalog.

Puedes encontrar recursos introduciendo un término o una frase sin ninguna sintaxis específica. Universal Catalog de Dataplex realiza una búsqueda amplia comparando tu consulta con varios campos de metadatos, entre los que se incluyen 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 de la columna anidada) del esquema de un recurso
  • Descripción de la columna
  • Nombre completo
  • Contactos
  • Aspectos

Buscar con sintaxis de consulta

Para hacer 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 cualificados

Puedes calificar un predicado añadiéndole un prefijo con una clave que restrinja la coincidencia a un metadato específico:

  • El signo igual (=) restringe la búsqueda a una concordancia exacta.
  • Los dos puntos (:) después de la clave hacen que el predicado coincida con una subcadena o un token del valor de los resultados de búsqueda.

La tokenización divide el flujo de texto en una serie de tokens, donde cada token suele corresponder a una sola palabra.

Por ejemplo:

  • name:foo selecciona los recursos cuyos nombres contienen la subcadena foo, como foo1 y barfoo.
  • description:foo selecciona los recursos con el token foo en la descripción, como bar y foo.
  • location=foo coincide con los recursos de 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, tal como se detalla en las siguientes secciones.

Las claves de predicado type, system, location y orgid solo admiten el calificador de coincidencia exacta (=), no el calificador de subcadena (:). Por ejemplo, type=foo o orgid=number.

Dataplex Universal Catalog admite los siguientes calificadores para la búsqueda de palabras clave:

Calificador Descripción
name:x Coincide con x como subcadena del ID de recurso.
displayname:x Coincide con x como subcadena del nombre visible del recurso.
column:x Coincide con x como subcadena del nombre de la columna (o del nombre de la columna anidada) en el esquema del recurso.
description:x Coincide con x como token en la descripción del recurso.
label:bar Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de la etiqueta tiene bar como subcadena.
label=bar Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de la etiqueta es igual a bar como cadena.
label:bar:x Coincide con x como subcadena en el valor de una etiqueta con la clave bar adjunta a un recurso de BigQuery.
label=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.
label.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.
label.foo Coincide con los recursos de BigQuery que tienen una etiqueta cuya clave es igual a foo como cadena.
type=TYPE Coincide con los recursos de un tipo de entrada específico o su alias de tipo.
projectid:bar Busca recursos en Google Cloud proyectos que coincidan con bar como subcadena en el ID.
parent:x Coincide con x como subcadena de la ruta jerárquica de un recurso. La ruta principal es un fully_qualified_name del recurso principal.
orgid=number Coincide con los recursos de una organización Google Cloud con el valor de ID exacto de number.
system=SYSTEM Coincide con los recursos de un sistema especificado.
location=LOCATION

Busca 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 mediante el nombre de ubicación de BigQuery Omni. Por ejemplo, location=aws-us-east-1 coincide con los recursos de BigQuery Omni de Virginia del Norte.

createtime

Busca recursos que se hayan creado en una fecha u hora concretas, antes o después de ellas.

Por ejemplo:

  • createtime:2019-01-01 coincide con los recursos creados el 1 de enero del 2019.
  • createtime<2019-02 coincide con los recursos creados antes del 2019-02-01T00:00:00.
  • createtime>2019-02 coincide con los recursos creados después del 2019-02-01T00:00:00.

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

Todas las marcas de tiempo deben estar en GMT. No se admiten las zonas horarias. Se admiten marcas de tiempo parciales, guiones (-) y barras (/) como separadores de fechas.

Por ejemplo:

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

Busca recursos que se hayan actualizado en una fecha u hora concretas, antes o después de ellas.

Por ejemplo:

  • updatetime:2019-01-01 coincide con los recursos actualizados el 1 de enero del 2019.
  • updatetime<2019-02 coincide con los recursos actualizados antes del 2019-02-01T00:00:00.
  • updatetime>2019-02 coincide con los recursos actualizados después del 2019-02-01T00:00:00.

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

Todas las marcas de tiempo deben estar en GMT. No se admiten las zonas horarias. Se admiten marcas de tiempo parciales, guiones (-) y barras (/) como separadores de fechas.

Por ejemplo:

  • 2010-10-22T05:36:24
  • 2010-10-22T05:36
  • 2010-10-22T05
  • 2010-10-22
  • 2010-10
  • 2010
  • 2010/10/22
fully_qualified_name:x Busca x como una subcadena de fully_qualified_name.
fully_qualified_name=x Coincide con x como fully_qualified_name.

Las claves de predicado type, system, location y description, así como la búsqueda de aspectos (excepto has), solo admiten el calificador de coincidencia exacta (=), no el calificador de subcadena (:). Por ejemplo, type=foo.

Dataplex Universal Catalog admite los siguientes calificadores para la búsqueda en lenguaje natural:

Calificador Descripción
name:x Coincide con x como subcadena del ID de recurso o del nombre visible del recurso.
displayname:x Coincide con x como subcadena del nombre visible del recurso.
column:x Coincide con x como subcadena del nombre de la columna (o del nombre de la columna anidada) en el esquema del recurso.
description:x Coincide con x como 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 la etiqueta tiene bar como subcadena.
labels=bar Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de la etiqueta es igual a bar como cadena.
labels.bar:x Coincide con x como subcadena en el valor de una etiqueta con la clave bar adjunta 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 Busca recursos en Google Cloud proyectos que coincidan con bar como subcadena en el ID.
parent:x Coincide con x como subcadena de la ruta jerárquica de un recurso.
system=SYSTEM Coincide con los recursos de un sistema especificado.
location=LOCATION

Busca 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 mediante el nombre de ubicación de BigQuery Omni. Por ejemplo, location=aws-us-east-1 coincide con los recursos de BigQuery Omni de Virginia del Norte.

createtime

Busca recursos que se hayan creado en una fecha u hora concretas, antes o después de ellas.

Por ejemplo:

  • createtime:2019-01-01 coincide con todos los recursos creados el 1 de enero del 2019.
  • createtime<2019-02 coincide con todos los recursos creados antes del 01-02-2019T00:00:00.
  • createtime>2019-02 coincide con todos los recursos creados después del 2019-02-01T00: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 las zonas horarias. Se admiten marcas de tiempo parciales, guiones (-) y barras (/) como separadores de fechas.

Por ejemplo:

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

Busca recursos que se hayan actualizado en una fecha u hora concretas, antes o después de ellas.

Por ejemplo:

  • updatetime:2019-01-01 coincide con todos los recursos actualizados el 1 de enero del 2019.
  • updatetime<2019-02 coincide con todos los recursos actualizados antes del 1 de febrero del 2019 a las 00:00:00.
  • updatetime>2019-02 coincide con todos los recursos actualizados después del 2019-02-01T00: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 las zonas horarias. Se admiten marcas de tiempo parciales, guiones (-) y barras (/) como separadores de fechas.

Por ejemplo:

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

Para buscar entradas en función de los aspectos que tengan asociados, usa la siguiente sintaxis de consulta.

Búsqueda por palabra clave

Calificador Descripción
aspect:x Coincide con x como subcadena de la ruta completa del tipo de aspecto de un aspecto adjunto a la entrada, en el formato projectid.location.ASPECT_TYPE_ID.
aspect=x Coincide con x como la ruta completa al tipo de aspecto de un aspecto adjunto a la entrada, en el formato projectid.location.ASPECT_TYPE_ID.
aspect:xOPERATORvalue

Busca valores de campos de aspectos. Busca x como subcadena de la ruta completa al tipo de aspecto y al nombre de campo de un aspecto que se adjunta a la entrada, en el formato projectid.location.ASPECT_TYPE_ID.FIELD_NAME

La lista de operadores admitidos depende del tipo de campo del aspecto, como se indica a continuación:

  • Cadena: = (coincidencia exacta) y : (subcadena)
  • Todos los tipos de números: =, :, <, >, <=, >=, => y =<
  • Enum: =
  • Fecha y hora: igual que en el caso de los números, pero los valores que se van a comparar se tratan como fechas y horas en lugar de como números.
  • Booleano: =

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

Por ejemplo, todas las consultas siguientes coinciden con las entradas en las que el valor del campo is-enrolled del aspecto employee-info es true. También se devuelven otras entradas que coincidan con la subcadena.

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

Búsqueda en lenguaje natural

Calificador Descripción
has:x Coincide con x como subcadena de la ruta completa del tipo de aspecto de un aspecto adjunto a la entrada, en el formato projectid.location.ASPECT_TYPE_ID.
has=x Coincide con x como la ruta completa al tipo de aspecto de un aspecto adjunto a la entrada, en el formato projectid.location.ASPECT_TYPE_ID.
has:xOPERATORvalue

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

  • Sintaxis de los 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 del campo type del aspecto bigquery-dataset es default:

    • bigquery-dataset.type=default
    • dataplex-types.bigquery-dataset.type=default
    • dataplex-types.global.bigquery-dataset.type=default
  • Sintaxis de los tipos de aspecto 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 del campo is-enrolled del 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 admitidos depende del tipo de campo del aspecto, como se indica a continuación:

    • Cadena: = (concordancia exacta)
    • Todos los tipos de números: =, :, <, >, <=, >=, => y =<
    • Enum: =
    • Fecha y hora: igual que en el caso de los números, pero los valores que se van a comparar se tratan como fechas y horas en lugar de como números.
    • Booleano: =

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 ningún operador, se da por supuesto el operador lógico AND. Por ejemplo, foo bar devuelve recursos que coinciden con el predicado foo y el predicado bar.

Se admiten las funciones lógicas AND y OR. Por ejemplo, foo OR bar.

Puedes negar un predicado con el prefijo - (guion) o NOT. Por ejemplo, -name:foo devuelve recursos con nombres que no coinciden con el predicado foo.

Sintaxis abreviada

También se puede usar una sintaxis de búsqueda abreviada con | (barra vertical) para los operadores OR y , (coma) para los operadores AND.

Por ejemplo, para buscar entradas en uno de los muchos proyectos mediante el operador OR, puedes usar la siguiente sintaxis abreviada:

projectid:(id1|id2|id3|id4)

La misma búsqueda sin usar la sintaxis abreviada sería la siguiente:

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

Para buscar entradas con nombres de columna coincidentes, haga lo siguiente:

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

Esta sintaxis abreviada funciona con los predicados cualificados, excepto con label en la búsqueda de palabras clave.

Siguientes pasos