Administra tus recursos de AlloyDB con Knowledge Catalog

La integración de Knowledge Catalog está habilitada de forma predeterminada para todos los clústeres nuevos de AlloyDB, lo que te permite buscar y administrar tus recursos de AlloyDB para PostgreSQL con Knowledge Catalog, una plataforma que te permite almacenar, administrar y acceder a metadatos. Esta integración te ayuda a descubrir y comprender tus metadatos de AlloyDB, y admite los siguientes casos de uso:

Análisis: Comprende las dependencias y evalúa la idoneidad para varios casos de uso.
Administración de cambios: Realiza un seguimiento y administra los cambios de metadatos de manera eficaz.
Evolución del esquema: Supervisa y planifica las modificaciones del esquema.

Knowledge Catalog recupera automáticamente los siguientes metadatos de clústeres, instancias, bases de datos, tablas, columnas y vistas de AlloyDB:

Nombre
Ubicación (región)
Etiquetas (para clústeres e instancias)
Integración de Dataplex habilitada (para clústeres)
Versión de la base de datos
Recuento de CPU de la máquina (para instancias)
Tipo de disponibilidad (para instancias)
Charset (para bases de datos)
Intercalación (para bases de datos)
Propietario
Descripción (para tablas, vistas, columnas y claves externas)
Tipo (para clústeres, instancias y máquinas)
Columnas
- Tipo de datos
- Modo
Clave primaria
Claves externas
- Tabla referenciada
- Asignaciones de columnas
Fecha/hora de creación
Hora de la última modificación

Tipos de detección de metadatos

El descubrimiento de metadatos de Knowledge Catalog es un proceso automatizado que analiza las fuentes de datos conectadas, como AlloyDB, para identificar activos de datos, como tablas, vistas y bases de datos. Luego, Knowledge Catalog extrae metadatos técnicos de los recursos, como esquemas, descripciones y ubicaciones, y los incorpora a Knowledge Catalog.

Este proceso sincroniza los metadatos casi en tiempo real, lo que mantiene el catálogo sincronizado con los sistemas de origen. En el caso de AlloyDB, los metadatos del clúster y la instancia se detectan de forma predeterminada. El descubrimiento de metadatos de bases de datos, esquemas, tablas y vistas está habilitado de forma predeterminada en los clústeres nuevos. En el caso de los clústeres creados antes de que se implementara este valor predeterminado (26 de febrero de 2026), habilita la integración de forma manual.

Búsqueda por palabras clave y lenguaje natural

Knowledge Catalog admite búsquedas por palabras clave y en lenguaje natural.

La búsqueda por palabras clave te ayuda a encontrar recursos con palabras clave, filtros y una sintaxis definida. Por ejemplo, para ver todas las bases de datos de AlloyDB, ingresa system=AlloyDB AND type=Database.
La búsqueda en lenguaje natural (versión preliminar) usa IA para comprender las consultas semánticas. Te ayuda a encontrar recursos con lenguaje cotidiano, lo que elimina la necesidad de usar sintaxis complejas. Por ejemplo, ingresa una búsqueda como List all AlloyDB tables related to sales.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Ejemplo: Descubre un esquema de base de datos de AlloyDB

Para comprender el proceso de descubrimiento de metadatos, considera el ejemplo de un clúster de AlloyDB llamado user-data-cluster con la integración de Knowledge Catalog habilitada. Dentro de la instancia principal de este clúster, existe una base de datos llamada profiles, que contiene una tabla customers (id, email, signup_date) y una vista active_users (id, email).

Dado que AlloyDB se sincroniza casi en tiempo real con Knowledge Catalog, los siguientes recursos están disponibles:

Clústeres
Columnas
Bases de datos
Instancias
Tablas
Vistas

Una vez que se complete el descubrimiento, busca estos recursos (la tabla customers y active_users) en la página Knowledge Catalog de la consola de Google Cloud o con la API. Luego, consulta sus esquemas y enriquécelos con metadatos operativos o comerciales adicionales.

Enriquece los metadatos con aspectos

