Crear cuadernos

En este documento se describe cómo crear cuadernos de Colab Enterprise en BigQuery. Los cuadernos son recursos de código de BigQuery Studio basados en Dataform.

Antes de empezar

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.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the BigQuery API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the BigQuery API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Permisos obligatorios

Define los permisos adecuados para crear, editar o ver cuadernos.

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

Para obtener más información sobre Gestión de Identidades y Accesos (IAM) de BigQuery, consulta el artículo Control de acceso con IAM.

Permisos para crear cuadernos

Para obtener los permisos que necesitas para crear y ejecutar cuadernos, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos:

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

• Usuario de BigQuery Studio (roles/bigquery.studioUser) El rol Usuario de BigQuery Studio combina los siguientes roles de gestión de identidades y accesos:

  • Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
  • Usuario de tiempo de ejecución de cuaderno (roles/aiplatform.notebookRuntimeUser)

  • Code Creator (roles/dataform.codeCreator)

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos. Para ver los permisos exactos que se necesitan para crear y ejecutar cuadernos, despliega la sección Permisos necesarios:

Permisos obligatorios

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

Roles para editar cuadernos

Para editar y ejecutar cuadernos, necesitas los siguientes roles de gestión de identidades y accesos:

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)
• Usuario de tiempo de ejecución de cuaderno (roles/aiplatform.notebookRuntimeUser)
• Editor de código (roles/dataform.codeEditor)

Roles para ver cuadernos

Para ver y ejecutar cuadernos, necesitas los siguientes roles de gestión de identidades y accesos:

• Usuario de trabajo de BigQuery (roles/bigquery.jobUser)
• Usuario de sesión de lectura de BigQuery (roles/bigquery.readSessionUser)
• Usuario de tiempo de ejecución de cuaderno (roles/aiplatform.notebookRuntimeUser)
• Visor de código (roles/dataform.codeViewer)

Crear cuadernos

En las siguientes secciones se explica cómo crear un cuaderno.

Definir la región predeterminada de los recursos de código

Si es la primera vez que creas un recurso de código, debes definir la región predeterminada para los recursos de código. No puedes cambiar la región de un recurso de código después de crearlo.

Todos los recursos de código de BigQuery Studio usan la misma región predeterminada. Para definir la región predeterminada de los recursos de código, sigue estos pasos:

1. Ve a la página BigQuery.

   Ir a BigQuery

2. En el panel Explorador, busca el proyecto en el que hayas habilitado los recursos de código.

3. Haz clic en more_vert Ver acciones junto al proyecto y, a continuación, en Cambiar mi región de código predeterminada.

4. En Región, seleccione la región que quiera usar para los recursos de código.

5. Haz clic en Seleccionar.

Para ver una lista de las regiones admitidas, consulta Ubicaciones de BigQuery Studio.

Crear un cuaderno desde el editor de BigQuery

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

1. Ve a la página BigQuery.

   Ir a BigQuery

2. En la barra de pestañas del panel del editor, haz clic en la flecha arrow_drop_down add_box situada junto a Consulta SQL y, a continuación, en Crear cuaderno de Python.

   Se abrirá un nuevo cuaderno que contiene celdas con consultas de ejemplo en el conjunto de datos público bigquery-public-data.ml_datasets.penguins.

3. Opcional: Para ver los detalles del cuaderno o el historial de versiones, añadir comentarios, responder a un comentario o conseguir un enlace a un comentario, usa la siguiente barra de herramientas:

   

   Las funciones de la barra de herramientas Detalles, Historial de versiones y Comentarios están en versión preliminar. Para enviar comentarios o solicitar asistencia sobre estas funciones, envía un correo a bqui-workspace-pod@google.com.

4. Opcional: En la barra de herramientas, puede usar el panel Referencia para obtener una vista previa de los detalles del esquema de tablas, instantáneas, vistas o vistas materializadas, o bien para abrirlos en una pestaña nueva. El panel también incluye una lista de recursos recientes y destacados.

