Sintaxe de pesquisa para o Dataplex Catalog

Este documento descreve a sintaxe das consultas de pesquisa do Dataplex. Antes de ler este documento, é importante entender os conceitos do Dataplex Catalog, como entradas, aspectos, tipos de aspecto, grupos de entrada e tipos de entrada. Para mais informações, consulte Visão geral do Dataplex Catalog.

Observação: este documento descreve a sintaxe de pesquisa do Dataplex Catalog. Para mais informações sobre a sintaxe de pesquisa do Data Catalog, consulte Sintaxe de pesquisa do Data Catalog e Dataplex Catalog x Data Catalog.

Para iniciar uma consulta de pesquisa do Dataplex Catalog no console do Google Cloud , acesse a página Pesquisa do Dataplex e selecione Dataplex Catalog como o modo de pesquisa.

Acesse Pesquisar

Para mais informações, consulte Pesquisar recursos no Dataplex Catalog.

Pesquisa simples

Na forma mais simples, uma consulta de pesquisa do Dataplex Catalog consiste em um único predicado. Esse predicado pode corresponder a várias partes de metadados:

• Uma substring de um nome, nome de exibição ou descrição de um recurso
• Uma substring do tipo de um recurso
• Uma substring de um nome de coluna (ou nome de coluna aninhada) no esquema de um recurso.
• Uma substring de um ID do projeto
• Uma string de uma descrição geral

Por exemplo, o predicado foo corresponde às seguintes entidades:

• Recurso com o nome foo.bar
• Recurso com o nome de exibição Foo Bar
• Recurso com a descrição This is the foo script
• Recurso com o tipo exato foo
• Coluna foo_bar no esquema de um recurso
• Coluna aninhada foo_bar no esquema de um recurso
• Projeto prod-foo-bar
• Recurso com uma visão geral que contém a palavra foo

Predicados qualificados

Você pode qualificar um predicado usando um prefixo com uma chave que restringe a correspondência a uma parte específica dos metadados:

• Um sinal de igual (=) restringe a pesquisa a uma correspondência exata.
• Dois pontos (:) após a chave corresponde ao predicado em um substring ou um token dentro do valor nos resultados da pesquisa.

A tokenização divide o fluxo de texto em uma série de tokens, cada um geralmente correspondente a uma palavra.

Exemplo:

• name:foo seleciona entidades com nomes que contêm a substring foo, como foo1 e barfoo.
• description:foo seleciona entidades com o token foo na descrição, como bar e foo.
• location=foo corresponde a recursos em um local especificado com foo como o nome do local.

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

O Dataplex Catalog oferece suporte aos seguintes qualificadores:

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 de exibição do recurso.
column:x	Corresponde a x como uma substring do nome da coluna (ou nome de coluna aninhada) no esquema do recurso.
description:x	Corresponde x como um token na descrição do recurso.
label:bar	Corresponde a recursos do BigQuery que têm um rótulo (com algum valor) e a chave de rótulo tem bar como substring.
label=bar	Corresponde a recursos do BigQuery que têm um rótulo (com algum valor) e a chave de rótulo é igual a bar como uma string.
label:bar:x	Corresponde a x como uma substring no valor de um rótulo 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 a recursos do BigQuery que têm um rótulo com uma chave igual a foo como uma string.
type=TYPE	Corresponde a recursos de um tipo de entrada específico ou ao alias do tipo.
projectid:bar	Corresponde a recursos em projetos do Google Cloud que correspondem a bar como substring no ID.
parent:x	Corresponde a x como uma substring do caminho hierárquico de um recurso. O caminho pai é um fully_qualified_name do recurso pai.
orgid=number	Corresponde aos recursos em uma organização do Google Cloud com o valor exato do ID de number.
system=SYSTEM	Corresponde a recursos de um sistema especificado.
location=LOCATION	Corresponde a recursos em um local especificado com um nome exato. Por exemplo, location=us-central1 corresponde a recursos hospedados em Iowa. Os recursos do BigQuery Omni são compatíveis com esse qualificador usando o nome do local do BigQuery Omni. Por exemplo, location=aws-us-east-1 corresponde a recursos do BigQuery Omni no norte da Virgínia.
createtime	Encontra recursos criados antes, depois ou em uma determinada data ou hora. Exemplo: createtime:2019-01-01 corresponde a recursos criados em 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 do carimbo de data/hora: YYYY-MM-DDThh:mm:ss Todos os carimbos de data/hora precisam estar em GMT. Os fusos horários não são aceitos. Carimbos de data/hora parciais, separadores de data hífen (-) e barra (/) são aceitos. 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 atualizados em, antes ou depois de uma determinada data ou hora. Exemplo: updatetime:2019-01-01 corresponde aos recursos atualizados em 2019-01-01. updatetime<2019-02 corresponde a recursos atualizados antes de 2019-02-01T00:00:00. updatetime>2019-02 corresponde aos recursos atualizados após 2019-02-01T00:00:00. Formato do carimbo de data/hora: YYYY-MM-DDThh:mm:ss Todos os carimbos de data/hora precisam estar em GMT. Os fusos horários não são aceitos. Carimbos de data/hora parciais, separadores de data hífen (-) e barra (/) são aceitos. 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.