Los tipos de aspecto son recursos reutilizables que sirven como plantillas para los aspectos. Los tipos de aspectos ayudan a evitar la duplicación de trabajo y la creación de aspectos incompletos. Crea los tipos de aspectos necesarios con Knowledge Catalog.

Después de crear tipos de aspectos personalizados, adjunta aspectos a tus recursos de AlloyDB. Adjuntar aspectos a los activos de AlloyDB te permite hacer lo siguiente:

Agregar metadatos empresariales a los activos.
Busca activos por metadatos empresariales y otros metadatos personalizados.

Para obtener más información sobre cómo crear tipos de aspectos y adjuntar aspectos a AlloyDB, consulta Administra aspectos y enriquece los metadatos.

Flujo de trabajo de detección de metadatos

De forma predeterminada, los recursos de clúster y de instancia se transfieren y se pueden detectar. Para transferir y descubrir recursos de bases de datos, esquemas, tablas y vistas, sigue estos pasos:

Habilita la integración de Knowledge Catalog para tu clúster de AlloyDB con la API de AlloyDB si aún no está habilitada. Esto es obligatorio para los clústeres creados antes del 26 de febrero de 2026.
Busca tus recursos de AlloyDB en la página de búsqueda de Knowledge Catalog en la consola de Google Cloud . Para obtener más información, consulta Cómo buscar recursos en Knowledge Catalog.
Para agregar más contexto a tus recursos de AlloyDB, adjunta aspectos a tus recursos. Los aspectos son entradas de metadatos personalizadas que ayudan con el análisis y la administración de datos. Por ejemplo, usa un aspecto para etiquetar una columna que contiene información de identificación personal (PII). Para obtener más información, consulta Administra aspectos y enriquece metadatos.
Navega por tus recursos de AlloyDB siguiendo esta jerarquía: Clúster > Base de datos > Esquema > Tabla o vista > Columna. Esta jerarquía proporciona una vista detallada de tu panorama de datos. Para obtener más información, consulta Cómo buscar recursos en Knowledge Catalog.

Antes de comenzar

Accede a tu cuenta de Google Cloud . Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Habilita la API de Dataplex para el proyecto.

Habilitar la API de Dataplex
Comprueba los permisos.

Debes tener roles y permisos específicos de Identity and Access Management (IAM) para buscar y adjuntar entradas a los recursos de AlloyDB. Para obtener más información, consulta Roles y permisos de IAM obligatorios para Knowledge Catalog.

Roles de IAM obligatorios

En esta sección, se describen los roles y permisos necesarios para buscar recursos y acceder a los resultados de la búsqueda.

Roles requeridos para acceder a los resultados de la búsqueda

Para buscar y ver metadatos de AlloyDB en Knowledge Catalog, las entidades principales deben tener permisos para ver recursos de AlloyDB, incluido el permiso dataplex.projects.search.

Para otorgar estos permisos a los principales, como usuarios, grupos o cuentas de servicio, asígnales el rol de IAM de visualizador de AlloyDB (roles/alloydb.viewer) en el proyecto que contiene los recursos de AlloyDB.

Operación de Knowledge Catalog	Recurso de AlloyDB	Roles o permisos requeridos
Busca recursos de AlloyDB	Clúster	`alloydb.clusters.get`
	Columnas	`alloydb.databases.get`
	Instancia	`alloydb.instances.get`
	Base de datos	`alloydb.databases.get`
	Tablas	`alloydb.databases.get`
	Vistas	`alloydb.databases.get`

Si no quieres usar el rol predefinido AlloyDB Viewer, asigna un rol personalizado que incluya los permisos alloydb.clusters.get, alloydb.instances.get y alloydb.databases.get.

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso. Para obtener más información sobre los roles de IAM de AlloyDB, consulta Roles y permisos de IAM para AlloyDB.

Roles requeridos para buscar entradas

Debes tener al menos uno de los siguientes roles de IAM en el proyecto que se usa para la búsqueda:

Administrador de Catálogo de Dataplex (roles/dataplex.catalogAdmin)
Editor del catálogo de Dataplex (roles/dataplex.catalogEditor)
Visualizador del catálogo de Dataplex (roles/dataplex.catalogViewer)

