Sintaxis de búsqueda de Dataplex Universal Catalog

En este documento, se describe la sintaxis de las búsquedas de Dataplex Universal Catalog. Antes de leer este documento, es importante que comprendas los conceptos de administración de metadatos en Dataplex Universal Catalog, como entradas, aspectos, tipos de aspectos, grupos de entradas y tipos de entradas. Para obtener más información, consulta Acerca de la administració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 (versión preliminar).

La búsqueda por palabras clave te permite encontrar recursos con palabras clave, filtros y una sintaxis definida específicos.

La búsqueda en lenguaje natural extiende la búsqueda por palabras clave para admitir consultas en lenguaje natural. Te permite encontrar recursos con lenguaje cotidiano, lo que elimina la necesidad de usar sintaxis complejas.

En este documento, se abarca la sintaxis para la búsqueda por palabra clave y en lenguaje natural.

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

Ir a Búsqueda

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

Búsqueda de texto libre

Para encontrar recursos, ingresa un término o una frase sin ninguna sintaxis específica. Dataplex Universal Catalog realiza una búsqueda amplia que compara tu búsqueda 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

Cómo realizar búsquedas con 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:

  • El signo igual (=) restringe la búsqueda a una coincidencia exacta.
  • Los dos puntos (:) después de la clave hacen coincidir el predicado con una subcadena 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 subcadena 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 orgid solo admiten el calificador de concordancia exacta (=), no el calificador de subcadena (:). Por ejemplo, type=foo o orgid=number.

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

Calificador Descripción
name:x Coincide con x como una substring del ID del recurso.
displayname:x Haz coincidir x como una substring del nombre visible del recurso.
column:x Coincide con x como una subcadena 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.
label:bar Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de etiqueta tiene bar como una subcadena.
label=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.
label:bar:x Coincide con x como una subcadena en el valor de una etiqueta con la clave bar conectada 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 una cadena.
type=TYPE Coincide con los recursos de un tipo de entrada específico o su alias de tipo.
projectid:bar Coincide con los recursos de los proyectos de Google Cloud que coinciden conbarcomo una subcadena en el ID.
parent:x Coincide con x como una 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 dentro de una organización Google Cloud con el valor de ID exacto denumber.
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 la 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

Busca recursos que se crearon antes, durante o después de una fecha u hora determinadas.

Por ejemplo:

  • createtime:2019-01-01 coincide con los recursos creados el 2019-01-01.
  • 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 zonas horarias. Se admiten marcas de tiempo parciales y separadores de fecha con 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

Busca recursos que se actualizaron antes, durante o después de una fecha u hora determinadas.

Por ejemplo:

  • updatetime:2019-01-01 coincide con los recursos actualizados el 2019-01-01.
  • 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 zonas horarias. Se admiten marcas de tiempo parciales y separadores de fecha con 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
fully_qualified_name:x Coincide con 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, y la búsqueda de aspectos (sin incluir has) solo admiten el calificador de concordancia 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 una subcadena del ID o el nombre visible del recurso.
displayname:x Haz coincidir x como una substring del nombre visible del recurso.
column:x Coincide con x como una subcadena 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 subcadena.
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 subcadena en el valor de una etiqueta con la 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 de los proyectos de Google Cloud que coinciden conbarcomo una subcadena en el ID.
parent:x Coincide con x como una subcadena 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 la 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

Busca recursos que se crearon antes, durante o después de una fecha u hora determinadas.

Por ejemplo:

  • createtime:2019-01-01 coincide con todos los recursos creados el 2019-01-01.
  • createtime<2019-02 coincide con todos los recursos creados antes de 2019-02-01T00: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 zonas horarias. Se admiten marcas de tiempo parciales y separadores de fecha con 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

Busca recursos que se actualizaron antes, durante o después de una fecha u hora determinadas.

Por ejemplo:

  • updatetime:2019-01-01 coincide con todos los recursos actualizados el 2019-01-01.
  • updatetime<2019-02 coincide con todos los recursos actualizados antes del 2019-02-01T00: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 zonas horarias. Se admiten marcas de tiempo parciales y separadores de fecha con 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

Para buscar entradas según los aspectos adjuntos, usa la siguiente sintaxis de consulta.

Búsqueda por palabra clave

Calificador Descripción
aspect:x Coincide con x como una subcadena de la ruta de acceso completa al tipo de aspecto de un aspecto que se adjunta a la entrada, en el formato projectid.location.ASPECT_TYPE_ID
aspect=x Coincide con x como la ruta de acceso 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. Coincide con x como una subcadena del camino completo al tipo de aspecto y al nombre del 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, de la siguiente manera:

  • Cadena: = (coincidencia exacta) y : (subcadena)
  • 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.
  • Booleano: =

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

Por ejemplo, todas las siguientes búsquedas coinciden con las entradas en las que el valor del campo is-enrolled en el aspecto employee-info es true. También se devuelven otras entradas que coinciden 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 una subcadena de la ruta de acceso completa al tipo de aspecto de un aspecto que se adjunta a la entrada, en el formato projectid.location.ASPECT_TYPE_ID
has=x Coincide con x como la ruta de acceso 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 una subcadena del nombre de ruta de acceso completo al tipo de aspecto y al nombre del campo de un aspecto adjunto a la entrada, en los siguientes formatos:

  • Sintaxis para 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 búsquedas coinciden con las entradas en las que el valor del campo type en el aspecto bigquery-dataset es default:

    • bigquery-dataset.type=default
    • dataplex-types.bigquery-dataset.type=default
    • dataplex-types.global.bigquery-dataset.type=default

  • Sintaxis para tipos de aspecto personalizados:

    • Si el aspecto se crea en la región global, se muestra el siguiente mensaje: 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 búsquedas coinciden con las entradas en las que el valor del 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 admitidos depende del tipo de campo del aspecto, de la siguiente manera:

    • Cadena: = (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.
    • Booleano: =

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

Operadores lógicos

Una búsqueda puede constar de varios predicados con operadores lógicos. Si no especificas un operador, AND lógico está implícito. Por ejemplo, foo bar devuelve recursos que coinciden con el predicado foo y el predicado bar.

Se admiten los operadores lógicos AND y OR. Por ejemplo, foo OR bar.

Puedes negar un predicado con un prefijo - (guion) o NOT. Por ejemplo, -name:foo devuelve 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:

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

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

¿Qué sigue?