Crear un cuaderno a partir de una tabla

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

1. Ve a la página BigQuery.

   Ir a BigQuery

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

3. Haz clic en more_vert Ver acciones junto a la tabla y, a continuación, en Consultar en > cuaderno de Python.

   Se abrirá un nuevo cuaderno con celdas que muestran consultas de ejemplo en la tabla seleccionada.

Crear un cuaderno para explorar el conjunto de resultados de una consulta

Para crear un cuaderno en el que explorar el conjunto de resultados de una consulta, sigue estos pasos:

1. Ve a la página BigQuery.

   Ir a BigQuery

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

3. En el panel Resultados de la consulta, haz clic en Explorar datos y, a continuación, en Explorar con cuaderno de Python.

   Se abre el nuevo cuaderno, que contiene celdas con código para devolver el SQL de la consulta y los resultados de la consulta.

Crear un cuaderno a partir de otro

Para abrir cualquier versión de un cuaderno como un cuaderno 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, despliega tu proyecto y la carpeta Notebooks (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Selecciona un cuaderno.

3. Haz clic en schedule Historial de versiones.

4. Haz clic en more_vert Ver acciones junto a una versión del cuaderno y, a continuación, en Abrir como cuaderno de Python nuevo.

   Se abre una copia del cuaderno como un cuaderno nuevo.

Subir cuadernos

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

Para subir un cuaderno, sigue estos pasos:

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

   Ir a BigQuery

2. En el panel Explorador, despliega tu proyecto y, a continuación, haz una de las siguientes acciones:

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

3. En el cuadro de diálogo Subir cuaderno, en el campo Cuaderno, haz clic en Examinar y, a continuación, selecciona el cuaderno que quieras subir.

4. Opcional: En el campo Nombre del cuaderno, edita el nombre del cuaderno.

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

6. Haz clic en Subir.

El cuaderno aparecerá en el panel Explorador.

Conectarse a un entorno de ejecución

Consulta las siguientes secciones para saber cómo conectar un cuaderno a un runtime de Vertex AI. Un tiempo de ejecución es un recurso de computación que ejecuta el código de tu cuaderno.

Para obtener más información sobre los tiempos de ejecución, consulta Tiempos de ejecución y plantillas de tiempo de ejecución.

Conectarse al entorno de ejecución predeterminado

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

Para conectarte al tiempo 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, despliega tu proyecto y la carpeta Notebooks (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Haz clic en el nombre de una libreta para abrirla.

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

   Si aún no tienes un entorno de ejecución activo, puede que tardes varios minutos en conectarte al entorno de ejecución predeterminado.

Conectarse a un entorno de ejecución no predeterminado

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

Para conectarte a un tiempo 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, despliega tu proyecto y la carpeta Notebooks (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Haz clic en el nombre de una libreta para abrirla.

3. En el cuaderno, haz clic en el menú desplegable arrow_drop_down situado junto a Conectar y, a continuación, en Conectar con un entorno de ejecución.

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

5. En Runtimes, selecciona el tiempo de ejecución que quieras usar.

6. Haz clic en Conectar.

Conectarse a un nuevo entorno de ejecución

Para conectarte a un nuevo entorno de ejecución, sigue estos pasos:

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

   Ir a BigQuery

2. En el panel Explorador, despliega tu proyecto y la carpeta Notebooks (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Haz clic en el nombre de una libreta para abrirla.

3. En el cuaderno, haz clic en el menú desplegable arrow_drop_down situado junto a Conectar y, a continuación, en Conectar con un entorno de ejecución.

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

5. En Plantilla de entorno de ejecución, selecciona la plantilla de entorno de ejecución de Vertex AI que quieras usar.

6. En Nombre de tiempo de ejecución, escriba un nombre para el tiempo de ejecución.

7. Haz clic en Conectar.

Conceder acceso a los cuadernos

Para dar acceso a otros usuarios a un cuaderno, añádelos al rol de gestión de identidades y accesos adecuado.

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

   Ir a BigQuery

2. En el panel Explorador, despliega tu proyecto y la carpeta Notebooks (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Busca el cuaderno al que quieras dar acceso.

3. Haz clic en more_vert Ver acciones junto al cuaderno y, a continuación, en Compartir > Gestionar permisos.

4. En el panel Gestionar permisos, haz clic en Añadir usuario o grupo.

5. En el campo New principals (Nuevos principales), introduce un principal.

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

   • Propietario del código: puede realizar cualquier acción en el cuaderno, como eliminarlo o compartirlo.
   • Editor de código: puede editar el cuaderno.
   • Visor de código: puede ver el cuaderno.

7. Opcional: Para ver una lista completa de roles y ajustes avanzados para compartir, haz clic en Compartir de forma avanzada.

8. Haz clic en Guardar.

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

Compartir cuadernos

Para compartir un cuaderno con otros usuarios, puedes generar y compartir un enlace al cuaderno. Para que otros usuarios puedan ver el cuaderno que compartes, primero debes concederles acceso.

Para ejecutar un cuaderno, los usuarios deben tener acceso a los datos a los que accede el cuaderno. Para obtener más información, consulta Conceder 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 (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Busca el cuaderno que quieras compartir.

3. Haz clic en more_vert Ver acciones junto al cuaderno y, a continuación, en Compartir > Copiar enlace.

4. Comparte el enlace con otros usuarios.

Inhabilitar el guardado de la salida de un cuaderno

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

Si inhabilitas el guardado de la salida de un cuaderno seleccionado, BigQuery eliminará toda la salida guardada en el archivo del cuaderno y no guardará la salida de las ejecuciones posteriores.

Sin embargo, los usuarios que tengan acceso al cuaderno podrán seguir viendo su salida de las siguientes formas:

• Ejecuta el cuaderno para ver su salida actual. Esta salida no se guarda.
• Ver una versión archivada del cuaderno y su salida en el historial de revisiones.

Para inhabilitar el guardado de la salida de un cuaderno 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 (Cuadernos) y, a continuación, selecciona el cuaderno para el que quieras inhabilitar el guardado de la salida.

3. Haz clic en arrow_drop_down Mostrar u ocultar encabezado > Editar > Configuración del cuaderno.

4. En la ventana Configuración del cuaderno, selecciona Omitir resultado de las celdas de código al guardar este cuaderno.

5. Haz clic en Guardar.

6. Haz clic en Volver a cargar.

Resolver conflictos

Si tú y otro usuario hacéis cambios contradictorios en un cuaderno, el servicio mostrará el error Automatic saving failed. This file was updated remotely or in another tab. y proporcionará un enlace Show diff. Para resolver el conflicto, sigue estos pasos:

1. Haz clic en el enlace Show diff. Se abrirá el cuadro de diálogo Revisar cambios remotos.
2. Opcional: Para comparar el código fuente del cuaderno, selecciona la casilla Fuente sin formato.
3. Opcional: Para comparar las versiones en línea en lugar de en paneles independientes, selecciona la casilla Diferencia en línea.
4. Revisa los cambios y decide cuáles quieres conservar. Si es necesario, revisa tu entrada.
5. Haz clic en Guardar cambios.

Cambiar el nombre de los cuadernos

Para cambiar el nombre de un cuaderno, sigue estos pasos:

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

   Ir a BigQuery

2. En el panel Explorador, despliega tu proyecto y la carpeta Notebooks (Cuadernos) y, si es necesario, la carpeta Shared notebooks (Cuadernos compartidos). Busca el cuaderno al que quieras cambiarle el nombre.

3. Haz clic en more_vert Ver acciones junto al cuaderno y, a continuación, en Cambiar nombre.

4. Escribe un nombre para la libreta y haz clic en Cambiar nombre.

Solución de problemas

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

Siguientes pasos

• Consulta cómo gestionar cuadernos.
• Consulta cómo programar cuadernos.