Los permisos en los resultados de la búsqueda se verifican independientemente del proyecto seleccionado. Para obtener más información, consulta Busca recursos de datos con Knowledge Catalog.

Actualidad de los datos de integración de Knowledge Catalog

De forma predeterminada, Knowledge Catalog ingiere y descubre recursos de clústeres y de instancias, y la actualización de sus metadatos es casi en tiempo real.

La integración de Knowledge Catalog para los recursos de bases de datos, esquemas, tablas y vistas está habilitada de forma predeterminada cuando creas un clúster nuevo de AlloyDB. Para evitar que se sincronicen estos metadatos, inhabilita la integración.

Habilitar la integración activa la exportación de metadatos de AlloyDB, como bases de datos, esquemas y tablas, a buckets de Cloud Storage para la sincronización periódica o a temas de Pub/Sub para la sincronización casi en tiempo real, lo que los pone a disposición de Knowledge Catalog. Esta función solo se aplica a los clústeres principales. Los clústeres secundarios que se usan para la replicación entre regiones no admiten la integración de Knowledge Catalog para los metadatos de bases de datos, esquemas, tablas y vistas.

La actualización de los metadatos de estos recursos depende de cuándo se creó o restableció el clúster:

Casi en tiempo real: Los clústeres creados o restablecidos a partir del 3 de abril de 2026 sincronizan los metadatos con Knowledge Catalog casi en tiempo real. Las actualizaciones están disponibles en el Catálogo de conocimiento en un plazo de hasta 5 minutos. Por lo general, el proceso de extracción tarda unos segundos.
Cada pocas horas: Los clústeres creados o restablecidos entre el 26 de febrero y el 3 de abril de 2026 actualizan los metadatos en Knowledge Catalog cada pocas horas. Las actualizaciones están disponibles en el Catálogo de conocimiento en un plazo de hasta 48 horas. El proceso de extracción suele tardar unos minutos, pero el tiempo de finalización depende del tamaño de la CPU y la cantidad de tablas.

Crea AlloyDB con la integración de Knowledge Catalog inhabilitada

Puedes controlar esta integración cuando creas o actualizas un clúster con Google Cloud CLI o la API de AlloyDB:

gcloud

Usa el comando gcloud alloydb clusters create para crear un clúster de AlloyDB. Si omites la marca --enable-dataplex-integration, la integración de Knowledge Catalog se habilita de forma predeterminada para los metadatos de la base de datos, el esquema, la tabla y la vista. Para ver una lista completa de los parámetros de esta llamada, consulta gcloud alloydb clusters create. Para obtener información sobre la configuración del clúster, consulta Consulta la configuración del clúster y de la instancia.

No incluyas información sensible o de identificación personal en el ID del clúster, ya que este podría ser visible en varios contextos operativos, como registros del sistema, paneles de supervisión y comunicaciones de asistencia. No es necesario que incluyas el ID del proyecto en el nombre del clúster. El sistema incluye automáticamente esta información cuando corresponde, por ejemplo, en los archivos de registro.

Para inhabilitar la integración de Knowledge Catalog en los recursos de bases de datos, esquemas, tablas y vistas, incluye la marca --no-enable-dataplex-integration:

gcloud alloydb clusters create CLUSTER_ID \
    --password=PASSWORD \
    --region=REGION \
    --no-enable-dataplex-integration

Realiza los siguientes reemplazos:

CLUSTER_ID: Es el ID del clúster que creas. El ID del clúster debe comenzar con una letra minúscula y puede contener letras minúsculas, números y guiones.
PASSWORD: Es la contraseña que usas para el usuario postgres predeterminado.
REGION: Es el ID de la región del clúster.

REST

Usa el método POST para crear un clúster de AlloyDB. Si omites dataplexConfig en la solicitud, la integración de Knowledge Catalog se habilita de forma predeterminada para los metadatos de la base de datos, el esquema, la tabla y la vista. Para ver una lista completa de los parámetros de esta llamada, consulta Method: projects.locations.clusters.create. Para obtener información sobre la configuración del clúster, consulta Consulta la configuración del clúster y de la instancia.

