Use a pesquisa somente por palavra-chave no Knowledge Catalog para encontrar recursos usando palavras-chave, filtros e uma sintaxe definidos. A pesquisa somente por palavra-chave oferece controle preciso sobre suas consultas e permite restringir os resultados com base em campos de metadados.
Antes de começar
Antes de fazer a pesquisa, verifique se você tem os papéis necessários e ativou a API necessária.
Funções exigidas
Para ter as permissões necessárias para pesquisar entradas e acessar resultados da pesquisa no Knowledge Catalog, peça ao administrador para conceder a você os seguintes papéis do IAM:
-
Pesquisar entradas:
- Administrador do catálogo do Dataplex (
roles/dataplex.catalogAdmin) no projeto usado para pesquisa - Editor do catálogo do Dataplex (
roles/dataplex.catalogEditor) no projeto usado para pesquisa - Leitor do Dataplex Catalog (
roles/dataplex.catalogViewer) no projeto usado para pesquisa
- Administrador do catálogo do Dataplex (
-
Pesquisar metadados de conjuntos de dados e tabelas do BigQuery:
Visualizador de metadados do BigQuery (
roles/bigquery.metadataViewer) no conjunto de dados ou na tabela -
Pesquisar entradas personalizadas:
Leitor do Dataplex Catalog (
roles/dataplex.catalogViewer) no projeto
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.
Usar a pesquisa somente por palavra-chave
Console
Para pesquisar recursos usando a pesquisa por palavra-chave, siga estas etapas:
No console Google Cloud , acesse a página Pesquisa do Knowledge Catalog.
Se a plataforma de pesquisa estiver definida como Data Catalog, no menu Escolher plataforma de pesquisa, selecione Knowledge Catalog.
No campo Encontrar recursos em todos os projetos, insira sua consulta.
Para refinar sua pesquisa, use o painel Filtros. Os seguintes filtros estão disponíveis:
- Os sistemas fornecem uma lista de sistemas disponíveis, como BigQuery ou Cloud SQL. O sistema do Knowledge Catalog contém entradas personalizadas.
- Com os aspectos (tags), é possível consultar recursos marcados com um modelo específico. Use o menu Personalizar para refinar ainda mais os resultados e filtrar por valores de aspectos específicos.
- Projeto lista os projetos em que você pode definir o escopo da pesquisa.
- Os aliases de tipo são tipos de dados associados a um tipo de entrada. Um tipo de entrada pode ter o nome
projects/test-project/locations/us/entryTypes/my-entry-type, mas você pode pesquisar usando os aliases de tipoTABLEouDATABASE. É possível definir um ou mais aliases de tipo ao criar ou atualizar um tipo de entrada. - Os conjuntos de dados são provenientes do BigQuery.
É possível adicionar manualmente os seguintes filtros:
- Adicione um filtro de projeto: em Projeto, clique em Adicionar projeto. Pesquise um projeto específico, selecione-o e clique em Abrir.
- Adicione um filtro de tipo de aspecto: em Aspectos, clique no menu Adicionar mais tipos de aspecto. Procure um modelo específico, selecione-o e clique em OK.
Opcional: além dos recursos disponíveis para você, é possível pesquisar recursos disponíveis publicamente em Google Cloud selecionando Incluir conjuntos de dados públicos.
Use as dicas a seguir para criar uma consulta de pesquisa:
- Coloque sua expressão de pesquisa entre aspas se ela contiver espaços. Por exemplo,
"search terms" - Preceda uma palavra-chave com
NOTpara corresponder à negação lógica do filtrokeyword:term. Você também pode usar os operadores booleanosANDeORpara combinar expressões de pesquisa. Os operadoresAND,OReNOTnão diferenciam maiúsculas de minúsculas.
Por exemplo,
NOT column:termlista todas as colunas, exceto aquelas que correspondem ao termo especificado.- Coloque sua expressão de pesquisa entre aspas se ela contiver espaços. Por exemplo,
Para ver mais informações sobre o recurso pesquisado, clique no nome dele nos resultados da pesquisa. A página de detalhes da entrada será aberta.
gcloud
Para pesquisar recursos, use o
comando gcloud dataplex entries search.
C#
C#
Antes de testar esta amostra, siga as instruções de configuração do C# no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog C#.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Go
Antes de testar esta amostra, siga as instruções de configuração do Go no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Go.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Antes de testar esta amostra, siga as instruções de configuração do Java no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Java.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Antes de testar esta amostra, siga as instruções de configuração do Node.js no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Node.js.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
PHP
Antes de testar esta amostra, siga as instruções de configuração do PHP no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog PHP.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Antes de testar esta amostra, siga as instruções de configuração do Python no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Python.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Ruby
Antes de testar esta amostra, siga as instruções de configuração do Ruby no Guia de início rápido do Knowledge Catalog: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Knowledge Catalog Ruby.
Para autenticar no Knowledge Catalog, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
REST
Para pesquisar recursos, use o
método searchEntries.
Sintaxe de pesquisa somente com palavras-chave
Para pesquisas precisas, crie uma consulta usando uma sintaxe específica, incluindo qualificadores, operadores lógicos e pesquisas de aspectos.
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 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.
As chaves de predicado type, system, location e orgid são compatíveis apenas com o qualificador de correspondência exata (=), não com o qualificador de substring (:). Por exemplo, type=foo ou orgid=number.
A pesquisa de palavras-chave do Knowledge Catalog é compatível com os seguintes qualificadores:
| Qualificador | Descrição |
|---|---|
name:x |
Corresponde a x como uma substring do ID do recurso. |
displayname:x |
Corresponde x como substring do nome de exibição do recurso. |
column:x |
Corresponde x como uma substring do nome da coluna (ou nome da 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 do 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 do 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 a recursos do BigQuery em que a chave é igual a
foo e o valor da chave é igual a bar. |
label.foo=bar |
Corresponde a 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 cuja
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 Google Cloud que correspondem abarcomo uma substring 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 os recursos em uma organização Google Cloud ao valor exato do ID de number. |
system=SYSTEM |
Corresponde a recursos de um sistema especificado. |
location=LOCATION |
Corresponde recursos em um local especificado com um nome exato.
Por exemplo, Os recursos do BigQuery Omni oferecem suporte a esse qualificador usando o
nome do local do BigQuery Omni.
Por exemplo, |
createtime |
Encontra recursos criados em, antes ou depois de uma determinada data ou hora. Exemplo:
Formato do carimbo de data/hora: Todos os carimbos de data/hora precisam estar em GMT. Fusos horários não são aceitos. Timestamps parciais e separadores de data com hífen ( Exemplo:
|
updatetime |
Encontra recursos que foram atualizados em, antes ou depois de uma determinada data ou hora. Exemplo:
Formato do carimbo de data/hora: Todos os carimbos de data/hora precisam estar em GMT. Fusos horários não são aceitos. Timestamps parciais e separadores de data com hífen ( Exemplo:
|
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 aspectos
Para pesquisar entradas com base nos aspectos anexados, use a seguinte sintaxe de consulta.
| 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 A lista de operadores compatíveis depende do tipo de campo no aspecto, da seguinte forma:
Somente 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
|
Operadores lógicos
Uma consulta pode consistir em vários predicados vinculados com operadores lógicos AND, OR ou NOT.
- Se você não especificar um operador, o
ANDlógico ficará implícito. Por exemplo,foo barretorna recursos que correspondem ao predicadofooe ao predicadobar. - Negue um predicado com um prefixo
-(hífen) ouNOT. Por exemplo,-name:fooretorna recursos com nomes que não correspondem ao predicadofoo.
Na pesquisa somente por palavras-chave, os operadores lógicos não diferenciam maiúsculas de minúsculas.
Sintaxe abreviada
Para usar a sintaxe abreviada nas consultas, use | (barra vertical) para operadores OR e , (vírgula) para operadores AND.
A sintaxe abreviada funciona para os predicados qualificados, exceto label.
Os exemplos a seguir mostram como usar a sintaxe abreviada com a pesquisa somente por palavras-chave.
Pesquisar entradas em um de vários projetos usando o operador
ORprojectid:(id1|id2|id3|id4)A mesma pesquisa sem usar a sintaxe abreviada tem esta aparência:
projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4Para pesquisar entradas com nomes de coluna correspondentes:
- AND:
column:(name1,name2,name3) - OU:
column:(name1|name2|name3)
- AND: