Sintaxe de pesquisa do Dataplex Universal Catalog

Este documento descreve a sintaxe para a pesquisa de palavras-chave do Dataplex Universal Catalog, bem como as pesquisas de IA em linguagem natural.

O Dataplex Universal Catalog permite-lhe descobrir, catalogar centralmente, gerir e compreender os dados da sua organização. Para encontrar eficientemente recursos de dados específicos no seu catálogo de dados, pode usar consultas de pesquisa eficazes. A sintaxe das consultas de pesquisa inclui:

  • Pesquisa simples: como encontrar recursos de dados através de um único termo de pesquisa.
  • Predicados qualificados: como refinar a sua pesquisa através de campos de metadados específicos, como o nome, a localização ou a descrição.
  • Pesquisa de aspetos: como pesquisar entradas com base nos respetivos metadados técnicos e da empresa anexados.
  • Operadores lógicos: como combinar vários critérios de pesquisa com os operadores AND e OR para criar consultas complexas. Compreendendo esta sintaxe, pode localizar rapidamente os dados de que precisa.

Antes de começar

Compreenda as entradas, os aspetos, os tipos de aspetos, os grupos de entradas e os tipos de entradas do Dataplex Universal Catalog. Consulte o artigo Acerca da gestão de metadados no Dataplex Universal Catalog.

O Dataplex Universal Catalog oferece dois modos de pesquisa: pesquisa por palavras-chave e pesquisa em linguagem natural (pré-visualização).

  • A pesquisa de palavras-chave permite-lhe encontrar recursos através de palavras-chave específicas, filtros e uma sintaxe definida.
  • A pesquisa de linguagem natural tira partido da IA para compreender consultas semânticas. Permite-lhe encontrar recursos de IA através de linguagem do dia a dia, eliminando a necessidade de sintaxe complexa.

Este documento aborda a sintaxe para a pesquisa de palavras-chave e de linguagem natural. IA Para iniciar uma consulta de pesquisa do Dataplex Universal Catalog na Google Cloud consola, aceda à página Pesquisa do Dataplex Universal Catalog e selecione Dataplex Universal Catalog como plataforma de pesquisa.

Aceda à pesquisa

Para mais informações, consulte o artigo Pesquise recursos no Dataplex Universal Catalog.

Pode encontrar recursos introduzindo um termo ou uma expressão sem sintaxe específica. O Dataplex Universal Catalog faz uma pesquisa ampla fazendo corresponder a sua consulta a vários campos de metadados, incluindo o seguinte:

  • Nome, nome a apresentar ou descrição de um recurso
  • Tipo de recurso
  • ID do projeto
  • Descrição da vista geral
  • Nome da coluna (ou nome da coluna aninhada) no esquema de um recurso
  • Descrição da coluna
  • Nome totalmente qualificado
  • Contactos
  • Aspetos

Pesquise com a sintaxe de consulta

Para pesquisas mais precisas, pode criar uma consulta com uma sintaxe específica, incluindo qualificadores, operadores lógicos e pesquisas de aspetos.

Predicados qualificados

Pode qualificar um predicado prefixando-o com uma chave que restringe a correspondência a um metadado específico:

  • Um sinal de igual (=) restringe a pesquisa a uma correspondência exata.
  • Um sinal de dois pontos (:) após a chave faz corresponder o predicado a uma subcadeia de carateres ou a um token no valor nos resultados da pesquisa.

A tokenização divide a stream de texto numa série de tokens, com cada token a corresponder normalmente a uma única palavra.

Por exemplo:

  • name:foo seleciona recursos com nomes que contêm a substring foo, como foo1 e barfoo.
  • description:foo seleciona recursos com o token foo na descrição, como bar e foo.
  • location=foo corresponde aos recursos numa localização especificada com foo como o nome da localização.

O comportamento destes qualificadores pode variar ligeiramente entre os modos de pesquisa, conforme detalhado nas secções seguintes.