Para inhabilitar la integración de Knowledge Catalog en los recursos de bases de datos, esquemas, tablas y vistas, incluye "dataplexConfig": { "enabled": false } en el cuerpo de la solicitud:

{
  "databaseVersion": "DATABASE_VERSION",
  "initialUser": {
    "user": "INITIAL_USERNAME",
    "password": "INITIAL_USER_PASSWORD"
  },
  "labels": {
    "test": "alloydb-cluster-full"
  },
  "dataplexConfig" : {
    "enabled" : false
  }
}

Realiza los siguientes reemplazos:

DATABASE_VERSION: Cadena de enumeración de la versión de la base de datos, por ejemplo, POSTGRES_16.
INITIAL_USERNAME: Es el nombre de usuario que usas para el usuario postgres predeterminado.
INITIAL_USER_PASSWORD: Es la contraseña que usas para el usuario postgres predeterminado.

Usa el siguiente método y URL de HTTP:

POST https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID

Realiza los siguientes reemplazos:

PROJECT_ID: El ID o el número del proyecto del proyecto Google Cloud que contiene el clúster.
LOCATION_ID: Es el ID de la región del clúster.
CLUSTER_ID: Es el ID del clúster que creas. El ID del clúster debe comenzar con una letra minúscula y puede contener letras minúsculas, números y guiones.

Para enviar tu solicitud, usa una de las siguientes opciones:

curl (Linux, macOS o Cloud Shell)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"

PowerShell (Windows)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"| Select-Object -Expand Content

Recibirás una respuesta JSON similar a la siguiente:

Respuesta

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Habilita la integración de Knowledge Catalog para tu clúster de AlloyDB

Para habilitar la integración de Knowledge Catalog en un clúster existente, usa uno de los siguientes procedimientos:

gcloud

Para habilitar la integración de Knowledge Catalog en un clúster existente, usa el comando gcloud alloydb clusters update con la marca --enable-dataplex-integration.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --enable-dataplex-integration

Realiza los siguientes reemplazos:

CLUSTER_ID: el nombre del clúster
REGION: Es el ID de la región del clúster.

REST

Para actualizar campos específicos de un clúster existente, usa el método PATCH en projects.locations.clusters resource.

Usa el siguiente método y URL de HTTP:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Realiza los siguientes reemplazos:

PROJECT_ID: El ID o el número del proyecto del proyecto Google Cloud que contiene el clúster.
LOCATION_ID: Es el ID de la región del clúster.
CLUSTER_ID: el nombre del clúster

Cuerpo JSON de la solicitud:

{
  "dataplexConfig": {
    "enabled": true
  }
}

Para enviar tu solicitud, usa una de las siguientes opciones:

curl (Linux, macOS o Cloud Shell)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

    curl -X PATCH \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell (Windows)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Recibirás una respuesta JSON similar a la siguiente:

Respuesta

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Verifica la integración de Knowledge Catalog en tu clúster de AlloyDB

Para verificar que la integración de Knowledge Catalog esté habilitada en un clúster existente, usa uno de los siguientes procedimientos:

gcloud

Para verificar que la integración de Knowledge Catalog esté habilitada en un clúster existente, usa el comando gcloud alloydb clusters describe.

gcloud alloydb clusters describe CLUSTER_ID --region=REGION

Realiza los siguientes reemplazos:

CLUSTER_ID: Es el ID del clúster.
REGION: Es el ID de la región del clúster.

El resultado incluye la sección dataplexConfig en formato YAML. Si enabled es true, la integración de Knowledge Catalog está habilitada:

dataplexConfig:
  enabled: true

REST

Para verificar que la integración de Knowledge Catalog esté habilitada en un clúster existente, usa el método GET.

Usa el siguiente método y URL de HTTP:

GET https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID

Realiza los siguientes reemplazos:

PROJECT_ID: El ID o el número del proyecto del proyecto Google Cloud que contiene el clúster.
LOCATION_ID: Es el ID de la región del clúster.
CLUSTER_ID: Es el ID del clúster.

