Sintaxis de búsqueda de Dataplex Catalog

En este documento, se describe la sintaxis de las búsquedas de Dataplex. Antes de leer este documento, es importante que comprendas los conceptos de Dataplex Catalog, como las entradas de datos, los aspectos, los tipos de aspectos, los grupos de entradas y los tipos de entrada. Para obtener más información, consulta Descripción general del catálogo de Dataplex.

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

Ir a Búsqueda

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

En su forma más simple, una búsqueda de Dataplex Catalog consiste en un solo predicado. Este predicado puede coincidir con varias partes de metadatos:

  • Subcadena de un nombre, nombre visible o descripción de un recurso de datos
  • Subcadena del tipo de un recurso de datos
  • Es una subcadena de un nombre de columna (o el nombre de una columna anidada) en el esquema de un recurso de datos.
  • Una substring del ID del proyecto
  • Una cadena de una descripción general

Por ejemplo, el predicado foo coincide con las siguientes entidades:

  • Recurso de datos con el nombre foo.bar
  • Recurso de datos con el nombre visible Foo Bar
  • Recurso de datos con la descripción This is the foo script
  • Recurso de datos con el tipo exacto foo
  • Columna foo_bar en el esquema de un recurso de datos
  • Columna anidada foo_bar en el esquema de un recurso de datos
  • prod-foo-bar del proyecto
  • Recurso de datos con una descripción general que contiene la palabra foo

Predicados calificados

Puedes calificar un predicado si le agregas un prefijo con una clave que restrinja la hacer coincidir con una pieza específica de metadatos:

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

La asignación de token divide el flujo de texto en una serie de tokens, con cada token que, por lo general, corresponde a una sola palabra.

Por ejemplo:

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

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

Dataplex Catalog admite los siguientes calificadores:

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

Coincide con los recursos de datos 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 usando 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

Encuentra recursos de datos que se crearon antes o después de un determinado fecha u hora.

Por ejemplo:

  • createtime:2019-01-01 coincide con los recursos de datos creados el 1/1/2019.
  • createtime<2019-02 coincide con los recursos de datos creados antes del 2019-02-01T00:00:00.
  • createtime>2019-02 coincide con los recursos de datos creados después de 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. Parcial marcas de tiempo, separadores de fecha de guion (-) y barra diagonal Se admiten separadores de fecha (/).

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 de datos que se actualizaron en un determinado momento, antes o después de él fecha u hora.

Por ejemplo:

  • updatetime:2019-01-01 coincide con los recursos de datos actualizados el 1-1-2019.
  • updatetime<2019-02 coincide con los recursos de datos actualizados antes del 2019-02-01T00:00:00.
  • updatetime>2019-02 coincide con los recursos de datos actualizados después de 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. Parcial marcas de tiempo, separadores de fecha de guion (-) y barra diagonal Se admiten separadores de fecha (/).

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 substring de fully_qualified_name.
fully_qualified_name=x Coincide con x como fully_qualified_name.

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

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 completa al aspecto. de un aspecto asociado a la entrada, en el formato projectid.location.ASPECT_TYPE_ID
aspect:xOPERATORvalue

Busca valores de campos de aspecto. Coincide con x como una subcadena de la ruta de acceso completa al tipo de aspecto y el nombre de campo de un aspecto que está adjunto a la entrada, en el formato projectid.location.ASPECT_TYPE_ID.FIELD_NAME.

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

  • Cadena: = (coincidencia exacta) y : (subcadena)
  • Todos los tipos de números: =, :, <, > y <= >=, =>, =<
  • Enum: =
  • Fecha y hora: Lo mismo que para los números, pero los valores que se compararán se tratan como fecha y hora en lugar de números
  • Booleano: =

Solo se pueden buscar campos de nivel superior del aspecto.

Por ejemplo, todas las siguientes consultas coinciden con entradas en las que el valor del campo is-enrolled en employee-info aspecto es true. También se muestran 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

Operadores lógicos

Una consulta puede constar de varios predicados con operadores lógicos. Si no especifican un operador, el AND lógico está implícito. Por ejemplo, foo bar muestra Entidades que coinciden con el predicado foo y el predicado bar.

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

Puedes anular un predicado con un prefijo - (guión) o NOT. Por ejemplo, -name:foo muestra entidades con nombres que no coinciden con el predicado foo.

Los operadores lógicos no distinguen mayúsculas de minúsculas. Por ejemplo, tanto or como OR son aceptable.

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 muchos proyectos con el 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.

¿Qué sigue?