Administra aspectos y enriquece los metadatos

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

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

Para obtener más información, consulta Descripción general del catálogo de Dataplex.

Aspectos

Los aspectos te permiten capturar metadatos en las entradas. Agregar aspectos a una entrada ayuda a proporcionar un 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, esquema).

Los aspectos se consideran partes del recurso de entrada y no recursos separados. Cuando modificas un aspecto, implica modificar 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 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 ella, según el tipo de aspecto. Puedes tener varios aspectos asociados con las columnas de entrada por tipo de aspecto.

Categorías de aspectos

Los aspectos se categorizan de la siguiente manera:

  • Aspectos obligatorios: 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 que pertenecen a un tipo de entrada siempre deben tener todos los aspectos necesarios que define ese tipo de entrada.

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

    Ten en cuenta lo siguiente:

    • Puedes asociar los aspectos obligatorios solo con 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 columnas de entrada. Puedes propagar aspectos opcionales al momento de crear la entrada o, más adelante, si la actualizas.

    Puedes borrar 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 aspecto

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

  • Tipos de aspectos personalizados: Los tipos de aspectos que creas en Dataplex Catalog.

  • Tipos de aspectos del sistema: Los tipos de aspectos que Dataplex proporciona, usa 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 los tipos de aspectos del sistema y la lista de tipos de aspectos que Dataplex proporciona para cada una de las categorías:

    Categoría del tipo de aspecto del sistema Descripción Tipos de aspecto 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 ellos.
    • 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

    No uses los tipos de aspecto del sistema overview, contacts ni schema.

    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. La ubicación de un tipo de aspecto 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 y aspectos de aspectos, completa las tareas que se describen en esta sección.

Roles obligatorios

Si quieres 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:

Si quieres obtener más información para otorgar roles, consulta Administra el acceso.

Es posible que también puedas obtener los permisos necesarios a través de funciones personalizadas o, también, otras funciones predefinidas.

Para obtener más información, consulta Funciones de IAM de Dataplex.

Habilita la API

Habilitar la API de Dataplex en tu proyecto de Dataplex

Habilitar la API

Cómo crear 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 > Personalizado.

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

    1. Opcional: En el campo Nombre visible (Display name), ingresa un nombre para el tipo de aspecto.
    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. Define una plantilla para tu tipo de aspecto (opcional).

    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. En función de tu 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 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.
        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 Array como el tipo de datos, en la sección Array item, 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 (Display name), 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.

          En función de 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 de esta sección.

        6. Haz clic en Listo.

      • Si seleccionaste Map 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, 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 de esta sección.

        6. Haz clic en Listo.

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

        1. 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 para usar el ID de registro y los campos de referencia del registro de este documento.
        2. Opcional: Si deseas agregar una referencia a otro registro a partir de esta plantilla, usa el campo Record reference. No puedes modificar esto después de crear el tipo de aspecto. Consulta la sección Ejemplo para usar el ID de registro y los campos de referencia del 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 (Display name), ingresa un nombre visible para el campo de registro.
          3. Opcional: En el campo Descripción, ingresa una descripción para el campo del registro.

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

            En función de tu selección, se mostrará el siguiente conjunto de campos y opciones. Son similares a las opciones que se describieron anteriormente para los tipos de datos Text, Enum, Map, Array y Record 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 los 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. Ingresa una clave en el campo 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 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 Current address y Permanent address son del mismo tipo de datos Record. Para evitar la duplicación, puedes configurar los valores Record ID y Record reference cuando definas estos campos.

Cuando defines el campo Dirección actual, puedes especificar Record ID como address-field. En 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 necesitas duplicar los campos de otra dirección.

Agrega 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.
  • 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 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 Elegir plataforma de búsqueda, selecciona Catálogo de Dataplex como modo de búsqueda.

  3. Busca la entrada a la que deseas agregarle 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 las entradas, haz clic en la pestaña Detalles.
    2. Para agregar aspectos opcionales o obligatorios a la entrada, en la sección Aspects, haz clic en Add en la categoría respectiva.
      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 quieres 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.

No se admite la creación y el uso de aspectos en una entrada en la que el tipo de aspecto respectivo y la entrada están 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.

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 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 deseas actualizar, haz clic en Edit.

  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 método 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 Elegir plataforma de búsqueda, selecciona Catálogo de Dataplex como modo de búsqueda.

  3. Busca la entrada cuyos aspectos deseas borrar 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 borrar, haz clic en Borrar.

  6. Haz clic en Confirm.

REST

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

Administra tipos de aspecto

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 aspecto de este documento.

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

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

REST

Para enumerar todos los tipos de aspecto disponibles, usa el método 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, 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 del tipo de aspecto seleccionado.

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

  5. Para ver la lista de 10 entradas relacionadas que se crearon recientemente, haz clic en la pestaña Entradas de muestra.

  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 del tipo de aspecto ni la ubicación después de crear el 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 actualizar.

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

  5. Edita el nombre visible, la descripción, los campos de 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, expande el campo.
    2. Selecciona Is obsoleto.
    3. En el campo Motivo de baja, ingresa el motivo por el que se dio 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 deseas 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 el método aspectTypes.delete.

¿Qué sigue?