En este documento, se describe cómo crear y administrar tipos de aspectos, y cómo anotar entradas con aspectos.
Dataplex Universal Catalog describe las entradas con un conjunto de aspectos. Puedes describir tus entradas con metadatos adicionales usando aspectos y tipos de aspectos.
Para obtener más información, consulta Acerca de la administración del catálogo de datos en Dataplex Universal Catalog.
Aspectos
Los aspectos te permiten capturar metadatos con entradas. Agregar aspectos a una entrada ayuda a proporcionar un contexto significativo a cualquier persona que necesite usar el activo. Puedes usar aspectos para almacenar metadatos empresariales (por ejemplo, la clasificación de datos) y metadatos técnicos (por ejemplo, el esquema).
Se considera que los aspectos son partes del recurso de entrada y no recursos separados. Cuando modificas un aspecto, se modifica la entrada que lo contiene.
Puedes especificar aspectos a nivel de la entrada para describir una entrada o a nivel de la columna para describir una columna en una entrada.
Cada aspecto es una instancia de un tipo de aspecto. Un tipo de aspecto define una plantilla para sus aspectos. Cada tipo de aspecto contiene un conjunto de campos. Cuando creas aspectos, debes proporcionar valores para esos campos.
Para una entrada determinada, puede haber como máximo un aspecto asociado a la entrada por tipo de aspecto. Puedes tener varios aspectos asociados con las columnas de entrada por tipo de aspecto.
Categorías de aspectos
Los aspectos se clasifican de la siguiente manera:
Aspectos obligatorios: Son los aspectos que se deben incluir cuando se crea una entrada. El tipo de entrada de una entrada determinada define estos aspectos. Todas las entradas que pertenecen a un tipo de entrada siempre deben tener todos los aspectos obligatorios que define ese tipo de entrada.
Dataplex Universal Catalog administra los aspectos requeridos (por ejemplo, el esquema) para las entradas del sistema.
Ten en cuenta lo siguiente:
Solo puedes asociar aspectos obligatorios con las entradas y no con las columnas de una entrada.
No puedes borrar los aspectos obligatorios de una entrada.
Puedes leer los aspectos obligatorios de las entradas del sistema, pero no puedes modificarlos.
Aspectos opcionales: Puedes asociar aspectos opcionales con entradas o con columnas de entrada. Puedes completar los aspectos opcionales en el momento de la creación de la entrada o más tarde actualizándola.
Puedes borrar aspectos opcionales después de que se hayan completado.
Tipos de aspecto
Los tipos de aspecto son recursos reutilizables que proporcionan plantillas para aspectos.
Categorías de tipos de aspectos
Los tipos de aspectos se clasifican de la siguiente manera:
Tipos de aspectos personalizados: Son los tipos de aspectos que creas en Dataplex Universal Catalog.
Tipos de aspectos del sistema: Son los tipos de aspectos que Dataplex Universal Catalog proporciona, usa y administra.
Los tipos de aspectos del sistema se clasifican en reutilizables y restringidos. En la siguiente tabla, se describen las categorías de tipos de aspectos del sistema y la lista de tipos de aspectos que proporciona Dataplex Universal Catalog para cada una de las categorías:
Categoría del tipo de aspecto del sistema Descripción Tipos de aspectos que proporciona Dataplex Universal Catalog Tipo de aspecto del sistema reutilizable Puedes usar estos tipos de aspectos para crear o modificar aspectos. contacts
data-quality-scorecard
generic
overview
schema
usage
Tipo de aspecto del sistema restringido Dataplex Universal Catalog administra estos tipos de aspectos.
Puedes leer aspectos de estos tipos de aspectos, pero no puedes crear ni editar aspectos de estos tipos de aspectos.Incluidos, sin limitaciones, los siguientes: analytics-hub
aspecttype-aspect
bigquery-dataset
bigquery-table
cloudsql-database
cloudsql-instance
cloudsql-table
entrygroup-aspect
entrytype-aspect
sensitive-data-protection-profile
storage
storage-bucket
storage-folder
Los tipos de aspectos personalizados pueden ser globales o regionales. Puedes crear tipos de aspectos personalizados en una ubicación regional específica o como un recurso global.
Los tipos de aspectos globales se usan para crear aspectos para las entradas en cualquier región. El contenido de los tipos de aspectos globales se replica en todas las regiones. Los tipos de aspectos regionales se usan para crear aspectos para las entradas en la misma región.
La ubicación de un tipo de aspecto afecta el alcance de su aplicabilidad. Para obtener más información, consulta Restricciones de ubicación y proyecto.
Los tipos de aspectos del sistema siempre son globales. Los tipos de aspectos del sistema se almacenan en un proyecto administrado por Google con el ID del proyecto 655216118709
. Por ejemplo, projects/655216118709/locations/global/aspectTypes/schema
Antes de comenzar
Antes de crear y administrar tipos y aspectos, completa las tareas que se describen en esta sección.
Roles obligatorios
Para obtener los permisos que necesitas para crear y administrar tipos de aspectos y aspectos, pídele a tu administrador que te otorgue los siguientes roles de IAM en el recurso:
-
Conjunto completo de permisos sobre los recursos de metadatos en Dataplex Universal Catalog, incluidos los tipos de aspectos:
Administrador de Catálogo de Dataplex (
roles/dataplex.catalogAdmin
) -
Crea y administra recursos de metadatos en Dataplex Universal Catalog, incluidos los tipos de aspectos:
Editor del catálogo de Dataplex (
roles/dataplex.catalogEditor
) -
Conjunto completo de permisos sobre tipos de aspectos personalizados (excepto los permisos para usar tipos de aspectos para crear o editar entradas):
Propietario de Tipos de aspecto de Dataplex (
roles/dataplex.aspectTypeOwner
) -
Ver los tipos de aspectos y las políticas de IAM asociadas a ellos:
Visualizador del catálogo de Dataplex (
roles/dataplex.catalogViewer
) -
Usa tipos de aspectos para crear y modificar entradas con los aspectos correspondientes:
Usuario de tipo de aspecto de Dataplex (
roles/dataplex.aspectTypeUser
) -
Agrega aspectos de algunos de los tipos de aspectos del sistema, como
schema
,overview
ycontacts
: Propietario de entrada de Dataplex (roles/dataplex.entryOwner
)
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 mediante roles personalizados o cualquier otro rol predefinido.
Para obtener más información, consulta Roles de IAM de Dataplex Universal Catalog.
Habilita la API
Habilita la API de Dataplex en tu proyecto de Dataplex Universal Catalog.
Crea un tipo de aspecto
Console
En la consola de Google Cloud , ve a la página Catálogo de Dataplex Universal Catalog.
Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas > Personalizado.
Haz clic en Crear tipo de aspecto (Dataplex Catalog).
En la ventana Create aspect type, ingresa lo siguiente:
- Opcional: En el campo Nombre visible, ingresa un nombre para el tipo de aspecto.
- En el campo ID de tipo de aspecto, ingresa un ID único para el tipo de aspecto.
- Opcional: En el campo Descripción, ingresa una descripción para el tipo de aspecto.
- En el campo Ubicación, selecciona una ubicación para el tipo de aspecto. No puedes modificar la ubicación de un tipo de aspecto después de crearlo.
Opcional: Define una plantilla para tu tipo de aspecto.
En la sección Plantilla, haz clic en Agregar campo. En la sección Campo nuevo, ingresa lo siguiente:
- En el campo Nombre, ingresa un nombre.
- Opcional: En el campo Nombre visible, ingresa un nombre visible.
- Opcional: en el campo Descripción, ingresa una descripción.
En el campo Tipo, selecciona un tipo de datos para el campo. Según tu selección, se mostrará el siguiente conjunto de campos y opciones:
Si seleccionaste Texto como el tipo de datos, sigue estos pasos:
- En el campo Tipo de texto, selecciona el tipo de texto.
- En el campo Valores de texto, proporciona una sugerencia para el campo de texto. Para ello, haz clic en Agregar valor y, luego, ingresa la sugerencia. Puedes agregar varias sugerencias para un campo de texto.
- Haz clic en Listo.
Si seleccionaste Enum como el tipo de datos, agrega un valor de enumeración:
- Haz clic en Agregar un valor de enumeración.
- En el campo Valor, ingresa un valor de enumeración. Puedes agregar varios valores de enumeración.
- Haz clic en Listo.
Si seleccionaste Array como el tipo de datos, en la sección Elemento del array, define los tipos de elementos que estarán presentes en el array:
- Haz clic en Agregar elemento de array.
- En el campo Nombre, ingresa un nombre para los elementos del array.
- Opcional: En el campo Nombre visible, ingresa un nombre visible para los elementos del array.
- Opcional: En el campo Descripción, ingresa una descripción para los elementos del array.
En el campo Tipo, selecciona un tipo de datos para los elementos del array.
Según tu selección, se mostrará el siguiente conjunto de campos y opciones. Son similares a las opciones que se describen para los tipos de datos Text, Enum, Map, Array y Record en otras partes de esta sección.
Haz clic en Listo.
Si seleccionaste Mapa como el tipo de datos, en la sección Valor del mapa, define los tipos de valores que estarán presentes en el mapa:
- Haz clic en Agregar valor de mapa.
- En el campo Nombre, ingresa un nombre para el mapa.
- Opcional: En el campo Nombre visible, ingresa un nombre visible para el mapa.
- Opcional: En el campo Descripción, ingresa una descripción para el mapa.
En el campo Tipo, selecciona un tipo de datos para el mapa.
Según tu selección, se mostrará el siguiente conjunto de campos y opciones. Son similares a las opciones que se describen para los tipos de datos Text, Enum, Map, Array y Record en otras partes de esta sección.
Haz clic en Listo.
Si seleccionaste Registro como el tipo de datos, ingresa lo siguiente:
- En el campo ID de registro, ingresa un ID único que otros campos de registro puedan usar para hacer referencia a este registro. Consulta la sección Ejemplo de uso de los campos ID de registro y Referencia de registro de este documento.
- Opcional: Si deseas agregar una referencia a otro registro desde esta plantilla, usa el campo Referencia de registro. No puedes modificarlo después de crear el tipo de aspecto. Consulta la sección Ejemplo de uso de los campos ID de registro y Referencia de registro de este documento.
En la sección Campos de registro, puedes definir un objeto complejo con varios campos anidados. Para ello, haz clic en Agregar elemento de campo de registro y especifica lo siguiente:
En el campo Nombre, ingresa un nombre para el campo del registro.
Opcional: En el campo Nombre visible, ingresa un nombre visible para el campo de registro.
Opcional: En el campo Descripción, ingresa una descripción para el campo del registro.
En el campo Tipo, selecciona un tipo de datos.
Según tu selección, se mostrará el siguiente conjunto de campos y opciones. Son similares a las opciones descritas para los tipos de datos Text, Enum, Map, Array y Record que se mencionaron anteriormente en esta sección.
Haz clic en Listo.
Para que el campo sea obligatorio para un aspecto de este tipo, selecciona Es obligatorio. Para obtener más información sobre los aspectos obligatorios y opcionales, consulta la sección Categorías de aspectos de este documento.
Haz clic en Listo.
Para agregar varios campos, haz clic en Agregar campo y repite los pasos anteriores.
Opcional: En la sección Etiquetas, agrega etiquetas arbitrarias como pares clave-valor a tus recursos:
- Haz clic en Agregar etiqueta.
- En el campo Clave, ingresa una clave.
- En el campo Valor, ingresa un valor para la clave.
- Para agregar más etiquetas, haz clic en Agregar etiqueta y repite los pasos.
Haz clic en Guardar.
gcloud
Para crear un tipo de aspecto, usa el comando gcloud dataplex aspect-types create
.
REST
Para crear un tipo de aspecto, usa el método aspectType.create
.
Después de crear un tipo de aspecto, puedes agregar aspectos a las entradas.
Ejemplo de uso de los campos ID de registro y Referencia de registro
Puedes usar los campos ID de registro y Referencia de registro para referencias recursivas. En el siguiente ejemplo, se muestra cómo usar estos campos:
Considera un tipo de aspecto llamado Employee
, con los siguientes campos:
- Nombre (tipo:
Text
) - Fecha de inicio (tipo:
Date & time
) - Designación (tipo:
Text
) - Dirección actual (tipo:
Record
) - Dirección permanente (tipo:
Record
)
Los dos campos de dirección Dirección actual y Dirección permanente son del mismo tipo de datos Record
. Para evitar la duplicación, puedes establecer los valores de ID de registro y Referencia de registro cuando definas estos campos.
Cuando defines el campo Dirección actual, puedes especificar ID de registro como address-field
. Para Dirección permanente, puedes especificar el mismo valor (address-field
) para Referencia del registro. Por ejemplo:
- Nombre (tipo:
Text
) - Fecha de inicio (tipo:
Date & time
) - Designación (tipo:
Text
) - Dirección actual (tipo:
Record
, ID de registro:address-field
) - Dirección permanente (tipo:
Record
, referencia del registro:address-field
)
De esta manera, no es necesario que dupliques los campos de otra dirección.
Cómo agregar aspectos a una entrada
Después de crear un tipo de aspecto, puedes crear aspectos de ese tipo. Para agregar aspectos a una entrada, debes actualizarla, ya que los aspectos se almacenan dentro de las entradas.
Ten en cuenta lo siguiente:
- Puedes agregar aspectos a una entrada o a las columnas de una entrada.
- Solo puedes editar los aspectos requeridos para las entradas personalizadas. No puedes borrar los aspectos obligatorios.
- Puedes editar y borrar los aspectos opcionales de las entradas personalizadas y del sistema.
Console
En la consola de Google Cloud , ve a la página Búsqueda de Dataplex Universal Catalog.
En Elige una plataforma de búsqueda, selecciona Dataplex Catalog como el modo de búsqueda.
Busca la entrada a la que deseas agregar aspectos y haz clic en ella. Se abrirá la página de detalles de la entrada.
Para agregar aspectos a la entrada, sigue estos pasos:
- Haz clic en la pestaña Detalles.
- Para agregar aspectos obligatorios u opcionales a la entrada, en la sección Etiquetas y aspectos, haz clic en
No puedes agregar aspectos obligatorios si el tipo de entrada de la entrada seleccionada no tiene aspectos obligatorios definidos.
Agregar para la categoría correspondiente. - Busca y selecciona el aspecto que quieras agregar.
- En la ventana Agregar aspecto, ingresa los valores de los campos.
- Haz clic en Guardar.
Para agregar aspectos a una columna de la entrada, sigue estos pasos:
- En la página de detalles de la entrada, haz clic en la pestaña Esquema.
- Selecciona las columnas a las que deseas agregar aspectos.
- Haz clic en Agregar aspecto.
- Busca y selecciona el aspecto que quieras agregar.
- En la ventana Agregar aspecto, ingresa los valores de los campos.
- Haz clic en Guardar.
gcloud
Para agregar aspectos a una entrada o a una columna de una entrada, usa el comando gcloud dataplex entries update
.
REST
Para agregar aspectos a una entrada o a una columna de una entrada, usa el método entry.patch
.
No se admite la creación ni el uso de aspectos en una entrada en la que el tipo de aspecto respectivo y la entrada se encuentran en diferentes organizaciones de Google Cloud .
Administra los aspectos existentes de una entrada
En esta sección, se describe cómo actualizar y borrar los aspectos existentes de una entrada.
Actualiza un aspecto
Puedes editar los aspectos opcionales de las entradas personalizadas y las del sistema. Solo puedes editar los aspectos requeridos para las entradas personalizadas.
Console
En la consola de Google Cloud , ve a la página Búsqueda de Dataplex Universal Catalog.
En Elige una plataforma de búsqueda, selecciona Dataplex Catalog como el modo de búsqueda.
Busca la entrada cuyos aspectos deseas actualizar y haz clic en ella.
Se abrirá la página de detalles de la entrada.
Haz clic en la pestaña Detalles.
En la sección Etiquetas y aspectos, expande el aspecto o la etiqueta que deseas actualizar y haz clic en
Editar.En la ventana Editar aspecto, actualiza los campos obligatorios.
Haz clic en Guardar.
gcloud
Para actualizar aspectos de una entrada o una columna de una entrada, usa el comando gcloud dataplex entries update
.
REST
Para actualizar aspectos de una entrada o una columna de una entrada, usa el método entry.update
.
Borra un aspecto
Console
En la consola de Google Cloud , ve a la página Búsqueda de Dataplex Universal Catalog.
En Elige una plataforma de búsqueda, selecciona Dataplex Catalog como el modo de búsqueda.
Busca la entrada cuyos aspectos quieres borrar y haz clic en ella.
Se abrirá la página de detalles de la entrada.
Haz clic en la pestaña Detalles.
En la sección Etiquetas y aspectos, expande el aspecto o la etiqueta que deseas borrar y haz clic en
Borrar.Haz clic en Confirmar.
gcloud
Para borrar un aspecto de una entrada, usa el comando gcloud dataplex entries update
.
REST
Para borrar un aspecto de una entrada, usa el método entry.update
.
Administra tipos de aspectos
En esta sección, se describe cómo ver, actualizar y borrar tipos de aspectos.
Consulta la lista de tipos de aspectos y plantillas de etiquetas disponibles
Console
En la consola de Google Cloud , ve a la página Catálogo de Dataplex Universal Catalog.
Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.
En esta página, se enumeran todos los tipos de aspectos de Dataplex Universal Catalog y las plantillas de etiquetas de Data Catalog disponibles.
Para ver los tipos de aspecto y las plantillas de etiquetas personalizados, haz clic en la pestaña Personalizado. En la pestaña Personalizado, la columna Fuente del catálogo muestra dónde reside el recurso: Dataplex Universal Catalog o Data Catalog.
Para ver los tipos de aspectos del sistema, haz clic en la pestaña System.
Para obtener más información sobre los tipos de aspectos personalizados y del sistema, consulta la sección categorías de tipos de aspectos de este documento.
Opcional: Para ver la lista de tipos de aspectos y plantillas de etiquetas en el proyecto seleccionado, haz clic en la pestaña Personalizado y, luego, en el botón de activación Mostrar desde todos los proyectos para desactivarlo.
El botón de activación Mostrar desde todos los proyectos está activado de forma predeterminada, y la lista incluye recursos de Dataplex Universal Catalog de la organización que seleccionaste y recursos de Data Catalog de todas las organizaciones a las que puedes acceder.
gcloud
Para enumerar todos los tipos de aspectos disponibles, usa el comando gcloud dataplex aspect-types list
.
REST
Para enumerar todos los tipos de aspectos disponibles, usa el método aspectTypes.list
.
Cómo ver los detalles de un tipo de aspecto o una plantilla de etiqueta
Console
En la consola de Google Cloud , ve a la página Catálogo de Dataplex Universal Catalog.
Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.
Para ver los detalles de un tipo de aspecto de Dataplex Universal Catalog, haz clic en el tipo de aspecto. Se abrirá la página de detalles del tipo de aspecto, en la que podrás acceder a detalles como el nombre visible, el ID del tipo de aspecto, la descripción, el ID del proyecto, la ubicación, las etiquetas, la fecha de creación y la fecha de la última modificación.
- Para ver la estructura del tipo de aspecto seleccionado, haz clic en la pestaña Plantilla.
- Para ver la lista de las 10 entradas relacionadas creadas recientemente, haz clic en la pestaña Entradas de ejemplo.
- Para buscar todas las entradas relacionadas, haz clic en Mostrar todas las entradas relacionadas en la búsqueda. Este botón solo aparece si hay al menos una entrada relacionada.
Para ver los detalles de una plantilla de etiquetas de Data Catalog, haz clic en ella. Se abrirá la página de detalles de la plantilla de etiqueta en Data Catalog, donde podrás acceder a detalles como el nombre visible, el ID de la plantilla, el ID del proyecto, la ubicación, la visibilidad y las etiquetas.
gcloud
Para obtener los detalles de un tipo de aspecto, usa el comando gcloud dataplex aspect-types describe
.
REST
Para obtener los detalles de un tipo de aspecto, usa el método aspectTypes.get
.
Actualiza un tipo de aspecto
Puedes actualizar el nombre visible, la descripción, los campos de la plantilla y las etiquetas de un tipo de aspecto. No puedes borrar un campo existente en una plantilla.
No puedes actualizar el ID y la ubicación del tipo de aspecto después de crear el tipo de aspecto.
Console
En la consola de Google Cloud , ve a la página Catálogo de Dataplex Universal Catalog.
Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.
Haz clic en el tipo de aspecto que deseas actualizar.
En la página Detalles del tipo de aspecto, haz clic en Editar.
Edita el nombre visible, la descripción, los campos de la plantilla y las etiquetas según sea necesario.
Opcional: Para marcar un campo en el tipo de aspecto como obsoleto, sigue estos pasos:
- En la sección Plantilla, expande el campo.
- Selecciona Is Deprecated.
- En el campo Motivo de la baja, ingresa un motivo para dar de baja el campo seleccionado.
- Haz clic en Listo.
Haz clic en Guardar.
gcloud
Para actualizar un tipo de aspecto, usa el comando gcloud dataplex aspect-types update
.
REST
Para actualizar un tipo de aspecto, usa el método aspectTypes.patch
.
Borra un tipo de aspecto
Console
En la consola de Google Cloud , ve a la página Catálogo de Dataplex Universal Catalog.
Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.
Haz clic en el tipo de aspecto que deseas borrar.
En la página Detalles del tipo de aspecto, haz clic en Borrar. Confirma cuando se te solicite.
gcloud
Para borrar un tipo de aspecto, usa el comando gcloud dataplex aspect-types delete
.
REST
Para borrar un tipo de aspecto existente, usa el método aspectTypes.delete
.
¿Qué sigue?
- Obtén más información para buscar recursos de datos en Dataplex Universal Catalog.
- Obtén más información para administrar entradas y transferir fuentes personalizadas.
- Obtén más información para importar metadatos a Dataplex Universal Catalog.
- Obtén más información sobre la administración de metadatos en Dataplex Universal Catalog.
- Obtén más información para migrar de Data Catalog a Dataplex Universal Catalog.