Administra aspectos y enriquece los metadatos

En este documento, se describe cómo crear y administrar tipos de aspectos, y cómo anotar entradas con aspectos.

Dataplex Catalog describe las entradas por un conjunto de aspectos. Puedes describir tus entradas con metadatos adicionales mediante el uso de aspectos y tipos de aspecto.

Para obtener más información, consulta Descripción general de Dataplex Catalog.

Aspectos

Los aspectos te permiten capturar metadatos con entradas. Agrega aspectos a una entrada ayuda a proporcionar contexto significativo a cualquiera que necesite usar el recurso. Puedes usar aspectos para almacenar metadatos empresariales (por ejemplo, clasificación de datos) y metadatos técnicos (por ejemplo, schema).

Los aspectos se consideran partes del recurso de entrada y no separados de Google Cloud. Cuando modificas un aspecto, implica modificar la entrada que contiene el aspecto.

Puedes especificar aspectos a nivel básico para describir una entrada o en a nivel de 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 una campaña debes proporcionar valores para esos campos.

Para una entrada determinada, puede haber como máximo un aspecto asociado con la entrada por tipo de aspecto. Puedes tener varios aspectos asociados con columnas de entrada por tipo de aspecto.

Categorías de aspectos

Los aspectos se clasifican en las siguientes categorías:

  • Aspectos obligatorios: Son los aspectos que son obligatorios cuando se crea una entrada. Esos aspectos se definen por el tipo de entrada de una entrada determinada. Todas las entradas pertenecer a un tipo de entrada siempre deben tener todos los aspectos están definidas por ese tipo de entrada.

    Dataplex administra los aspectos necesarios (por ejemplo, el esquema) para las entradas del sistema.

    Ten en cuenta lo siguiente:

    • Puedes asociar los aspectos obligatorios solo con las entradas, 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 columnas de entrada. Puedes propagar los aspectos opcionales en el momento de la creación de la entrada o más adelante actualizándola.

    Puedes borrar los aspectos opcionales después de que se hayan propagado.

Tipos de aspecto

Los tipos de aspecto son recursos reutilizables que proporcionan plantillas para los aspectos.

Categorías de tipos de aspectos

Los tipos de aspecto se clasifican en las siguientes categorías:

  • Tipos de aspectos personalizados: Los tipos de aspectos que creas en Catálogo de Dataplex.

  • Tipos de aspectos del sistema: Los tipos de aspectos que proporciona, usa Dataplex y administra.

    Los tipos de aspectos del sistema se clasifican aún más 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 para cada una de las categorías:

    Categoría del tipo de aspecto del sistema Descripción Tipos de aspectos que proporciona Dataplex
    Tipo de aspecto de sistema reutilizable Puedes usar estos tipos de aspecto para crear o modificar aspectos.
    • generic
    • storage
    Tipo de aspecto del sistema restringido Dataplex administra estos tipos de aspectos.
    Puedes leer los aspectos en estos tipos de aspecto, pero no puedes crear ni editar aspectos en estos tipos de aspecto.
    • bigquery-connection
    • bigquery-dataset
    • bigquery-model
    • bigquery-routine
    • bigquery-table
    • bigquery-view
    • cloudsql-database
    • cloudsql-instance
    • cloudsql-schema
    • cloudsql-table
    • cloudsql-view
    • storage
    • sql-access
    • storage-bucket
    • storage-folder

    Puedes crear tipos de aspectos personalizados en una ubicación regional específica o como recurso global. Los tipos de aspecto del sistema siempre son globales. Es la ubicación de una afecta el alcance de su aplicabilidad. Para obtener más información, consulta Restricciones de proyectos y ubicaciones.

Antes de comenzar

Antes de crear y administrar tipos de aspectos y aspectos, completa las tareas descritas en esta sección.

Roles obligatorios

Para obtener los permisos que necesitas para crear y administrar tipos de aspectos y aspectos, solicita a tu administrador que te otorgue el los siguientes roles de IAM en el recurso:

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 Funciones de IAM de Dataplex.

Habilita la API

Habilita la API de Dataplex en tu proyecto de Dataplex.

Habilitar la API

Crea un tipo de aspecto

