Administrar notebooks

En este documento, se describe cómo administrar notebooks de Colab Enterprise en BigQuery, incluido cómo ver, comparar, restablecer y borrar notebooks.

En este documento, también se describe cómo ver y administrar los metadatos de los notebooks en Dataplex.

Los notebooks son recursos de código de BigQuery Studio con tecnología de Dataform.

Antes de comenzar

1. Crea un notebook.
2. Para administrar los metadatos de los notebooks en Dataplex, asegúrate de que la API de Dataplex esté habilitada en tu proyecto de Google Cloud .

Permisos necesarios

Para compartir los notebooks, necesitas los siguientes roles de Identity and Access Management (IAM):

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)
• Propietario del código (roles/dataform.codeOwner) a nivel de recurso.

Para guardar y borrar notebooks, necesitas los siguientes roles de IAM:

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)
• Propietario (roles/dataform.codeOwner) o Editor de código (roles/dataform.codeEditor)

Para trabajar con revisiones del notebook, necesitas los siguientes roles de IAM:

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)

• Cualquiera de los siguientes roles:

  • Propietario del código (roles/dataform.codeOwner)
  • Editor de código (roles/dataform.codeEditor)
  • Visualizador de código (roles/dataform.codeViewer)

Para obtener más información sobre IAM de BigQuery, consulta Control de acceso con IAM.

Para administrar los metadatos de los notebooks en Dataplex, asegúrate de tener los roles de Dataplex necesarios.

Otorga acceso a los notebooks

Para otorgar acceso a un notebook a otros usuarios, agrégalos a un rol de IAM adecuada.

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, la carpeta Notebooks compartidos. Busca el notebook al que quieres otorgar acceso.

3. Haz clic en more_vert Ver acciones junto al notebook y, luego, en Compartir > Administrar permisos.

4. En el panel Administrar permisos, haz clic en Agregar usuario o grupo.

5. En el campo Principales nuevas, ingresa una principal.

6. En la lista Rol, selecciona uno de los siguientes roles:

   • Propietario del código: Puede realizar cualquier acción en el notebook, incluida la eliminación o el uso compartido.
   • Editor de código: Puede editar el notebook.
   • Visualizador de código: Puede ver el notebook.

7. Opcional: Para ver una lista completa de las funciones y la configuración de uso compartido avanzada, haz clic en Uso compartido avanzado.

8. Haz clic en Guardar.

9. Para volver a la página de información del notebook, haz clic en Cerrar.

Comparte notebooks

Para compartir un notebook con otros usuarios, puedes generar y compartir un vínculo al notebook. Para que otros usuarios vean el notebook que compartes, primero debes otorgar acceso al notebook.

Para ejecutar un notebook, los usuarios deben tener acceso a los datos a los que accede el notebook. Para obtener más información, consulta Otorga acceso a un conjunto de datos.

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, expande la carpeta Notebooks compartidos. Busca la carpeta que quieras compartir.

3. Haz clic en more_vert Ver acciones junto al notebook y, luego, en Compartir > Copiar vínculo.

4. Comparte el vínculo con otros usuarios.

Visualiza todos los notebooks

Para ver una lista de todos los notebooks de tu proyecto, haz lo siguiente:

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, haz clic en more_vert Ver acciones junto a Notebooks y, luego, realiza una de las siguientes acciones:

• Para abrir la lista en la pestaña actual, haz clic en Mostrar todo.
• Para abrir la lista en una pestaña nueva, haz clic en Mostrar todo en > Pestaña nueva.
• Para abrir la lista en una pestaña dividida, haz clic en Mostrar todo en > Pestaña dividida.

Cómo ver los metadatos del notebook

Para ver los metadatos del notebook, sigue estos pasos:

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, la carpeta Notebooks compartidos. Haz clic en el nombre del notebook del que quieres ver los metadatos.

3. Mira el panel Resumen para ver información sobre el notebook, como la región que usa para los datos y la fecha en que se modificó por última vez.

Trabaja con versiones de notebooks

Usa las siguientes secciones para aprender a ver, comparar y restablecer versiones de un notebook.

Cómo ver las versiones de notebook

Para ver las versiones de notebook, sigue estos pasos:

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, la carpeta Notebooks compartidos. Haz clic en el nombre del notebook del que quieres ver la actividad.

3. Haz clic en la pestaña Actividad para ver una lista de las versiones de notebook en orden descendente por fecha.

Cómo comparar versiones de notebooks

Para comparar las versiones de notebook, sigue estos pasos:

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, la carpeta Notebooks compartidos. Haz clic en el nombre del notebook del que quieres comparar la información de la versión.