Para enviar tu solicitud, usa una de las siguientes opciones:

curl (Linux, macOS o Cloud Shell)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"

PowerShell (Windows)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"| Select-Object -Expand Content

Recibirás una respuesta JSON para todo el Cluster proto, que incluye el mensaje dataplexConfig:

{
  "dataplexConfig": {
    "enabled": true
  }
}

Desactiva la integración de Knowledge Catalog en tu clúster de AlloyDB

Cuando inhabilitas la integración de Knowledge Catalog en tu clúster de AlloyDB, solo están disponibles los metadatos del clúster y la instancia.

gcloud

Usa el comando gcloud alloydb clusters update con la marca --no-enable-dataplex-integration para desactivar la integración.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --no-enable-dataplex-integration

Realiza los siguientes reemplazos:

CLUSTER_ID: Es el ID del clúster.
REGION: Es el ID de la región del clúster.

REST

Usa el siguiente ejemplo para desactivar la integración.

Usa el siguiente método y URL de HTTP:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Realiza los siguientes reemplazos:

PROJECT_ID: El ID o el número del proyecto del proyecto Google Cloud que contiene el clúster.
LOCATION_ID: Es el ID de la región del clúster.
CLUSTER_ID: Es el ID del clúster.

Cuerpo JSON de la solicitud:

{
  "dataplexConfig": {
    "enabled": false
  }
}

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell (Windows)

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Recibirás una respuesta JSON similar a la siguiente:

Respuesta

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Enriquece recursos de AlloyDB con aspectos

Los tipos de aspectos son recursos reutilizables que sirven como plantillas para aspectos. Los tipos de aspectos ayudan a evitar la duplicación de trabajo y la creación de aspectos incompletos. Crea los tipos de aspectos necesarios con Knowledge Catalog.

Después de crear tipos de aspectos personalizados, puedes adjuntar aspectos a tus recursos de AlloyDB. Adjuntar aspectos a los recursos de AlloyDB proporciona las siguientes capacidades:

Agregar metadatos empresariales a los recursos
Buscar recursos por metadatos empresariales y otros metadatos personalizados

Para obtener más información sobre cómo crear tipos de aspectos y adjuntar aspectos a AlloyDB, consulta Administra aspectos y enriquece los metadatos.

Busca recursos de AlloyDB

Usa la página de búsqueda de Knowledge Catalog en la consola de Google Cloud para buscar recursos de AlloyDB.

Ve a la página Búsqueda de Knowledge Catalog.

Ir a Búsqueda
En Elige una plataforma de búsqueda, selecciona Knowledge Catalog.
En el panel Filtros, haz clic en Sistemas y, luego, selecciona AlloyDB.
Es opcional. En Alias de tipo, filtra los resultados de la búsqueda a un tipo específico de recurso de AlloyDB seleccionando uno o más de los siguientes alias de tipo:
- Base de datos
- Esquema de la base de datos
- Clúster
- Instancia
- Servicio
- Tabla
- Ver
Nota: Service es un alias de tipo para una instancia de AlloyDB.

Usa consultas para realizar búsquedas de palabras clave

Usa el campo de búsqueda en Knowledge Catalog para realizar búsquedas por palabras clave. Por ejemplo, ingresa system=AlloyDB AND type=Database para ver todas las bases de datos de AlloyDB.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Para ver todos los recursos de AlloyDB, ingresa system=AlloyDB.

Luego, ingresa palabras clave específicas. Por ejemplo, para ver todas las bases de datos de AlloyDB, haz lo siguiente:

system=AlloyDB AND type=Database

Para ver todas las tablas de AlloyDB, ingresa la siguiente consulta:

system=AlloyDB AND type=Table

También puedes usar paréntesis y los operadores lógicos AND y OR para expresiones complejas. Para obtener más información sobre las expresiones que puedes usar en el campo de búsqueda, consulta Sintaxis de búsqueda de Knowledge Catalog.