As chaves de predicado type, system, location e orgid suportam apenas o qualificador de correspondência exata (=) e não o qualificador de substring (:). Por exemplo, type=foo ou orgid=number.

O Dataplex Universal Catalog suporta os seguintes qualificadores para a pesquisa de palavras-chave:

Qualificador Descrição
name:x Corresponde a x como uma substring do ID do recurso.
displayname:x Corresponde a x como uma substring do nome a apresentar do recurso.
column:x Corresponde a x como uma substring do nome da coluna (ou do nome da coluna aninhada) no esquema do recurso.
description:x Corresponde a x como um token na descrição do recurso.
label:bar Corresponde aos recursos do BigQuery que têm uma etiqueta (com algum valor) e a chave da etiqueta tem bar como uma substring.
label=bar Corresponde aos recursos do BigQuery que têm uma etiqueta (com algum valor) e a chave da etiqueta é igual a bar como uma string.
label:bar:x Corresponde a x como uma subcadeia no valor de uma etiqueta com a chave bar anexada a um recurso do BigQuery.
label=foo:bar Corresponde aos recursos do BigQuery em que a chave é igual a foo e o valor da chave é igual a bar.
label.foo=bar Corresponde aos recursos do BigQuery em que a chave é igual a foo e o valor da chave é igual a bar.
label.foo Corresponde aos recursos do BigQuery que têm uma etiqueta cuja chave é igual a foo como uma string.
type=TYPE Corresponde a recursos de um tipo de entrada específico ou ao respetivo alias de tipo.
projectid:bar Faz corresponder recursos em Google Cloud projetos que correspondam a bar como uma subcadeia no ID.
parent:x Corresponde a x como uma substring do caminho hierárquico de um recurso. O caminho principal é um fully_qualified_name do recurso principal.
orgid=number Corresponde a recursos numa organização de Google Cloud com o valor de ID exato de number.
system=SYSTEM Faz corresponder recursos de um sistema especificado.
location=LOCATION

Faz corresponder recursos numa localização especificada com um nome exato. Por exemplo, location=us-central1 corresponde a recursos alojados no Iowa.

Os recursos do BigQuery Omni suportam este qualificador através do nome da localização do BigQuery Omni. Por exemplo, location=aws-us-east-1 corresponde aos recursos do BigQuery Omni no norte da Virgínia.

createtime

Encontra recursos que foram criados dentro, antes ou depois de uma determinada data ou hora.

Por exemplo:

  • createtime:2019-01-01 corresponde aos recursos criados a 2019-01-01.
  • createtime<2019-02 corresponde a recursos criados antes de 2019-02-01T00:00:00.
  • createtime>2019-02 corresponde a recursos criados após 2019-02-01T00:00:00.

Formato de data/hora: YYYY-MM-DDThh:mm:ss

Todas as indicações de tempo têm de estar em GMT. Os fusos horários não são suportados. As indicações de tempo parciais, os separadores de datas com hífen (-) e os separadores de datas com barra (/) são suportados.

Por exemplo:

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

Encontra recursos que foram atualizados dentro, antes ou depois de uma determinada data ou hora.

Por exemplo:

  • updatetime:2019-01-01 corresponde aos recursos atualizados a 2019-01-01.
  • updatetime<2019-02 corresponde a recursos atualizados antes de 2019-02-01T00:00:00.
  • updatetime>2019-02 corresponde a recursos atualizados após 2019-02-01T00:00:00.

Formato de data/hora: YYYY-MM-DDThh:mm:ss

Todas as indicações de tempo têm de estar em GMT. Os fusos horários não são suportados. As indicações de tempo parciais, os separadores de datas com hífen (-) e os separadores de datas com barra (/) são suportados.

Por exemplo:

  • 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 Corresponde a x como uma substring de fully_qualified_name.
fully_qualified_name=x Corresponde a x como fully_qualified_name.

IA

As chaves de predicado type, system, location e description, e a pesquisa de aspetos (excluindo has) suportam apenas o qualificador de correspondência exata (=) e não o qualificador de substring (:). Por exemplo, type=foo.

