Gestionar aspectos y enriquecer metadatos

En este documento se describe cómo crear y gestionar tipos de aspectos, así como cómo anotar entradas con aspectos.

Dataplex Universal Catalog describe las entradas mediante un conjunto de aspectos. Puedes describir tus entradas con metadatos adicionales mediante aspectos y tipos de aspectos.

Para obtener más información, consulta el artículo Acerca de la gestión de metadatos en Dataplex Universal Catalog.

Aspectos

Los aspectos te permiten capturar metadatos en las entradas. Añadir aspectos a una entrada ayuda a proporcionar contexto significativo a cualquier persona que necesite usar el recurso. Puede usar aspectos para almacenar metadatos empresariales (por ejemplo, la clasificación de datos) y metadatos técnicos (por ejemplo, el esquema).

Los aspectos se consideran partes del recurso de entrada y no recursos independientes. Cuando modificas un aspecto, se modifica la entrada que lo contiene.

Puedes especificar aspectos a nivel de entrada para describir una entrada o a nivel de columna para describir una columna de 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.

En una entrada determinada, solo puede haber un aspecto asociado a la entrada por tipo de aspecto. Puedes tener varios aspectos asociados a las columnas de entrada por tipo de aspecto.

Categorías de aspectos

Los aspectos se clasifican de la siguiente manera:

  • Aspectos obligatorios: aspectos que son obligatorios al crear una entrada. Estos aspectos se definen mediante el tipo de entrada de una entrada determinada. Todas las entradas de un tipo de entrada deben tener siempre todos los aspectos obligatorios definidos por ese tipo de entrada.

    Dataplex Universal Catalog gestiona los aspectos necesarios (por ejemplo, el esquema) de las entradas del sistema.

    Ten en cuenta lo siguiente:

    • Solo puedes asociar aspectos obligatorios a entradas, no a las columnas de una entrada.

    • No puedes eliminar los aspectos obligatorios de una entrada.

    • Puedes leer los aspectos necesarios de las entradas del sistema, pero no modificarlos.

  • Aspectos opcionales: puedes asociar aspectos opcionales a entradas o a columnas de entrada. Puedes rellenar los aspectos opcionales en el momento de crear la entrada o más adelante actualizándola.

    Puedes eliminar aspectos opcionales después de que se hayan rellenado.

Tipos de aspecto

Los tipos de aspectos 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: tipos de aspectos que creas en Dataplex Universal Catalog.

  • Tipos de aspectos del sistema: tipos de aspectos que proporciona, usa y gestiona Dataplex Universal Catalog.

    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 el catálogo universal de Dataplex 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 Puede 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 gestiona estos tipos de aspectos.
    Puedes leer aspectos de estos tipos, pero no puedes crear ni editar aspectos de estos tipos.     		Entre las que se incluyen las 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 aspecto personalizados pueden ser globales o regionales. Puedes crear tipos de aspectos personalizados en una ubicación regional específica o como recurso global.

Los tipos de aspectos globales se usan para crear aspectos de entradas de 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 de las entradas de la misma región.

La ubicación de un tipo de aspecto influye en el ámbito de su aplicabilidad. Para obtener más información, consulta Restricciones de proyectos y ubicaciones.

Los tipos de aspectos del sistema siempre son globales. Los tipos de aspectos del sistema se almacenan en un proyecto gestionado por Google con el ID de proyecto 655216118709. Por ejemplo, projects/655216118709/locations/global/aspectTypes/schema.

Antes de empezar

Antes de crear y gestionar tipos de aspectos y aspectos, completa las tareas que se describen en esta sección.

Roles obligatorios

Para obtener los permisos que necesitas para crear y gestionar tipos y aspectos, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en el recurso:

Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Para obtener más información, consulta los roles de gestión de identidades y accesos de Dataplex Universal Catalog.

Activar la API

Habilita la API de Dataplex en tu proyecto de Dataplex Universal Catalog.

Activar la API

Crear un tipo de aspecto