Puedes ingresar búsquedas de forma directa para recursos específicos de AlloyDB en el campo de búsqueda. El formato de la cadena de consulta es el siguiente:

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

Reemplaza lo siguiente:

QUERY_STRING: Usa la siguiente lista para identificar una cadena de consulta según el tipo de recurso de AlloyDB que deseas consultar:
- alloydb-database
- alloydb-cluster
- alloydb-instance
- alloydb-table
- alloydb-schema
- alloydb-view

Una consulta de ejemplo podría tener el siguiente aspecto:

type="projects/1234567890/locations/global/entryTypes/alloydb-cluster"

Busca por tipo de aspecto

Knowledge Catalog incluye algunos tipos de aspectos integrados que te ayudan a realizar búsquedas.

Para buscar por tipo de aspecto, sigue estos pasos:

En el panel Aspectos, haz clic en el menú Agregar más tipos de aspectos.
Es opcional. Selecciona AlloyDB Access para filtrar los resultados por dialecto de AlloyDB.
Selecciona uno o más de los siguientes tipos de aspecto para limitar los resultados de la búsqueda a ese tipo.
- Base de datos de AlloyDB
- Clúster de AlloyDB
- Instancia de AlloyDB
- Vista de AlloyDB
- Esquema de AlloyDB
- Tabla de AlloyDB
Haz clic en Aceptar.
En la tabla de resultados, haz clic en el nombre del activo para ver sus metadatos.
Opcional: Mejora o visualiza tus recursos. Puedes mejorar o visualizar tus recursos de las siguientes maneras:
- Para agregar una descripción de texto enriquecido del activo, haz clic en Agregar en Descripción general.
- Para adjuntar un aspecto al recurso, haz clic en Agregar en Aspectos.
- Para ver las bases de datos de miembros de una instancia, haz clic en la pestaña Lista de entradas y, luego, en Mostrar todas las entradas secundarias en la búsqueda. Si no aparece la pestaña Lista de entrada, el clúster no tiene bases de datos.
- Visualiza todos los detalles del recurso en Información de las entradas. Haz clic en el nombre de la entrada para desglosar las entradas adicionales.

Búsqueda en lenguaje natural en AlloyDB

La búsqueda en lenguaje natural (versión preliminar) usa IA para comprender las consultas semánticas. Te ayuda a encontrar recursos con lenguaje cotidiano, lo que elimina la necesidad de usar sintaxis complejas. Por ejemplo, ingresa consultas como List all AlloyDB tables related to sales.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Búsqueda de sintaxis en AlloyDB

La búsqueda por palabras clave te ayuda a encontrar recursos con palabras clave, filtros y una sintaxis definida. Por ejemplo, ingresa system=AlloyDB AND type=Database para ver todas las bases de datos de AlloyDB.

Para obtener más información, consulta Sintaxis de búsqueda de Knowledge Catalog.

Flujo de trabajo de ejemplo: Desglosar de clúster a columnas

Para explorar en detalle desde el clúster hasta las columnas, sigue estos pasos:

Ve a la página Búsqueda de Knowledge Catalog.

Ir a Búsqueda
Para la opción Elige una plataforma de búsqueda, selecciona Knowledge Catalog.
En el panel Filtros, selecciona Sistemas y, luego, AlloyDB. También puedes ingresar system=AlloyDB en el campo de búsqueda.
Selecciona un nombre de clúster.
En la página Detalles de AlloyDB, haz clic en la pestaña Lista de entradas y, luego, en Mostrar todas las entradas secundarias en la búsqueda. Knowledge Catalog muestra las bases de datos en el clúster.

Nota: Si no aparece la pestaña Lista de entradas, regresa a la página Buscar y elige otro clúster.
En la página Detalles de la base de datos de AlloyDB, haz clic en la pestaña Lista de entradas y, luego, en Ver entradas secundarias en la búsqueda. Knowledge Catalog muestra las tablas del clúster.
Selecciona un nombre de tabla y, luego, en la página Detalles de la tabla de AlloyDB, haz clic en Esquema para ver las columnas de la tabla.
Opcional: Para agregar un tipo de aspecto a una columna, haz clic en el botón Agregar aspecto.