O Dataplex Universal Catalog suporta os seguintes qualificadores para a pesquisa em linguagem natural:

Qualificador Descrição
name:x Corresponde a x como uma subcadeia do ID do recurso ou do nome a apresentar do recurso.
displayname:x Corresponde a x como uma substring do nome a apresentar do recurso.
column:x Corresponde a x como uma substring do nome da coluna (ou do nome da coluna aninhada) no esquema do recurso.
description:x Corresponde a x como um token na descrição do recurso.
labels:bar Corresponde aos recursos do BigQuery que têm uma etiqueta (com algum valor) e a chave da etiqueta tem bar como uma substring.
labels=bar Corresponde aos recursos do BigQuery que têm uma etiqueta (com algum valor) e a chave da etiqueta é igual a bar como uma string.
labels.bar:x Corresponde a x como uma subcadeia no valor de uma etiqueta com a chave bar anexada a um recurso do BigQuery.
labels.foo=bar Corresponde aos recursos do BigQuery em que a chave é igual a foo e o valor da chave é igual a bar.
type=TYPE Corresponde a recursos de um tipo de entrada específico ou ao respetivo alias de tipo.
projectid:bar Faz corresponder recursos em Google Cloud projetos que correspondam a bar como uma subcadeia no ID.
parent:x Corresponde a x como uma substring do caminho hierárquico de um recurso.
system=SYSTEM Faz corresponder recursos de um sistema especificado.
location=LOCATION

Faz corresponder recursos numa localização especificada com um nome exato. Por exemplo, location=us-central1 corresponde a recursos alojados no Iowa.

Os recursos do BigQuery Omni suportam este qualificador através do nome da localização do BigQuery Omni. Por exemplo, location=aws-us-east-1 corresponde aos recursos do BigQuery Omni no norte da Virgínia.

createtime

Encontra recursos que foram criados dentro, antes ou depois de uma determinada data ou hora.

Por exemplo:

  • createtime:2019-01-01 corresponde a todos os recursos criados a 01-01-2019.
  • createtime<2019-02 corresponde a todos os recursos criados antes de 2019-02-01T00:00:00.
  • createtime>2019-02 corresponde a todos os recursos criados após 01/02/2019 às 00:00:00.
  • createtime>-30d corresponde a todos os recursos criados nos últimos 30 dias.
  • createtime<=-30d corresponde a todos os recursos criados há 30 dias ou mais.
  • createtime<=-1d corresponde a todos os recursos criados no dia anterior.

Formato de data/hora: YYYY-MM-DDThh:mm:ss

Todas as indicações de tempo têm de estar em GMT. Os fusos horários não são suportados. As indicações de tempo parciais, os separadores de datas com hífen (-) e os separadores de datas com barra (/) são suportados.

Por exemplo:

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

Encontra recursos que foram atualizados dentro, antes ou depois de uma determinada data ou hora.

Por exemplo:

  • updatetime:2019-01-01 corresponde a todos os recursos atualizados a 01-01-2019.
  • updatetime<2019-02 corresponde a todos os recursos atualizados antes de 2019-02-01T00:00:00.
  • updatetime>2019-02 corresponde a todos os recursos atualizados após 2019-02-01T00:00:00.
  • updatetime>-30d corresponde a todos os recursos atualizados nos últimos 30 dias.
  • updatetime<-30d corresponde a todos os recursos atualizados há 30 dias ou mais.
  • updatetime=-1d corresponde a todos os recursos atualizados no dia anterior.
  • updatetime>=-30d corresponde a todos os recursos atualizados nos últimos 30 dias.
  • updatetime<=-30d corresponde a todos os recursos atualizados há 30 dias ou antes.

Formato de data/hora: YYYY-MM-DDThh:mm:ss

Todas as indicações de tempo têm de estar em GMT. Os fusos horários não são suportados. As indicações de tempo parciais, os separadores de datas com hífen (-) e os separadores de datas com barra (/) são suportados.

Por exemplo:

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

Para pesquisar entradas com base nos respetivos aspetos anexados, use a seguinte sintaxe de consulta.

Pesquisa de palavras-chave

Qualificador Descrição
aspect:x Corresponde a x como uma substring do caminho completo para o tipo de aspeto de um aspeto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID
aspect=x Corresponde a x como o caminho completo para o tipo de aspeto de um aspeto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID
aspect:xOPERATORvalue

Pesquisa valores de campos de aspeto. Corresponde a x como uma substring do caminho completo para o tipo de aspeto e o nome do campo de um aspeto que está anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID.FIELD_NAME

A lista de operadores suportados depende do tipo de campo no aspeto, da seguinte forma:

  • String: = (correspondência exata) e : (substring)
  • Todos os tipos de números: =, :, <, >, <=, >=, =>, =<
  • Enum: =
  • Data/hora: igual ao dos números, mas os valores a comparar são tratados como datas/horas em vez de números
  • Booleano: =

Apenas os campos de nível superior do aspeto são pesquisáveis.

Por exemplo, todas as consultas seguintes correspondem a entradas em que o valor do campo is-enrolled no aspeto employee-info é true. Também são devolvidas outras entradas que correspondam à substring.

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

Pesquisa de linguagem natural

IA

Qualificador Descrição
has:x Corresponde a x como uma substring do caminho completo para o tipo de aspeto de um aspeto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID
has=x Corresponde a x como o caminho completo para o tipo de aspeto de um aspeto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID
xOPERATORvalue

Pesquisa valores de campos de aspeto. Corresponde a x como uma substring do caminho completo para o tipo de aspeto e o nome do campo de um aspeto que está anexado à entrada, nos seguintes formatos:

  • Sintaxe para tipos de aspetos do sistema:

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

    Por exemplo, as seguintes consultas correspondem a entradas em que o valor do campo type no aspeto bigquery-dataset é default:

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

    • Se o aspeto for criado na região global: PROJECT_ID.ASPECT_TYPE_ID.FIELD_NAME
    • Se o aspeto for criado numa região específica: PROJECT_ID.REGION.ASPECT_TYPE_ID.FIELD_NAME

    Por exemplo, as seguintes consultas correspondem a entradas em que o valor do campo is-enrolled no aspeto employee-info é true.

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

    A lista de operadores suportados depende do tipo de campo no aspeto, da seguinte forma:

    • String: = (correspondência exata)
    • Todos os tipos de números: =, :, <, >, <=, >=, =>, =<
    • Enum: =
    • Data/hora: igual ao dos números, mas os valores a comparar são tratados como datas/horas em vez de números
    • Booleano: =

Apenas os campos de nível superior do aspeto são pesquisáveis.

Operadores lógicos

Uma consulta pode consistir em vários predicados com operadores lógicos. Se não especificar um operador, o operador lógico AND é implícito. Por exemplo, foo bar devolve recursos que correspondem ao predicado foo e ao predicado bar.

Os operadores lógicos AND e OR são suportados. Por exemplo, foo OR bar.

Pode negar um predicado com um prefixo - (hífen) ou NOT. Por exemplo, -name:foo devolve recursos com nomes que não correspondem ao predicado foo.

Sintaxe abreviada

Também está disponível uma sintaxe de pesquisa abreviada, que usa | (barra vertical) para operadores OR e , (vírgula) para operadores AND.

Por exemplo, para pesquisar entradas num de vários projetos usando o operador OR, pode usar a seguinte sintaxe abreviada:

projectid:(id1|id2|id3|id4)

A mesma pesquisa sem usar a sintaxe abreviada tem o seguinte aspeto:

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

Para pesquisar entradas com nomes de colunas correspondentes, use o seguinte:

  • E: column:(name1,name2,name3)
  • OU: column:(name1|name2|name3)

Esta sintaxe abreviada funciona para os predicados qualificados, exceto para label na pesquisa de palavras-chave.

O que se segue?