Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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 tag e outros tipos de metadados. Consulte O que é o Data Catalog?
Para iniciar uma consulta de pesquisa do Data Catalog no console do Google Cloud, acesse a página Pesquisa do Data Catalog e selecione Data Catalog como modo de pesquisa.
Na forma mais simples, uma consulta de pesquisa do Data Catalog contém 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 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
O valor de uma tag pública, o nome de um modelo de tag pública ou o nome de um campo em um modelo de tag pública anexado a uma entrada de dados.
(Pré-lançamento) Uma string para um endereço de e-mail ou nome de um administrador de dados
(Pré-lançamento) Uma string de uma descrição geral
A pesquisa simples não oferece suporte a campos de modelos 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
Modelo de tag pública com o nome foo, entradas de dados com o modelo foo, nome de exibição do modelo foo, nome do campo foo e valor do campo foo em uma string, um tipo enumerado ou um rich text.
(Pré-lançamento) Recurso de dados com um administrador de dados chamado foo.
(Pré-lançamento) Recurso de dados com uma visão geral que contém a palavra foo.
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 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:
foo1 e barfoo.
description:foo seleciona entidades com o token foo na descrição: bar and foo.
location=foo corresponde a todos os recursos de dados em um local especificado com foo como
o nome do local.
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. É possível pesquisar uma coluna aninhada pelo caminho usando o operador lógico AND. 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 é foo e o valor da chave é bar.
label.foo=bar
Corresponde a recursos de dados do BigQuery em que a chave é foo e o valor da chave é 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:
type=table corresponde a todas as tabelas, visualizações e visualizações materializadas.
type=dataset corresponde a todos os conjuntos de dados.
type=table.view ou type=view corresponde a todas as visualizações, mas não às visualizações materializadas.
type=materialized_view corresponde a todas as visualizações materializadas.
type=lake corresponde a todos os lagos.
type=zone corresponde a todas as zonas.
type=tag_template corresponde a todos os modelos de tag.
type=entry_group corresponde a todos os grupos de entrada.
type=data_stream corresponde a todos os tópicos Pub/Sub.
(Pré-lançamento) type=dataset.linked corresponde a todos os conjuntos de dados vinculados do Analytics Hub.
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:
system=bigquery corresponde a todos os recursos de dados do BigQuery.
system=cloud_bigtable corresponde a todos os recursos de dados do Bigtable.
system=cloud_pubsub corresponde a todos os recursos de dados do Pub/Sub.
system=cloud_spanner corresponde a todos os recursos de dados do Spanner.
system=dataproc_metastore corresponde a todos os recursos de dados do metastore do Dataproc.
system=data_catalog corresponde a todos os recursos de dados criados no Data Catalog.
system=dataplex corresponde a todos os recursos de dados criados no Dataplex.
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.
cluster_location=<location>
Corresponde a todos os recursos de dados do Bigtable em um local especificado com um nome exato. Por exemplo, cluster_location=us-central1 corresponde a todos os recursos hospedados em Iowa. Para conferir uma lista completa de locais com suporte, consulte Regiões do Bigtable.
tag:x
Corresponde a recursos de dados em que x corresponde a qualquer subsequência em <tag_template_project_id>.<tag_template_id>.<tag_field_id> de uma tag privada ou pública. Exemplos:
tag:data_owner corresponde recursos de dados que possuem a tag data_owner.
tag:data_gov_template corresponde recursos de dados que foram marcados com o modelo de tag data_gov_template.
tag:mycloudproject.data_gov_template corresponde a recursos de dados marcados com o modelo data_gov_template no projeto mycloudproject.
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 Google 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:
string/richtext: ":" Observação: os dois pontos dessa pesquisa de string indicam uma correspondência exata do token, não uma substring.
booleano e enum: "="
double: "=", "<", ">", "<=", ">="
timestamp: ":", "=", "<", ">", "<=", ">="
Examplos:
string: tag:data_owner:@mail.com corresponde a recursos de dados que têm valores @mail.com.
booleano: tag:data_gov_template.hasPII=true corresponde a hasPII tags booleanas no data_gov_template que são true.
enum: tag:certification_level_1=HIGHEST.
duplo: tag:datascore=9 corresponde aos recursos de dados com datascore tags duplas que têm valor 9.
timestamp: tag:expiredDate:2019-01-01 corresponde a recursos de dados que têm expiredDate tag de 2019-01-01.
timestamp: tag:expiredDate<2019-02 corresponde a recursos de dados que têm expiredDate antes de 2019-02-01T00:00:00.
createtime
Encontra recursos de dados que foram criados em, antes ou depois de uma determinada data ou hora. Exemplos:
createtime:2019-01-01 corresponde a recursos de dados criados em 2019-01-01.
createtime<2019-02 corresponde a recursos de dados criados antes de 2019-02-01T00:00:00.
createtime>2019-02 corresponde a recursos de dados criados após 2019-02-01T00:00:00.
updatetime
Encontra recursos de dados que foram atualizados em, antes ou depois de uma determinada data ou hora. Exemplos:
updatetime:2019-01-01 corresponde aos recursos de dados atualizados em 2019-01-01.
updatetime<2019-02 corresponde aos recursos de dados atualizados antes de 2019-02-01T00:00:00.
updatetime>2019-02 corresponde aos recursos de dados atualizados após 2019-02-01T00:00:00.
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.
term:x
Corresponde a ativos de dados conectados a um termo do glossário de negócios em que uma substring de nome, descrição ou administrador de dados corresponde a x.
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.
Operadores lógicos
Uma consulta pode ser composta por 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.
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 procurar entradas dentro de um dos vários projetos usando o operador OR, você pode 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 os predicados
qualificados listados anteriormente, exceto tag, term,
policytag, policytagid e label.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-02-01 UTC."],[[["\u003cp\u003eData Catalog search queries can be simple, using a single predicate to match substrings in data asset names, types, column names, project IDs, or tag values, among other criteria.\u003c/p\u003e\n"],["\u003cp\u003eQualified predicates refine searches by using keys like \u003ccode\u003ename:\u003c/code\u003e, \u003ccode\u003edescription:\u003c/code\u003e, \u003ccode\u003etype=\u003c/code\u003e, and \u003ccode\u003elocation=\u003c/code\u003e to specify the metadata field being searched, and whether the search should match a substring (\u003ccode\u003e:\u003c/code\u003e), or exact match (\u003ccode\u003e=\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eSearch queries support a wide array of qualifiers including \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003edisplayname\u003c/code\u003e, \u003ccode\u003ecolumn\u003c/code\u003e, \u003ccode\u003edescription\u003c/code\u003e, \u003ccode\u003elabel\u003c/code\u003e, \u003ccode\u003etype\u003c/code\u003e, \u003ccode\u003eprojectid\u003c/code\u003e, \u003ccode\u003eparent\u003c/code\u003e, \u003ccode\u003eorgid\u003c/code\u003e, \u003ccode\u003esystem\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003etag\u003c/code\u003e, \u003ccode\u003ecreatetime\u003c/code\u003e, \u003ccode\u003eupdatetime\u003c/code\u003e, \u003ccode\u003epolicytag\u003c/code\u003e, \u003ccode\u003epolicytagid\u003c/code\u003e, \u003ccode\u003eterm\u003c/code\u003e, \u003ccode\u003efully_qualified_name\u003c/code\u003e, allowing for detailed searches.\u003c/p\u003e\n"],["\u003cp\u003eLogical operators such as \u003ccode\u003eAND\u003c/code\u003e, \u003ccode\u003eOR\u003c/code\u003e, and negation (\u003ccode\u003e-\u003c/code\u003e or \u003ccode\u003eNOT\u003c/code\u003e) can combine multiple predicates to create complex search queries, with \u003ccode\u003eAND\u003c/code\u003e being the default operator when no operator is specified.\u003c/p\u003e\n"],["\u003cp\u003eAn abbreviated syntax using \u003ccode\u003e|\u003c/code\u003e for \u003ccode\u003eOR\u003c/code\u003e and \u003ccode\u003e,\u003c/code\u003e for \u003ccode\u003eAND\u003c/code\u003e is available for certain qualified predicates (excluding \u003ccode\u003etag\u003c/code\u003e, \u003ccode\u003eterm\u003c/code\u003e, \u003ccode\u003epolicytag\u003c/code\u003e, \u003ccode\u003epolicytagid\u003c/code\u003e and \u003ccode\u003elabel\u003c/code\u003e), streamlining the construction of complex queries.\u003c/p\u003e\n"]]],[],null,["# Data Catalog search syntax\n\nThis document describes the syntax for Data Catalog search queries. Before you read this document, it is important that you understand the concepts of Data Catalog such as data entry, tags and tag templates, and other kinds of metadata. See [What is Data Catalog?](/data-catalog/docs/concepts/overview).\n\nTo launch a Data Catalog search query in the\nGoogle Cloud console, go to the Data Catalog **Search** page and\nselect **Data Catalog** as the search mode.\n\n[Go to Search](https://console.cloud.google.com/dataplex/search)\n\nSimple search\n-------------\n\nIn its simplest form, a Data Catalog search query comprises a single predicate. Such a\npredicate can match several pieces of metadata:\n\n- A substring of a name, display name, or description of a data asset\n- Exact type of a data asset\n- A substring of a column name (or [nested column](/bigquery/docs/nested-repeated) name) in the schema of a data asset\n- A substring of a project ID\n- The value of a public tag, the name of a public tag template, or a field name in a public tag template attached to a data entry.\n- (Preview) A string for an email address or name for a data steward\n- (Preview) A string from an overview description\n\nThe simple search does not support tag template fields of type `datetime`.\n\nFor example, the predicate `foo` matches the following entities:\n\n- Data asset with the `foo.bar` name\n- Data asset with the `Foo Bar` display name\n- Data asset with the description `This is the foo script.`\n- Data asset with the exact `foo` type\n- Column `foo_bar` in the schema of a data asset\n- Nested column `foo_bar` in the schema of a data asset\n- Project `prod-foo-bar`\n- Public tag template named `foo`, data entries tagged with the `foo` tag template, tag template display name of `foo`, tag template field name of `foo`, and tag field value of `foo` in a string, enum, or rich text.\n- (Preview) Data asset with a data steward called `foo`.\n- (Preview) Data asset with an overview containing the word `foo`.\n\nTo know more about the roles and permissions to view public and private tags, see [Roles to view public and private tags](/data-catalog/docs/concepts/iam#roles_to_view_public_and_private_tags).\n\nQualified predicates\n--------------------\n\nYou can qualify a predicate by prefixing it with a key that restricts the\nmatching to a specific piece of metadata.\n\nAn equal sign (`=`) restricts the search to an exact match.\n\nA colon (`:`) after the key matches the predicate to either a substring or token within\nthe value in search results.\n\nTokenization breaks the stream of text up into a series of tokens, with\neach token usually corresponding to a single word.\n\nFor example:\n\n- `name:foo` selects entities with names that contain the `foo` substring: `foo1` and `barfoo`.\n- `description:foo` selects entities with the `foo` token in the description: `bar and foo`.\n- `location=foo` matches all data assets in a specified location with `foo` as the location name.\n\n| **Note:** You can only search for an exact `type=foo`, `system=foo`, `location=foo`, or `orgid=number`. The corresponding predicate keys can't be followed by a colon.\n\nData Catalog supports the following qualifiers:\n\nLogical operators\n-----------------\n\nA query can be comprised of several\npredicates with logical operators. If you don't specify an operator, logical\n`AND` is implied. For example, `foo bar` returns entities that match both\npredicate `foo` and predicate `bar`.\n\nLogical AND and logical OR are supported, for example, `foo OR bar`.\n\nYou can negate a predicate with a `-` or `NOT` prefix. For example, `-name:foo` returns\nall entities with names that don't match the predicate `foo`.\n| Logical operators are not case-sensitive (for example, \"or\" and \"OR\" are acceptable).\n\n### Abbreviated syntax\n\nAn abbreviated search syntax is also available, using `|` for `OR` operators and\n`,` for `AND` operators.\n\nFor example, to search for entries inside one of many projects using the `OR`\noperator, you can use:\n\n`projectid:(pid1|pid2|pid3|pid4)`\n\nInstead of:\n\n`projectid:pid1 OR projectid:pid2 OR projectid:pid3 OR projectid:pid4`\n\nTo search for entries with matching column names:\n\n- AND: `column:(name1, name2, name3)`\n- OR: `column:(name1|name2|name3)`\n\nThis abbreviated syntax works for the [qualified\npredicates](#qualified_predicates) listed earlier, except for `tag`, `term`,\n`policytag`, `policytagid` and `label`."]]
