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 realizar a pesquisa, verifique se você recebeu os papéis necessários e ativou a API necessária.
Funções exigidas
Para receber as permissões necessárias para pesquisar entradas e acessar os resultados da pesquisa no Knowledge Catalog, peça ao administrador para conceder a você os seguintes papéis do IAM:
-
Pesquise 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:
Leitor 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.
No campo Encontre recursos em todos os projetos, insira sua consulta.
Para refinar a pesquisa, use o painel Filtros. Os seguintes filtros estão disponíveis:
- Sistemas fornece uma lista de sistemas disponíveis, como BigQuery ou Cloud SQL. O sistema do Knowledge Catalog contém entradas personalizadas.
- Os aspectos permitem 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.
- 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 por ele 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. Pesquise 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 no Google Cloud selecionando Incluir conjuntos de dados públicos.
Use as dicas a seguir para criar uma consulta de pesquisa:
- Coloque a expressão de pesquisa entre aspas se ela contiver espaços. Por exemplo,
"search terms" - Adicione
NOTantes de uma palavra-chave para corresponder à negação lógica do filtrokeyword:term. Também é possível 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 a 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 vai 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 por palavra-chave
Para pesquisas precisas, crie uma consulta usando uma sintaxe específica, incluindo qualificadores, operadores lógicos e pesquisas de aspectos.
Predicados qualificados
É possível 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. - Dois-pontos (
:) após a chave correspondem ao predicado a uma substring ou um token no valor dos resultados da pesquisa.
A tokenização divide o fluxo de texto em uma série de tokens, e cada token geralmente corresponde a uma única palavra.
As chaves de predicado type, system, location e orgid aceitam apenas o qualificador de correspondência exata (=), não o de substring (:). Por exemplo, type=foo ou orgid=number.
A pesquisa por palavra-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 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 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 um rótulo (com algum valor) e a chave do rótulo tem bar como uma substring. |
label=bar |
Corresponde aos 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 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 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 do Google Cloud que correspondem a bar como uma 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 a recursos em uma organização do Google Cloud com
o valor de ID exato 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, Os recursos do BigQuery Omni oferecem suporte a esse qualificador usando o nome do local do BigQuery Omni.
Por exemplo, |
createtime |
Encontra recursos que foram criados dentro, 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. Carimbos de data/hora
parciais, separadores de data com hífen ( Exemplo:
|
updatetime |
Encontra recursos que foram atualizados dentro, antes ou depois de uma data ou hora específica. 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. Carimbos de data/hora
parciais, 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, conforme mostrado a seguir:
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
|
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 palavra-chave, os operadores lógicos não diferenciam maiúsculas de minúsculas.
Sintaxe abreviada
Para usar a sintaxe abreviada nas suas 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 dos vários projetos usando o operador
ORprojectid:(id1|id2|id3|id4)A mesma pesquisa sem usar a sintaxe abreviada seria assim:
projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4Pesquise entradas com nomes de colunas correspondentes:
- AND:
column:(name1,name2,name3) - OU:
column:(name1|name2|name3)
- AND:
A seguir
- Saiba mais sobre o gerenciamento de metadados no Knowledge Catalog.
- Saiba como enriquecer entradas e links de entrada com metadados usando aspectos.
- Saiba como gerenciar entradas e ingerir fontes personalizadas.