Pesquisa de aspecto

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

Observação: a correspondência de substring tenta corresponder a um número limitado de aspectos. Se você não encontrar a entrada usando um fragmento do caminho, use o caminho completo para restringir a pesquisa e aumentar a recuperação.

Qualificador	Descrição
aspect:x	Corresponde a x como uma substring do caminho completo para o tipo de aspecto de um aspecto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID
aspect=x	Corresponde a x como o caminho completo para o tipo de aspecto de um aspecto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID
aspect:xOPERATORvalue	Pesquisa valores de campo de aspecto. Corresponde a x como uma substring do caminho completo para o tipo de aspecto e o nome do campo de um aspecto anexado à entrada, no formato projectid.location.ASPECT_TYPE_ID.FIELD_NAME A lista de operadores compatíveis depende do tipo de campo no aspecto, conforme abaixo: String: = (correspondência exata) e : (substring) Todos os tipos de números: =, :, <, >, <=, >=, =>, =< Enum: = Data e hora: igual aos números, mas os valores a serem comparados são tratados como datas e horas em vez de números. Booleano: = Somente os campos de nível superior do aspecto podem ser pesquisados. Por exemplo, todas as consultas a seguir correspondem a entradas em que o valor do campo is-enrolled no aspecto employee-info é true. Outras entradas que correspondem à substring também são retornadas. aspect:example-project.us-central1.employee-info.is-enrolled=true aspect:example-project.us-central1.employee=true aspect:employee=true

Operadores lógicos

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

AND lógico e OR lógico são aceitos. Por exemplo, foo OR bar.

É possível negar um predicado com um prefixo - (hífen) ou NOT. Por exemplo, -name:foo retorna entidades com nomes que não correspondem ao predicado foo.

Os operadores lógicos não diferenciam maiúsculas de minúsculas. Por exemplo, or e OR são aceitáveis.

Sintaxe abreviada

Uma sintaxe de pesquisa abreviada também está disponível, usando | (barra vertical) para operadores OR e , (vírgula) para operadores AND.

Por exemplo, para procurar entradas dentro de um dos vários projetos usando o operador OR, use a seguinte sintaxe abreviada:

projectid:(id1|id2|id3|id4)

A mesma pesquisa sem usar a sintaxe abreviada fica assim:

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

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

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

Essa sintaxe abreviada funciona para os predicados qualificados, exceto label.

A seguir

• Saiba como pesquisar recursos no Dataplex Catalog.
• Saiba mais sobre o Dataplex Catalog.
• Saiba como enriquecer entradas com metadados usando aspectos.
• Saiba como gerenciar entradas e importar fontes personalizadas.