Consola

  1. En la Google Cloud consola, ve a la página Catálogo de Dataplex Universal Catalog.

    Ir a Catálogo

  2. Haga clic en la pestaña Tipos de aspecto y plantillas de etiquetas > Personalizado.

  3. Haz clic en Crear tipo de aspecto.

  4. En la ventana Crear tipo de aspecto, introduzca lo siguiente:

    1. Opcional: En el campo Nombre visible, introduce un nombre para el tipo de aspecto.
    2. En el campo ID de tipo de aspecto, introduce un ID único para el tipo de aspecto.
    3. Opcional: En el campo Descripción, escribe una descripción del tipo de aspecto.
    4. 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.

  5. Opcional: Define una plantilla para tu tipo de aspecto.

    En la sección Plantilla, haz clic en Añadir campo. En la sección Nuevo campo, introduce lo siguiente:

    1. En el campo Nombre, introduce un nombre.
    2. Opcional: En el campo Nombre visible, introduce un nombre visible.
    3. Opcional: En el campo Descripción, escribe una descripción.

    4. En el campo Tipo, selecciona un tipo de datos para el campo. En función de lo que hayas seleccionado, se mostrarán los siguientes campos y opciones:

      • Si has seleccionado Texto como tipo de datos, sigue estos pasos:

        1. En el campo Tipo de texto, selecciona el tipo de texto.
        2. En el campo Valores de texto, proporciona una pista para el campo de texto. Para ello, haz clic en Añadir valor e introduce la pista. Puedes añadir varias sugerencias para un campo de texto.
        3. Haz clic en Listo.

      • Si has seleccionado Enum como tipo de datos, añade un valor de enumeración:

        1. Haz clic en Añadir un valor de enumeración.
        2. En el campo Valor, introduce un valor de enumeración. Puedes añadir varios valores de enumeración.
        3. Haz clic en Listo.

      • Si has seleccionado Matriz como tipo de datos, en la sección Elemento de matriz, define los tipos de elementos que se incluirán en la matriz:

        1. Haz clic en Añadir elemento de la matriz.
        2. En el campo Nombre, introduce un nombre para los elementos de la matriz.
        3. Opcional: En el campo Nombre visible, introduce un nombre visible para los elementos de la matriz.
        4. Opcional: En el campo Descripción, introduce una descripción de los elementos de la matriz.

        5. En el campo Tipo, seleccione un tipo de datos para los elementos de la matriz.

          En función de lo que elijas, se mostrarán los siguientes campos y opciones. Son similares a las opciones descritas para los tipos de datos Texto, Enum, Mapa, Matriz y Registro en otras partes de esta sección.

        6. Haz clic en Listo.

      • Si has seleccionado Mapa como tipo de datos, en la sección Valor del mapa, define los tipos de valores que se mostrarán en el mapa:

        1. Haz clic en Añadir valor de asignación.
        2. En el campo Nombre, introduce un nombre para el mapa.
        3. Opcional: En el campo Nombre visible, introduce un nombre visible para el mapa.
        4. Opcional: En el campo Descripción, escribe una descripción del mapa.

        5. En el campo Tipo, selecciona un tipo de datos para el mapa.

          En función de lo que elijas, se mostrarán los siguientes campos y opciones. Son similares a las opciones descritas para los tipos de datos Texto, Enum, Mapa, Matriz y Registro en otras partes de esta sección.

        6. Haz clic en Listo.

      • Si has seleccionado Registro como tipo de datos, introduce lo siguiente:

        1. En el campo ID de registro, introduce 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.
        2. Opcional: Si quieres añadir una referencia a otro registro de 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.

        3. En la sección Campos de registro, puedes definir un objeto complejo con varios campos anidados. Para ello, haz clic en Añadir elemento de campo de registro y especifica lo siguiente:

        4. En el campo Nombre, introduce el nombre del campo de registro.

        5. Opcional: En el campo Nombre visible, introduce un nombre visible para el campo de registro.

        6. Opcional: En el campo Descripción, escriba una descripción del campo de registro.

        7. En el campo Tipo, selecciona un tipo de datos.

          En función de lo que elijas, se mostrará el siguiente conjunto de campos y opciones. Son similares a las opciones descritas para los tipos de datos Texto, Enum, Mapa, Matriz y Registro que se han explicado anteriormente en esta sección.

        8. Haz clic en Listo.

    5. Para que el campo sea obligatorio en 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.

    6. Haz clic en Listo.

    7. Para añadir varios campos, haz clic en Añadir campo y repite los pasos anteriores.

  6. Opcional: En la sección Etiquetas, añade etiquetas arbitrarias como pares clave-valor a los recursos:

    1. Haz clic en Añadir etiqueta.
    2. En el campo Clave, introduce una clave.
    3. En el campo Valor, introduce un valor para la clave.
    4. Para añadir más etiquetas, haz clic en Añadir etiqueta y repite los pasos.

  7. 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.

Una vez que hayas creado un tipo de aspecto, podrás añadir aspectos a las entradas.

Ejemplo de uso de los campos ID de registro y Referencia de registro