Precios

No se aplican cargos por almacenar metadatos técnicos de AlloyDB en Knowledge Catalog. Se aplican los precios estándar de Knowledge Catalog para las llamadas a la API y el enriquecimiento adicional de metadatos empresariales. Para obtener más información, consulta la página de precios del Catálogo de conocimiento.

Uso de recursos

Knowledge Catalog extrae metadatos de tus clústeres de AlloyDB de forma periódica. Este proceso de extracción consume recursos de CPU en tu clúster. Por lo general, el uso de la CPU es mínimo. Por ejemplo, los clústeres con tipos de máquinas más pequeños (como n2-highmem-2-icelake) que administran esquemas grandes (como los que tienen 100,000 tablas o más) pueden experimentar un aumento en el uso de la CPU de hasta un 5% durante la extracción.

Limitaciones

La integración admite un máximo de un millón de tablas por base de datos y un promedio de 150 columnas por tabla. Si se supera alguno de estos límites, no se extraerán los metadatos de los recursos, como bases de datos, esquemas, tablas y vistas. En Knowledge Catalog, solo están disponibles los metadatos de clústeres e instancias.
Cuando se crea un clúster por primera vez, la sincronización inicial de todos los metadatos con Knowledge Catalog puede tardar hasta 48 horas. Después de la sincronización inicial, las actualizaciones posteriores están disponibles casi en tiempo real.
En caso de que se produzca una alta tasa de cambios de metadatos (más de 100 cambios de DDL por segundo) en tu base de datos, la sincronización de metadatos casi en tiempo real con Knowledge Catalog podría pausarse hasta por 30 minutos antes de reanudarse.
En el caso de que se pierda alguna actualización debido a la alta tasa de cambios de metadatos, problemas de red o cuando se interrumpe el proceso de sincronización, eventualmente se harán visibles en el Catálogo de conocimiento en un plazo de 48 horas.
Cuando una instancia no existe o no se está ejecutando, la eliminación de los metadatos puede tardar 7 días.
Cuando se cambia el nombre de una base de datos, solo la actualización de la base de datos está disponible en Knowledge Catalog casi en tiempo real. La asignación subyacente de la base de datos y todas las tablas correspondientes se actualizarán en Knowledge Catalog en un plazo de 48 horas.

Administra tus recursos de AlloyDB con Knowledge Catalog Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Tipos de detección de metadatos

Búsqueda por palabras clave y lenguaje natural

Ejemplo: Descubre un esquema de base de datos de AlloyDB

Enriquece los metadatos con aspectos

Flujo de trabajo de detección de metadatos

Antes de comenzar

Roles de IAM obligatorios

Roles requeridos para acceder a los resultados de la búsqueda

Roles requeridos para buscar entradas

Actualidad de los datos de integración de Knowledge Catalog

Crea AlloyDB con la integración de Knowledge Catalog inhabilitada

gcloud

REST

curl (Linux, macOS o Cloud Shell)

PowerShell (Windows)

Respuesta

Habilita la integración de Knowledge Catalog para tu clúster de AlloyDB

gcloud

REST

curl (Linux, macOS o Cloud Shell)

PowerShell (Windows)

Respuesta

Verifica la integración de Knowledge Catalog en tu clúster de AlloyDB

gcloud

REST

curl (Linux, macOS o Cloud Shell)

PowerShell (Windows)

Desactiva la integración de Knowledge Catalog en tu clúster de AlloyDB

gcloud

REST

curl (Linux, macOS o Cloud Shell)

PowerShell (Windows)

Respuesta

Enriquece recursos de AlloyDB con aspectos

Busca recursos de AlloyDB

Usa consultas para realizar búsquedas de palabras clave

Busca por tipo de aspecto

Búsqueda en lenguaje natural en AlloyDB

Búsqueda de sintaxis en AlloyDB

Flujo de trabajo de ejemplo: Desglosar de clúster a columnas

Precios

Uso de recursos

Limitaciones

¿Qué sigue?

Administra tus recursos de AlloyDB con Knowledge Catalog