Crear notebooks

En este documento se describe cómo administrar notebooks de Colab Enterprise en BigQuery. Los notebooks son recursos de código de BigQuery Studio con tecnología de Dataform.

Antes de comenzar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the BigQuery API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the BigQuery API.

   Enable the API

Habilita BigQuery Studio

Sigue las instrucciones en Habilita BigQuery Studio para la administración de elementos a fin de guardar, compartir y administrar versiones de recursos de código, como los notebooks.

Permisos necesarios

Configura los permisos adecuados para crear, editar o ver notebooks.

Todos los usuarios con el rol Administrador de Dataform (roles/dataform.admin) tienen acceso de propietario a todos los notebooks creados en el proyecto.

Para obtener más información sobre Identity and Access Management (IAM) de BigQuery, consulta Control de acceso con IAM.

Permisos para crear notebooks

Para crear y ejecutar notebooks, necesitas los siguientes permisos de IAM:

• resourcemanager.projects.get
• resourcemanager.projects.list
• bigquery.config.get
• bigquery.jobs.create
• bigquery.readsessions.create
• bigquery.readsessions.getData
• bigquery.readsessions.update
• resourcemanager.projects.get
• resourcemanager.projects.list
• dataform.locations.get
• dataform.locations.list

• dataform.repositories.create

  Nota: Los usuarios que tienen el permiso dataform.repositories.create pueden ejecutar el código mediante la cuenta de servicio predeterminada de Dataform y todos los permisos otorgados a esa cuenta de servicio. Si deseas obtener más información, consulta Consideraciones de seguridad para los permisos de Dataform.

• dataform.repositories.list

• dataform.collections.create

• dataform.collections.list

• aiplatform.notebookRuntimeTemplates.apply

• aiplatform.notebookRuntimeTemplates.get

• aiplatform.notebookRuntimeTemplates.list

• aiplatform.notebookRuntimeTemplates.getIamPolicy

• aiplatform.notebookRuntimes.assign

• aiplatform.notebookRuntimes.get

• aiplatform.notebookRuntimes.list

• aiplatform.operations.list

Puedes obtener estos permisos desde los siguientes roles de IAM:

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

• Usuario de BigQuery Studio (roles/bigquery.studioUser)

  El rol del usuario de BigQuery Studio combina las siguientes funciones de IAM:

  • Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
  • Usuario del entorno de ejecución del notebook (roles/aiplatform.notebookRuntimeUser)

  • Creador de código (roles/dataform.codeCreator)

    Nota: Los usuarios con el rol Creador de código en un proyecto pueden enumerar los nombres de los elementos de código de ese proyecto mediante la API de Dataform o la interfaz de línea de comandos (CLI) de Dataform. Los usuarios que no son administradores que usan BigQuery Studio solo pueden ver los elementos de código que crearon o que se compartieron con ellos.

Permisos para editar notebooks

Para editar y ejecutar 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)
• Usuario del entorno de ejecución del notebook (roles/aiplatform.notebookRuntimeUser)
• Editor de código (roles/dataform.codeEditor)

Permisos para ver notebooks

Para ver y ejecutar 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)
• Usuario del entorno de ejecución del notebook (roles/aiplatform.notebookRuntimeUser)
• Visualizador de código (roles/dataform.codeViewer)

Crear notebooks

Usa las siguientes secciones para aprender a crear un notebook.

Configura la región predeterminada para los elementos de código

Si es la primera vez que creas un elemento de código, configura la región predeterminada para los elementos de código. No puedes cambiar la región de un elemento de código después de crearla.

Nota: Si creas una consulta guardada y eliges una región predeterminada diferente de la que usaste para los elementos de código (por ejemplo, si eliges us-west1, pero antes estuviste usando us-central1), la consulta y todos los elementos de código que crees posteriormente usarán esa nueva región de forma predeterminada. Los elementos de código existentes continúan usando la región a la que se asignaron cuando se crearon.

Crea un notebook desde el editor de BigQuery