Puede usar los campos ID de registro y Referencia de registro para referencias recursivas. En el siguiente ejemplo se muestra cómo usar estos campos:

Imagina un tipo de aspecto llamado Employee con los siguientes campos:

  • Nombre (tipo:Text)
  • Fecha de inicio (tipo:Date & time)
  • Designation (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 duplicados, puedes definir los valores ID de registro y Referencia de registro al definir estos campos.

Cuando definas el campo Dirección actual, puedes especificar ID de registro como address-field. En Domicilio permanente, puede especificar el mismo valor (address-field) que en Referencia del registro. Por ejemplo:

  • Nombre (tipo:Text)
  • Fecha de inicio (tipo:Date & time)
  • Designation (tipo:Text)
  • Dirección actual (tipo:Record, ID de registro:address-field)
  • Dirección permanente (tipo:Record, referencia de registro:address-field)

De esta forma, no tendrás que duplicar los campos de otra dirección.

Añadir aspectos a una entrada

Una vez que hayas creado un tipo de aspecto, podrás crear aspectos de ese tipo. Para añadir aspectos a una entrada, debes actualizarla, ya que los aspectos se almacenan en las entradas.

Ten en cuenta lo siguiente:

  • Puedes añadir aspectos a una entrada o a las columnas de una entrada.
  • Solo puedes editar los aspectos necesarios de las entradas personalizadas. No puedes eliminar los aspectos obligatorios.
  • Puedes editar y eliminar los aspectos opcionales tanto de las entradas personalizadas como de las del sistema.

Consola

  1. En la Google Cloud consola, ve a la página Búsqueda de Dataplex Universal Catalog.

    Ir a la búsqueda

  2. En Elegir plataforma de búsqueda, selecciona Dataplex Universal Catalog como modo de búsqueda.

  3. Busca la entrada a la que quieras añadir aspectos y haz clic en ella. Se abrirá la página de detalles de la entrada.

  4. Para añadir aspectos a la entrada, sigue estos pasos:

    1. Haga clic en la pestaña Detalles.
    2. Para añadir aspectos obligatorios u opcionales a la entrada, en la sección Etiquetas y aspectos, haz clic en Añadir en la categoría correspondiente.
      No puedes añadir aspectos obligatorios si el tipo de entrada de la entrada seleccionada no tiene aspectos obligatorios definidos.
    3. Busca y selecciona el aspecto que quieras añadir.
    4. En la ventana Añadir aspecto, introduce los valores de los campos.
    5. Haz clic en Guardar.

  5. Para añadir aspectos a una columna de la entrada, sigue estos pasos:

    1. En la página de detalles de la entrada, haga clic en la pestaña Esquema.
    2. Selecciona las columnas a las que quieras añadir aspectos.
    3. Haz clic en Añadir aspecto.
    4. Busca y selecciona el aspecto que quieras añadir.
    5. En la ventana Añadir aspecto, introduce los valores de los campos.
    6. Haz clic en Guardar.

gcloud

Para añadir aspectos a una entrada o a una columna de una entrada, usa el comando gcloud dataplex entries update.

REST

Para añadir aspectos a una entrada o a una columna de una entrada, utiliza el método entry.patch.

No se pueden crear ni usar aspectos en una entrada en la que el tipo de aspecto y la entrada estén en organizaciones Google Cloud diferentes.

Gestionar los aspectos de una entrada

En esta sección se describe cómo actualizar y eliminar los aspectos de una entrada.

Actualizar un aspecto

Puedes editar los aspectos opcionales tanto de las entradas personalizadas como de las del sistema. Solo puedes editar los aspectos necesarios de las entradas personalizadas.

Consola

  1. En la Google Cloud consola, ve a la página Búsqueda de Dataplex Universal Catalog.

    Ir a la búsqueda

  2. En Elegir plataforma de búsqueda, selecciona Dataplex Universal Catalog como modo de búsqueda.

  3. Busca la entrada cuyos aspectos quieras actualizar y haz clic en ella.

    Se abrirá la página de detalles de la entrada.

  4. Haga clic en la pestaña Detalles.

  5. En la sección Etiquetas y aspectos, despliega el aspecto o la etiqueta que quieras actualizar y haz clic en Editar.

  6. En la ventana Editar aspecto, actualiza los campos obligatorios.

  7. Haz clic en Guardar.

gcloud

Para actualizar aspectos de una entrada o de una columna de una entrada, usa el comando gcloud dataplex entries update.

REST

Para actualizar los aspectos de una entrada o una columna de una entrada, usa el método entry.update.

Eliminar un aspecto

Consola

  1. En la Google Cloud consola, ve a la página Búsqueda de Dataplex Universal Catalog.

    Ir a la búsqueda

  2. En Elegir plataforma de búsqueda, selecciona Dataplex Universal Catalog como modo de búsqueda.

  3. Busca la entrada cuyos aspectos quieras eliminar y haz clic en ella.

    Se abrirá la página de detalles de la entrada.

  4. Haga clic en la pestaña Detalles.

  5. En la sección Etiquetas y aspectos, despliega el aspecto o la etiqueta que quieras eliminar y haz clic en Eliminar.

  6. Haz clic en Confirmar.

gcloud

Para eliminar un aspecto de una entrada, usa el comando gcloud dataplex entries update.

REST

Para eliminar un aspecto de una entrada, utiliza el método entry.update.

Gestionar tipos de aspectos

En esta sección se describe cómo ver, actualizar y eliminar tipos de aspectos.

Ver la lista de tipos de aspectos y plantillas de etiquetas disponibles

Consola

  1. En la Google Cloud consola, ve a la página Catálogo de Dataplex Universal Catalog.

    Ir a Catálogo

  2. 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.

  3. Para ver los tipos de aspectos personalizados y las plantillas de etiquetas, haga clic en la pestaña Personalizado. En la pestaña Personalizado, la columna Fuente del catálogo muestra dónde se encuentra el recurso: Dataplex Universal Catalog o Data Catalog.

    Para ver los tipos de aspectos del sistema, haga clic en la pestaña Sistema.

    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.

  4. Opcional: Para ver la lista de tipos de aspectos y plantillas de etiquetas del proyecto seleccionado, haga clic en la pestaña Personalizado y, a continuación, en el interruptor Mostrar de todos los proyectos para desactivarlo.

    El interruptor Mostrar de todos los proyectos está activado de forma predeterminada y la lista incluye recursos de Dataplex Universal Catalog de la organización seleccionada y recursos de Data Catalog de todas las organizaciones a las que puedes acceder.

gcloud

Para ver una lista de 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.

Ver los detalles de un tipo de aspecto o una plantilla de etiqueta

Consola

  1. En la Google Cloud consola, ve a la página Catálogo de Dataplex Universal Catalog.

    Ir a Catálogo

  2. Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.

  3. Para ver los detalles de un tipo de aspecto de Dataplex Universal Catalog, haz clic en él. Se abrirá la página de detalles del tipo de aspecto, donde podrá acceder a información 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, haga 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.

  4. Para ver los detalles de una plantilla de etiqueta de Data Catalog, haga clic en ella. La página de detalles de la plantilla de etiquetas se abre en Data Catalog, donde puede 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.

Actualizar un tipo de aspecto

Puede actualizar el nombre visible, la descripción, los campos de plantilla y las etiquetas de un tipo de aspecto. No puedes eliminar un campo de una plantilla.

No puedes actualizar el ID y la ubicación del tipo de aspecto después de crear el tipo de aspecto.

Consola

  1. En la Google Cloud consola, ve a la página Catálogo de Dataplex Universal Catalog.

    Ir a Catálogo

  2. Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.

  3. Haz clic en el tipo de aspecto que quieras actualizar.

  4. En la página Detalles del tipo de aspecto, haga clic en Editar.

  5. Edita el nombre visible, la descripción, los campos de la plantilla y las etiquetas según sea necesario.

  6. Opcional: Para marcar un campo del tipo de aspecto como obsoleto, sigue estos pasos:

    1. En la sección Plantilla, despliega el campo.
    2. Selecciona Está obsoleto.
    3. En el campo Deprecation reason (Motivo de la obsolescencia), introduce un motivo para obsoletar el campo seleccionado.
    4. Haz clic en Listo.

  7. 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.

Eliminar un tipo de aspecto

Consola

  1. En la Google Cloud consola, ve a la página Catálogo de Dataplex Universal Catalog.

    Ir a Catálogo

  2. Haz clic en la pestaña Tipos de aspecto y plantillas de etiquetas.

  3. Haz clic en el tipo de aspecto que quieras eliminar.

  4. En la página Detalles del tipo de aspecto, haga clic en Eliminar. Confirma la acción cuando se te solicite.

gcloud

Para eliminar un tipo de aspecto, usa el comando gcloud dataplex aspect-types delete.

REST

Para eliminar un tipo de aspecto, usa el método aspectTypes.delete.

Siguientes pasos