Usa la búsqueda solo por palabras clave en Knowledge Catalog para encontrar recursos con palabras clave, filtros y una sintaxis definidos. La búsqueda solo por palabras clave te brinda un control preciso sobre tus búsquedas y te permite acotar los resultados según los campos de metadatos.
Antes de comenzar
Antes de realizar la búsqueda, asegúrate de que se te hayan otorgado los roles necesarios y de haber habilitado la API necesaria.
Roles obligatorios
Para obtener los permisos que necesitas para buscar entradas y acceder a los resultados de la búsqueda en Knowledge Catalog, pídele a tu administrador que te otorgue los siguientes roles de IAM:
-
Buscar entradas:
- Administrador de Catálogo de Dataplex (
roles/dataplex.catalogAdmin) en el proyecto que se usa para la búsqueda - Editor del catálogo de Dataplex (
roles/dataplex.catalogEditor) en el proyecto que se usa para la búsqueda - Visualizador del catálogo de Dataplex (
roles/dataplex.catalogViewer) en el proyecto que se usa para la búsqueda
- Administrador de Catálogo de Dataplex (
-
Busca metadatos para conjuntos de datos y tablas de BigQuery:
Visualizador de metadatos de BigQuery (
roles/bigquery.metadataViewer) en el conjunto de datos o la tabla -
Buscar entradas personalizadas:
Visualizador del catálogo de Dataplex (
roles/dataplex.catalogViewer) en el proyecto
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Cómo usar la búsqueda solo por palabras clave
Console
Para buscar recursos con la búsqueda por palabras clave, sigue estos pasos:
En la consola de Google Cloud , ve a la página Búsqueda de Knowledge Catalog.
En el campo Encuentra recursos en todos los proyectos, ingresa tu consulta.
Para definir mejor tu búsqueda, usa el panel Filtros. Están disponibles los siguientes filtros:
- En Sistemas, se proporciona una lista de los sistemas disponibles, como BigQuery o Cloud SQL. El sistema de Knowledge Catalog contiene entradas personalizadas.
- Los aspectos te permiten consultar los recursos etiquetados con una plantilla específica. Puedes usar el menú Personalizar para definir mejor los resultados y filtrar por valores de aspectos específicos.
- En Proyecto, se enumeran los proyectos en los que puedes definir el alcance de la búsqueda.
- Los alias de tipo son tipos de datos asociados con un tipo de entrada. Un tipo de entrada puede tener el nombre
projects/test-project/locations/us/entryTypes/my-entry-type, pero puedes buscarlo con sus alias de tipoTABLEoDATABASE. Puedes establecer uno o más alias de tipo cuando creas o actualizas un tipo de entrada. - Los conjuntos de datos provienen de BigQuery.
Puedes agregar manualmente los siguientes filtros:
- Agrega un filtro de proyecto: En Proyecto, haz clic en Agregar proyecto. Busca un proyecto específico, selecciónalo y, luego, haz clic en Abrir.
- Agrega un filtro de tipo de aspecto: En Aspectos, haz clic en el menú Agregar más tipos de aspectos. Busca una plantilla específica, selecciónala y, luego, haz clic en Aceptar.
Opcional: Además de los recursos disponibles, puedes buscar recursos que estén disponibles públicamente en Google Cloud seleccionando Incluir conjuntos de datos públicos.
Usa las siguientes sugerencias para crear una búsqueda:
- Encierra la expresión de búsqueda entre comillas si contiene espacios. Por ejemplo,
"search terms". - Antepone
NOTa una palabra clave para que coincida con la negación lógica del filtrokeyword:term. También puedes usar los operadores booleanosANDyORpara combinar expresiones de búsqueda. Los operadoresAND,ORyNOTno distinguen mayúsculas de minúsculas.
Por ejemplo,
NOT column:termenumera todas las columnas, excepto las que coinciden con el término especificado.- Encierra la expresión de búsqueda entre comillas si contiene espacios. Por ejemplo,
Para ver más información sobre el recurso buscado, haz clic en su nombre en los resultados de la búsqueda. Se abrirá la página de detalles de la entrada.
gcloud
Para buscar recursos, usa el comando gcloud dataplex entries search.
C#
C#
Antes de probar este ejemplo, sigue las instrucciones de configuración para C# que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog C#.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Go
Go
Antes de probar este ejemplo, sigue las instrucciones de configuración para Go que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre las bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog Go.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Antes de probar este ejemplo, sigue las instrucciones de configuración para Java que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog Java.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Antes de probar este ejemplo, sigue las instrucciones de configuración para Node.js que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog para Node.js.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
PHP
PHP
Antes de probar este ejemplo, sigue las instrucciones de configuración para PHP que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog para PHP.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Antes de probar este ejemplo, sigue las instrucciones de configuración para Python que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog para Python.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ruby
Ruby
Antes de probar este ejemplo, sigue las instrucciones de configuración para Ruby que encontrarás en la guía de inicio rápido de Knowledge Catalog sobre las bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Knowledge Catalog Ruby.
Para autenticarte en Knowledge Catalog, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
REST
Para buscar recursos, usa el método searchEntries.
Sintaxis de búsqueda solo de palabras clave
Para realizar búsquedas precisas, puedes crear una consulta con una sintaxis específica, incluidos calificadores, operadores lógicos y búsquedas por aspecto.
Predicados calificados
Puedes calificar un predicado anteponiéndole una clave que restrinja la coincidencia a un fragmento específico de metadatos:
- El signo igual (
=) restringe la búsqueda a una concordancia exacta. - Los dos puntos (
:) después de la clave hacen coincidir el predicado con una subcadena o un token dentro del valor en los resultados de la búsqueda.
La tokenización divide el flujo de texto en una serie de tokens, y cada token suele corresponder a una sola palabra.
Las claves de predicado type, system, location y orgid solo admiten el calificador de coincidencia exacta (=), no el calificador de subcadena (:). Por ejemplo, type=foo o orgid=number.
La búsqueda de palabras clave de Knowledge Catalog admite los siguientes calificadores:
| Calificador | Descripción |
|---|---|
name:x |
Coincide con x como subcadena del ID del recurso. |
displayname:x |
Coincide con x como subcadena del nombre visible del recurso. |
column:x |
Coincide con x como una subcadena del nombre de la columna (o del nombre de la columna anidada) en el esquema del recurso. |
description:x |
Coincide con x como un token en la descripción del recurso. |
label:bar |
Coincide con los recursos de BigQuery que tienen una etiqueta (con algún
valor) y la clave de etiqueta tiene bar como una subcadena. |
label=bar |
Coincide con los recursos de BigQuery que tienen una etiqueta (con algún valor) y la clave de la etiqueta es igual a bar como una cadena. |
label:bar:x |
Coincide con x como subcadena en el valor de una etiqueta con la clave bar adjunta a un recurso de BigQuery. |
label=foo:bar |
Coincide con los recursos de BigQuery en los que la clave es igual a
foo y el valor de la clave es igual a bar. |
label.foo=bar |
Coincide con los recursos de BigQuery en los que la clave es igual a
foo y el valor de la clave es igual a bar. |
label.foo |
Coincide con los recursos de BigQuery que tienen una etiqueta cuya clave es igual a foo como una cadena. |
type=TYPE |
Coincide con los recursos de un tipo de entrada específico o su alias de tipo. |
projectid:bar |
Coincide con los recursos dentro de los proyectos de Google Cloud que coinciden con
bar como una subcadena en el ID. |
parent:x |
Coincide con x como una subcadena de la ruta jerárquica de un recurso. La ruta de acceso superior es un fully_qualified_name del
recurso superior. |
orgid=number |
Coincide con los recursos dentro de una organización Google Cloud con el valor de ID exacto de number. |
system=SYSTEM |
Coincide con los recursos de un sistema especificado. |
location=LOCATION |
Coincide con los recursos en una ubicación especificada con un nombre exacto.
Por ejemplo, Los recursos de BigQuery Omni admiten este calificador con el
nombre de la ubicación de BigQuery Omni.
Por ejemplo,
|
createtime |
Busca recursos que se crearon dentro de un período determinado, antes o después de una fecha y hora específicas. Por ejemplo:
Formato de marca de tiempo: Todas las marcas de tiempo deben estar en GMT; no se admiten las zonas horarias. Se admiten marcas de tiempo parciales, separadores de fecha con guion ( Por ejemplo:
|
updatetime |
Busca recursos que se actualizaron dentro de una fecha u hora determinada, antes o después de ella. Por ejemplo:
Formato de marca de tiempo: Todas las marcas de tiempo deben estar en GMT; no se admiten las zonas horarias. Se admiten marcas de tiempo parciales, separadores de fecha con guion ( Por ejemplo:
|
fully_qualified_name:x |
Coincide con x como una subcadena de fully_qualified_name. |
fully_qualified_name=x |
Coincide con x como fully_qualified_name. |
Búsqueda por aspectos
Para buscar entradas según sus aspectos adjuntos, usa la siguiente sintaxis de consulta.
| Calificador | Descripción |
|---|---|
aspect:x |
Coincide con x como una subcadena de la ruta de acceso completa al tipo de aspecto
de un aspecto que se adjunta a la entrada, en el formato
projectid.location.ASPECT_TYPE_ID |
aspect=x |
Coincide con x como la ruta de acceso completa al tipo de aspecto
de un aspecto que se adjunta a la entrada, en el formato
projectid.location.ASPECT_TYPE_ID |
aspect:xOPERATORvalue |
Busca valores de campos de aspectos. Coincide con La lista de operadores admitidos depende del tipo de campo del aspecto, como se indica a continuación:
Solo se pueden buscar los campos de nivel superior del aspecto. Por ejemplo, todas las siguientes búsquedas coinciden con las entradas en las que el valor del campo
|
Operadores lógicos
Una consulta puede constar de varios predicados vinculados con operadores lógicos AND, OR o NOT.
- Si no especificas un operador,
ANDlógico está implícito. Por ejemplo,foo bardevuelve recursos que coinciden con el predicadofooy el predicadobar. - Niega un predicado con un prefijo
-(guion) oNOT. Por ejemplo,-name:foodevuelve recursos con nombres que no coinciden con el predicadofoo.
En la búsqueda solo por palabras clave, los operadores lógicos no distinguen mayúsculas de minúsculas.
Sintaxis abreviada
Para usar la sintaxis abreviada en tus consultas, usa | (barra vertical) para los operadores OR y , (coma) para los operadores AND.
La sintaxis abreviada funciona para los predicados calificados, excepto para label.
En los siguientes ejemplos, se muestra cómo usar la sintaxis abreviada con la búsqueda solo por palabras clave.
Busca entradas dentro de uno de los muchos proyectos con el operador
ORprojectid:(id1|id2|id3|id4)La misma búsqueda sin usar la sintaxis abreviada se ve de la siguiente manera:
projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4Busca entradas con nombres de columna coincidentes:
- AND:
column:(name1,name2,name3) - O:
column:(name1|name2|name3)
- AND:
¿Qué sigue?
- Obtén más información sobre la administración de metadatos en Knowledge Catalog.
- Obtén información para enriquecer las entradas y los vínculos de entrada con metadatos usando aspectos.
- Obtén más información para administrar entradas y transferir fuentes personalizadas.