3. En la pestaña Actividad, haz clic en more_vert Ver acciones junto a la versión de un notebook y, luego, haz clic en Comparar. Se abrirá el panel de comparación y se comparará la versión del notebook que seleccionaste con la versión actual del notebook.

4. Opcional: Para comparar las versiones intercaladas en lugar de en paneles separados, haz clic en Comparar y, luego, en Intercalado.

5. Opcional: Para comparar el código fuente de las versiones, haz clic en Comparar y, luego, en Mostrar fuente sin procesar.

6. Opcional: Para ocultar el resultado del comando en el notebook, haz clic en Comparar y, luego, anula la selección de Mostrar resultado.

Restablece una versión de notebook

Usa una de las siguientes opciones para restablecer una versión del notebook. Restablecer desde el panel de comparación te permite comparar las versiones actuales y anteriores del notebook antes de restablecer la versión anterior. Si restableces un notebook, se crea una versión nueva del notebook en lugar de reemplazar la actual. No se pierde el historial de versiones.

Descarga un notebook

Para descargar un notebook, sigue estos pasos:

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, la carpeta Notebooks compartidos. Haz clic en el nombre del notebook que deseas descargar.

3. Haz clic en Descargar.

Cómo borrar notebooks

Para borrar un notebook, sigue estos pasos:

1. En la consola de Google Cloud , ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y la carpeta Notebooks y, si es necesario, expande la carpeta Notebooks compartidos. Busca el notebook que quieres borrar.

3. Haz clic en more_vert Ver acciones junto al notebook y, luego, en Borrar.

4. Para confirmar la eliminación, escribe delete en el cuadro de diálogo.

5. Haz clic en Borrar.

Administra metadatos en Dataplex

Dataplex te permite almacenar y administrar metadatos para notebooks. Los notebooks están disponibles en Dataplex de forma predeterminada, sin configuración adicional.

Puedes usar Dataplex para administrar notebooks en todas las ubicaciones de BigQuery. La administración de notebooks en Dataplex está sujeta a las cuotas y los límites de Dataplex y a los precios de Dataplex.

Dataplex recupera automáticamente los siguientes metadatos de los notebooks:

• Nombre del recurso de datos
• Elemento superior del recurso de datos
• Ubicación del recurso de datos
• Tipo de recurso de datos
• Proyecto Google Cloud correspondiente

Dataplex registra los notebooks como entradas con los siguientes valores de entrada:

Grupo de entrada del sistema

El grupo de entrada del sistema para los notebooks es @dataform. Para ver los detalles de las entradas de notebooks en Dataplex, debes ver el grupo de entradas del sistema dataform. Si deseas obtener instrucciones para ver una lista de todas las entradas de un grupo de entradas, consulta Cómo ver los detalles de un grupo de entradas en la documentación de Dataplex.

Tipo de entrada del sistema

El tipo de entrada del sistema para las notebooks es dataform-code-asset. Para ver los detalles de los notebooks, debes ver el tipo de entrada del sistema dataform-code-asset, filtrar los resultados con un filtro basado en aspectos y configurar el campo type dentro del aspecto dataform-code-asset en NOTEBOOK. Luego, selecciona una entrada del notebook seleccionado. Para obtener instrucciones sobre cómo ver los detalles de un tipo de entrada seleccionado, consulta Cómo ver los detalles de un tipo de entrada en la documentación de Dataplex. Si deseas obtener instrucciones para ver los detalles de una entrada seleccionada, consulta Cómo ver los detalles de una entrada en la documentación de Dataplex.

Tipo de aspecto del sistema

El tipo de aspecto del sistema para las notebooks es dataform-code-asset. Para proporcionar contexto adicional a los notebooks en Dataplex a través de la anotación de entradas de notebooks con aspectos, consulta el tipo de aspecto dataform-code-asset, filtra los resultados con un filtro basado en aspectos y establece el campo type dentro del aspecto dataform-code-asset en NOTEBOOK. Para obtener instrucciones sobre cómo anotar entradas con aspectos, consulta Administra los aspectos y enriquece los metadatos en la documentación de Dataplex.

Tipo

El tipo de lienzos de datos es NOTEBOOK. Este tipo te permite filtrar notebooks en el tipo de entrada del sistema dataform-code-asset y el tipo de aspecto dataform-code-asset con la consulta aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK en un filtro basado en aspectos.

Para obtener instrucciones sobre cómo buscar recursos en Dataplex, consulta Cómo buscar recursos de datos en Dataplex en la documentación de Dataplex.

Soluciona problemas

Para obtener más información, consulta Soluciona problemas de Colab Enterprise.

¿Qué sigue?

• Obtén más información sobre los notebooks de Colab Enterprise en BigQuery.
• Obtén más información para crear notebooks.
• Obtén más información para orquestar notebooks.