Console

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

    Ir a Catálogo

  2. Haz clic en la pestaña Tipos de aspecto > Personalizado.

  3. En la sección Detalles, ingresa lo siguiente:

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

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

    En Plantillas, haz clic en Agregar campo. En la sección Campo nuevo, ingresa lo siguiente:

    1. En el campo Nombre, ingresa un nombre.
    2. Opcional: En el campo Nombre visible (Display name), ingresa un nombre visible.
    3. Opcional: en el campo Descripción, ingresa una descripción.

    4. En el campo Tipo, selecciona un tipo de datos para el campo. Según tu de selección, se muestra el siguiente conjunto de campos y opciones:

      • Si seleccionaste Texto como el tipo de datos, sigue estos pasos:

        1. En el campo Tipo de texto, selecciona el tipo de texto.
        2. En el campo Text values, 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.
        3. Haz clic en Listo.

      • Si seleccionaste Enum como el tipo de datos, agrega un valor de enumeración:

        1. Haz clic en Agregar un valor de enumeración.
        2. En el campo Valor, ingresa un valor de enumeración. Puedes agregar varios valores de enumeración.
        3. Haz clic en Listo.

      • Si seleccionaste Arreglo como el tipo de datos, en el Elemento Arreglo define los tipos de elementos que estarán presentes en el array:

        1. Haz clic en Add array item.
        2. En el campo Nombre, ingresa un nombre para los elementos del array.
        3. Opcional: En el campo Nombre visible, ingresa un nombre visible. para los elementos del array.
        4. Opcional: En el campo Descripción, ingresa una descripción para los elementos del array.

        5. En el campo Type, 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 otra parte de esta sección.

        6. Haz clic en Listo.

      • Si seleccionaste Mapa como el tipo de datos, en la sección Map value, define los tipos de valores que estarán presentes en el mapa:

        1. Haz clic en Agregar valor del mapa.
        2. En el campo Nombre, ingresa un nombre para el mapa.
        3. Opcional: En el campo Nombre visible, ingresa un nombre visible para el mapa.
        4. Opcional: En el campo Descripción, ingresa una descripción. para el mapa.

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

          En función de tu selección, el siguiente conjunto de campos y opciones que se muestran. Son similares a las opciones descritas los tipos de datos Text, Enum, Map, Array y Graba en otra parte de esta sección.

        6. Haz clic en Listo.

      • Si seleccionaste Registro como tipo de datos, ingresa lo siguiente:

        1. En el campo ID de registro, ingresa un ID único de ese otro registro campos pueden 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 deseas agregar 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 el Ejemplo para usar 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 Agregar elemento de campo de registro y especifica lo siguiente:

          1. En el campo Nombre, ingresa un nombre para el campo de registro.
          2. Opcional: En el campo Nombre visible, ingresa un nombre visible. para el campo de registro.
          3. Opcional: En el campo Descripción, ingresa una descripción para el campo de registro.

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

            En función de tu selección, el siguiente conjunto de campos y opciones que se muestran. Son similares a las opciones descritas los tipos de datos Text, Enum, Map, Array y Graba antes en esta sección.

        4. Haz clic en Listo.

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

    6. Haz clic en Listo.

    7. Para agregar varios campos, haz clic en Agregar campo y repite los pasos anteriores.

  5. Opcional: En la sección Etiquetas, agrega etiquetas arbitrarias como pares clave-valor a tus recursos:

    1. Haz clic en Agregar etiqueta.
    2. En el campo Clave, ingresa una clave.
    3. En el campo Valor, ingresa un valor para la clave.
    4. Para agregar más etiquetas, haz clic en Agregar etiqueta y repite los pasos.

  6. Haz clic en Guardar.

Después de crear un tipo de aspecto, puedes agregar aspectos a las entradas.

REST

Para crear un nuevo tipo de aspecto, usa el método aspectType.create.

Ejemplo de cómo usar los campos ID y Referencia del registro

Puedes usar los campos Record ID y Record reference para las operaciones recursivas referencias. 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 Current address y Permanent address son del mismo tipo de datos Record. Para evitar duplicaciones, 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 Record ID 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 actualizar la entrada, como aspectos se almacenan en entradas.

Ten en cuenta lo siguiente:

  • Puedes agregar aspectos a una entrada o a las columnas de una entrada.
  • Puedes editar los aspectos obligatorios solo para las entradas personalizadas. No puedes borrar los aspectos obligatorios.

  • Puedes editar y borrar los aspectos opcionales de las entradas personalizadas y las entradas del sistema.