Para crear un notebook que contenga una consulta predeterminada para una tabla determinada, sigue estos pasos:

1. Ve a la página de BigQuery.

   Ir a BigQuery

2. En la barra de pestañas del panel del editor, haz clic en el ícono menú desplegable junto al menú desplegable + signo y, luego, haz clic en Crear notebook de Python.

   Se abrirá el notebook nuevo, el cual contiene celdas que muestran consultas de ejemplo en el conjunto de datos públicos bigquery-public-data.ml_datasets.penguins.

Crea un notebook a partir de una tabla

Para crear un notebook que contenga una consulta predeterminada para una tabla específica, sigue estos pasos:

1. Ve a la página de BigQuery.

   Ir a BigQuery

2. En el panel Explorador, expande tu proyecto y busca la tabla que deseas consultar.

3. Haz clic en Ver acciones junto a la tabla y, luego, en Consultar en > notebook de Python.

   Se abrirá el notebook nuevo que contiene celdas que muestran consultas de ejemplo en la tabla seleccionada.

Crea un notebook para explorar el conjunto de resultados de una consulta

Para crear un notebook a fin de explorar el conjunto de resultados de una consulta, sigue estos pasos:

1. Ve a la página de BigQuery.

   Ir a BigQuery

2. En el panel del editor, ejecuta una consulta que genere un resultado de consulta.

3. En el panel Resultados de la consulta, haz clic en Explorar datos y, luego, en Explorar con notebook de Python.

   Se abrirá el notebook nuevo que contiene celdas con código para mostrar la consulta de SQL y los resultados de la consulta.

Crea un notebook a partir de uno ya existente

Para abrir cualquier versión de un notebook existente como nuevo, 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. Selecciona un notebook

3. Selecciona el panel Actividad.

4. Haz clic en Ver acciones junto a la versión de un notebook y, luego, en Abrir como notebook nuevo de Python.

   Se abre una copia del notebook como un notebook nuevo.

Subir notebooks

Puedes subir un notebook local para usarlo en BigQuery Studio. El notebook subido se puede ver en la página de BigQuery de la consola de Google Cloud.

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, luego, realiza una de las siguientes acciones:

   • Junto a Notebooks, haz clic en Ver acciones > Subir a Notebooks.
   • Junto al nombre del proyecto de Google Cloud, haz clic en Ver acciones > Subir al proyecto > Notebook de Python.

3. En el cuadro de diálogo Subir notebook, en el campo Seleccionar notebook, haz clic en Explorar y selecciona el notebook que deseas subir.

4. En el campo Nombre del notebook, edita el nombre del archivo de notebook (opcional).

5. En el campo Región, selecciona la región en la que deseas subir tu notebook.

6. Haz clic en Subir.

Tu notebook aparece en el panel del Explorador.

Conéctate a un entorno de ejecución

Usa las siguientes secciones para aprender a conectar un notebook a un entorno de ejecución de Vertex AI. Un entorno de ejecución es un recurso de procesamiento que ejecuta el código en tu notebook.

Para obtener más información sobre los entornos de ejecución, consulta Entornos de ejecución y plantillas de entorno de ejecución.

Conéctate al entorno de ejecución predeterminado

El entorno de ejecución predeterminado es un entorno de ejecución predeterminado que requiere una configuración mínima.

Para conectarte al entorno de ejecución predeterminado, 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 de un notebook para abrirlo.

3. En el notebook, haz clic en Conectar o ejecuta cualquier celda en el notebook.

   La conexión al entorno de ejecución predeterminado puede tardar varios minutos si aún no tienes un entorno de ejecución activo.

Conéctate a un entorno de ejecución no predeterminado

Si deseas usar un entorno de ejecución que no sea el predeterminado, primero debes crear ese entorno de ejecución adicional en Vertex AI.

Para conectarte al entorno de ejecución no predeterminado, 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 de un notebook para abrirlo.

3. En el notebook, haz clic en el menú desplegable junto a Conectar y, luego, en Conectar a un entorno de ejecución.

4. Haz clic en Conectar a un entorno de ejecución existente.

