Veja neste documento a sintaxe das consultas de pesquisa do Data Catalog. Antes de ler este documento, é importante entender os conceitos do Data Catalog, como entrada de dados, tags e modelos de tags e outros tipos de metadados. Consulte O que é o Data Catalog.
Para iniciar uma consulta de pesquisa do Data Catalog, acesse a página Pesquisa no Console do Google Cloud.
Acessar a Pesquisa do Data Catalog
Pesquisa simples
Na forma mais simples, uma consulta de pesquisa do Data Catalog compreende um único predicado. Esse predicado pode corresponder a várias partes de metadados:
- Substring de um nome, um nome de exibição ou uma descrição de um recurso de dados
- Tipo exato de recurso de dados
- Uma substring de um nome de coluna (ou nome de coluna aninhada) no esquema de um recurso de dados.
- Uma substring de um ID do projeto
- (Visualização) O valor de uma tag pública, o nome de um modelo de tag pública ou um nome de campo em um modelo de tag pública anexado a uma entrada de dados.
- (Visualização) Uma string de um endereço de e-mail ou nome de um administrador de dados
- (Visualização) Uma string de uma descrição de visão geral
A pesquisa simples não aceita campos do modelo de tag do tipo datetime
.
Por exemplo, o predicado foo
corresponde às seguintes entidades:
- Recurso de dados com o nome
foo.bar
- Recurso de dados com o nome de exibição
Foo Bar
- Recurso de dados com a descrição
This is the foo script.
- Recurso de dados com o tipo
foo
exato - Coluna
foo_bar
no esquema de um recurso de dados - Coluna aninhada
foo_bar
no esquema de um recurso de dados - Projeto
prod-foo-bar
- (Visualização) Modelo de tag público com o nome
foo
, entradas de dados marcadas comfoo
modelo de tag, nome de exibição do modelo de tag defoo
, nome do campo do modelo de tagfoo
e valor do campo da tag defoo
em uma string, enumeração ou rich text. - (Visualização) Recurso de dados com um administrador de dados chamado
foo
. - (Visualização) Recurso de dados com uma visão geral contendo a palavra
foo
.
Para saber mais sobre as funções e as permissões para visualizar tags públicas e privadas, consulte Funções para visualizar tags públicas e privadas.
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 corresponder ao predicado para uma 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 o nome exato dafoo
.name:foo
seleciona entidades com nomes que contêm a substringfoo
:foo1
ebarfoo
.description:foo
seleciona entidades com o tokenfoo
na descrição:bar and foo
.
O Data Catalog oferece suporte aos seguintes qualificadores:
Qualificador | Descrição |
---|---|
name:x |
Corresponde a x como substring do ID do recurso de dados. |
displayname:x |
Corresponda x como substring do nome de exibição do recurso de dados. |
column:x |
Corresponde a x como uma substring do nome da coluna (ou do nome da coluna aninhada) no esquema do recurso de dados.No momento, é possível pesquisar uma coluna aninhada pelo caminho usando o operador lógico ". Por exemplo, column:(foo bar) corresponde a uma coluna aninhada com o caminho foo.bar . |
description:x |
Corresponde x como um token na descrição do recurso de dados. |
label:bar |
Corresponde a recursos de dados 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 de dados 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 de dados do BigQuery. |
label=foo:bar |
Corresponde a recursos de dados do BigQuery em que a chave é igual a foo e o valor da chave é igual a bar . |
label.foo=bar |
Corresponde a recursos de dados do BigQuery em que a chave é igual a foo e o valor da chave é igual a bar . |
label.foo |
Corresponde a recursos de dados do BigQuery que têm um rótulo com uma chave igual a foo como uma string. |
type=<type> |
Corresponde a ativos de dados de um tipo ou subtipo de objeto específico. Os subtipos podem ser adicionados com o formato <type>.<sub-type>. Os tipos e subtipos incluem:
|
projectid:bar |
Corresponde recursos de dados dentro de projetos do Cloud que correspondem a bar como substring no ID. |
parent:x |
Corresponde a x como uma substring do caminho hierárquico de um recurso de dados do BigQuery. O caminho tem o formato <project_id>.<dataset_name> .Por exemplo, parent:foo.bar corresponde a todas as tabelas e visualizações de um conjunto de dados com o caminho project-foo.bar-dataset . |
orgid=number |
Corresponde os recursos de dados em uma organização do Cloud ao valor exato do ID de number . |
system=<system> |
Corresponde a todos os ativos de dados de um sistema especificado. Os sistemas incluem:
|
location=<location> |
Corresponde todos os recursos de dados em um local especificado com um nome exato. Por exemplo, location=us-central1 corresponde a todos os recursos hospedados em Iowa.Para ver uma lista completa de locais compatíveis, consulte Regiões do Data Catalog. |
tag:x |
Corresponde a recursos de dados em que x corresponde a qualquer substring em <tag_template_project_id >.<tag_template_id >.<tag_field_id > de uma tag particular ou pública.Exemplos:
|
tag:key<operator>val |
Primeiro, corresponde ao key com qualquer substring do ID do campo de tag, do ID do modelo de tag ou do ID do projeto do Cloud de um modelo de tag. Em seguida, corresponde val ao valor da tag de key , dependendo do tipo de campo de tag.Os conjuntos <operator> dependentes de tipo permitidos para valores de tag são:
|
createtime |
Encontra recursos de dados que foram criados em, antes ou depois de uma determinada data ou hora. Exemplos:
|
updatetime |
Encontra recursos de dados que foram atualizados em, antes ou depois de uma determinada data ou hora. Exemplos:
|
policytag:x |
Corresponde a x como uma substring do nome de exibição da tag de política. Encontra todos os recursos usando a tag da política de correspondência ou os descendentes. |
policytagid=x |
Corresponde a x como um ID de tag de política ou taxonomia. Encontra todos os recursos usando a tag da política de correspondência ou os descendentes. |
Operadores lógicos
Uma consulta pode ser composta por vários
predicados com operadores lógicos. Se você não especificar um operador, a lógica AND
será implícita. Por exemplo, foo bar
retorna entidades que correspondem aos predicados foo
e bar
.
Lógico "E" e lógico "OU" são suportados, por exemplo, foo OR bar
.
É possível negar um predicado com um prefixo -
ou NOT
. Por exemplo, -name:foo
retorna todas as entidades com nomes que não correspondem ao predicado foo
.
Sintaxe abreviada
Uma sintaxe de pesquisa abreviada também está disponível, usando |
para operadores OR
e ,
para operadores AND
.
Por exemplo, para pesquisar entradas em um dos muitos projetos usando o operador OR
, é possível usar:
projectid:(pid1|pid2|pid3|pid4)
Em vez de:
projectid:pid1 OR projectid:pid2 OR projectid:pid3 OR projectid:pid4
Para pesquisar entradas com nomes de coluna correspondentes:
- E:
column:(name1, name2, name3)
- OU:
column:(name1|name2|name3)
Essa sintaxe abreviada funciona para todos os predicados qualificados listados acima.