Console

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

    Ir a Búsqueda

  2. En Elige una plataforma de búsqueda, selecciona Dataplex Catalog como el modo de búsqueda.

  3. Busca la entrada a la que deseas agregar aspectos y haz clic en ella.

    Se abrirá la página de detalles de las entradas.

  4. Para agregar aspectos a una entrada, sigue estos pasos:

    1. En la página de detalles de la entrada, haz clic en la pestaña Detalles.
    2. Para agregar aspectos opcionales o obligatorios a la entrada, haz lo siguiente: en la sección Aspectos, haz clic en Agregar para el campo correspondiente categoría.
      No puedes agregar aspectos obligatorios si el tipo de entrada de la entrada seleccionada no tiene aspectos obligatorios definidos.
    3. Busca y selecciona el aspecto que quieras agregar.
    4. En la ventana Agregar aspecto, ingresa los valores de los campos.
    5. Haz clic en Guardar.

  5. Para agregar aspectos a una columna de una entrada, sigue estos pasos:

    1. En la página de detalles de entrada, haz clic en la pestaña Esquema.
    2. Selecciona las columnas a las que deseas agregar aspectos.
    3. Haz clic en Agregar aspecto.
    4. Busca y selecciona el aspecto que quieres agregar.
    5. En la ventana Agregar aspecto, ingresa los valores de los campos.
    6. Haz clic en Guardar.

REST

Para agregar aspectos a una entrada o a una columna de una entrada, usa el método entry.patch.

Crear y usar aspectos en una entrada donde el tipo de aspecto respectivo y el están en diferentes organizaciones de Google Cloud, no se admite.

Administra los aspectos existentes de una entrada

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

Actualizar un aspecto

Puedes editar los aspectos opcionales de las entradas personalizadas y del sistema. Puedes editar los aspectos obligatorios solo para las entradas personalizadas.

Console

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

    Ir a Búsqueda

  2. En Elegir plataforma de búsqueda, selecciona Catálogo de Dataplex como la modo de búsqueda.

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

    Se abrirá la página de detalles de las entradas.

  4. Haz clic en la pestaña Detalles.

  5. En el aspecto que quieres actualizar, haz clic en Editar.

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

  7. Haz clic en Guardar.

REST

Para actualizar aspectos de una entrada o una columna de una entrada, usa el entry.update .

Cómo borrar un aspecto

Console

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

    Ir a Búsqueda

  2. En Elige una plataforma de búsqueda, selecciona Dataplex Catalog como el modo de búsqueda.

  3. Busca la entrada cuyos aspectos deseas borrar. haz clic en la entrada.

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

  4. Haz clic en la pestaña Detalles.

  5. En el aspecto que quieres borrar, haz clic en Borrar.

  6. Haz clic en Confirmar.

REST

Para borrar un aspecto de una entrada, usa el entry.update .

Administra los tipos de aspectos

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

Consulta la lista de tipos de aspecto disponibles

Console

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

    Ir al catálogo

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

    Puedes acceder a la lista de tipos de aspectos personalizados y del sistema. Para obtener más información, consulta la sección Categorías de tipos de aspectos de este documento.

    En la pestaña Personalizada, los tipos de aspecto con sufijo (Data Catalog) son las plantillas de etiquetas que se migran de Data Catalog.

  3. Para ver la lista de tipos de aspecto de todos los proyectos, haz clic en el Personalizada y, luego, haz clic en el botón de activación Mostrar desde todos los proyectos la posición de encendido.

REST

Para enumerar todos los tipos de aspecto disponibles, usa el aspectTypes.list .

Cómo ver los detalles de un tipo de aspecto

Console

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

    Ir al catálogo

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

  3. Haz clic en el tipo de aspecto.

    Se abrirá la página de detalles del tipo de aspecto. Puedes ver información como el nombre visible, ID de tipo de aspecto, descripción, ID del proyecto, ubicación, etiquetas la fecha de creación y la fecha de la última modificación del tipo de aspecto seleccionado.

  4. Para ver la estructura del tipo de aspecto seleccionado, haz clic en la pestaña Template.

  5. Para ver la lista de 10 entradas relacionadas creadas recientemente, haz clic en la pestaña Sample entries.

  6. Para buscar todas las entradas relacionadas, haz clic en Mostrar todas las entradas relacionadas en la Búsqueda. Este botón aparece solo si hay al menos una entrada relacionada.

REST

Para obtener los detalles de un tipo de aspecto, usa el método aspectTypes.get.

Cómo actualizar un tipo de aspecto

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

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

Console

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

    Ir al catálogo

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

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

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

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

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

    1. En la sección Template, expande el campo.
    2. Selecciona Is obsoleto.
    3. En el campo Motivo de baja, ingresa un motivo para dar de baja el campo seleccionado.
    4. Haz clic en Listo.

  7. Haz clic en Guardar.

REST

Para actualizar un tipo de aspecto existente, usa el método aspectTypes.patch.

Cómo borrar un tipo de aspecto

Console

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

    Ir al catálogo

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

  3. Haz clic en el tipo de aspecto que quieres borrar.

  4. En la página Detalles del tipo de aspecto, haz clic en Borrar. Confirma cuando se te solicite.

REST

Para borrar un tipo de aspecto existente, usa la aspectTypes.delete .

¿Qué sigue?