5. En Entornos de ejecución, selecciona el entorno de ejecución que deseas usar.

6. Haz clic en Conectar.

Conectar a un nuevo entorno de ejecución

Para conectarte a un entorno de ejecución nuevo, 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 de un notebook para abrirlo.

3. En el notebook, haz clic en el menú desplegable junto a Conectar y, luego, en Conectar a un entorno de ejecución.

4. Haz clic en Crear nuevo entorno de ejecución.

5. En Plantilla del entorno de ejecución, selecciona la plantilla de entorno de ejecución de Vertex AI para usarla.

6. En Nombre del entorno de ejecución, escribe un nombre para el entorno de ejecución.

7. Haz clic en Conectar.

Otorga acceso a los notebooks

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

Importante: Los usuarios que tienen acceso al notebook pueden ver todos los resultados que generó el código en el notebook, incluso si este resultado contiene datos de tablas que no admiten T debe tener acceso. Para evitar que se comparta el resultado guardado, inhabilita el guardado de resultados del notebook.

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 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.
   Nota: La principal también debe tener el Usuario del entorno de ejecución del notebook (roles/aiplatform.notebookRuntimeUser) y Roles de usuario de BigQuery (roles/bigquery.user) para ejecutar 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.

Importante: Los usuarios que tienen acceso al notebook pueden ver todos los resultados que generó el código en el notebook, incluso si este resultado contiene datos de tablas que no admiten T debe tener acceso. Para evitar que se comparta el resultado guardado, inhabilita el guardado de resultados del notebook.

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 Ver acciones junto al notebook y, luego, en Compartir > Copiar vínculo.

4. Comparte el vínculo con otros usuarios.

Inhabilita el guardado de resultados de notebook

Puedes evitar que se comparta el resultado del notebook guardado con otros usuarios que tengan acceso al archivo del notebook si inhabilitas el guardado de resultados del notebook.

Cuando inhabilitas el guardado de resultados para un notebook seleccionado, BigQuery borra todos los resultados guardados en el archivo del notebook y no guarda el resultado de las ejecuciones posteriores.

Sin embargo, los usuarios que tienen acceso al notebook aún pueden ver el resultado de las siguientes maneras:

• Ejecuta el notebook para ver su resultado actual. No se guardó este resultado.
• Visualiza una versión de archivo del notebook y su resultado en el historial de revisión.

Para inhabilitar el guardado de resultados en un notebook seleccionado, 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, luego, selecciona el notebook en el que deseas inhabilitar el guardado de resultados.

3. Haz clic en Activar o desactivar la visibilidad del encabezado > Editar > Configuración del notebook.

4. En la ventana Configuración del notebook, selecciona Omitir el resultado de la celda de código cuando guardas este notebook.

5. Haz clic en Guardar.

6. Haz clic en Volver a cargar.

Resolver conflictos

Si tú y otro usuario realizan cambios conflictivos en un notebook, el servicio genera el error Automatic saving failed. This file was updated remotely or in another tab. y proporciona un vínculo Show diff. Para resolver el conflicto, sigue estos pasos:

1. Haz clic en el vínculo Show diff. Se abrirá el cuadro de diálogo Revisar cambios remotos.
2. Opcional: Para comparar el código fuente del notebook, selecciona la casilla de verificación Fuente sin procesar.
3. Opcional: Para comparar las versiones intercaladas en lugar de en paneles separados, selecciona la casilla de verificación Diferencia intercalada.
4. Revisa los cambios, decide cuál conservar y revisa tu entrada si es necesario.
5. Haz clic en Guardar los cambios.

Cambia el nombre de los 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, la carpeta Notebooks compartidos. Busca la carpeta a la que quieras cambiarle el nombre.

3. Haz clic en Ver acciones junto al notebook y, luego, en Cambiar nombre.

4. Escribe un nombre para el notebook y haz clic en Cambiar nombre.

Soluciona problemas

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

¿Qué sigue?

• Obtén más información sobre cómo administrar notebooks.