Descubre las novedades de Firebase en Google I/O 2022. Más información

Se usó la API de Cloud Translation para traducir esta página.

Comienza a usar Firebase Data Connect

En esta guía de inicio rápido, aprenderás a realizar las siguientes tareas:

Agrega Firebase Data Connect a tu proyecto de Firebase.
Configurar un entorno de desarrollo que incluya un Visual Studio Extensión de código para trabajar con una instancia de producción.
A continuación, te mostraremos cómo hacer lo siguiente:
- Crea un esquema para una app de correo electrónico y, luego, impleméntalo en producción.
- Define consultas y mutaciones para tu esquema.
- Implementa tu prototipo final en producción.

Requisitos previos

Para usar esta guía de inicio rápido, necesitarás lo siguiente.

Linux, macOS o Windows
Visual Studio Code

Agrega Data Connect a tu proyecto y crea una fuente de datos

Si aún no lo has hecho, crea un proyecto de Firebase.
1. En Firebase console, haz clic en Agrega proyecto y sigue las instrucciones en pantalla.
Actualiza tu proyecto al plan Blaze. Esto te permite crear una instancia para una instancia de PostgreSQL.

Nota: Aunque hayas configurado la facturación en la actualización de Blaze, no podrás se cobra por el uso de Data Connect o Configuración predeterminada de Cloud SQL para PostgreSQL durante la vista previa.
Ve a la sección Conexión de datos de Firebase console y seguir el flujo de trabajo de configuración del producto.
Selecciona una ubicación para tu base de datos de Cloud SQL para PostgreSQL.
Toma nota de los nombres y los IDs del proyecto, el servicio y la base de datos para confirmarlos más tarde.
Sigue el flujo de configuración restante y haz clic en Listo.

Nota: El aprovisionamiento de tu Cloud SQL puede tardar hasta 15 minutos en de PostgreSQL. Puedes confirmar el flujo de configuración de Data Connect. incluido el aprovisionamiento de bases de datos, se completa usando el Consola de Google Cloud.

Elige y configura un entorno de desarrollo

Data Connect admite dos experiencias de desarrollo para el prototipado:

Si eres desarrollador de Kotlin para Android o la Web, puedes usar VS Code. de desarrollo de software para crear prototipos de esquemas y operaciones a nivel local mientras te conectas a tu instancia de Cloud SQL para PostgreSQL.
Si eres un desarrollador web, puedes usar IDX Development para crear prototipos en un lugar de trabajo de IDX usando una plantilla de IDX preconfigurada con PostgreSQL, Extensión de VS Code con el emulador de Data Connect y código de inicio rápido configurados automáticamente.

Desarrollo de VS Code

Si deseas desarrollar de forma local en lugar de usar IDX, configura Firebase VS Extensión de código para que puedas iterar tu desarrollo rápidamente.

Crea un directorio nuevo para tu proyecto local.
Abre VS Code en el directorio nuevo.
Descarga la extensión, incluida como un paquete VSIX, desde Firebase Storage.

Nota: No puedes hacer doble clic en el paquete de VSIX para instalar la extensión. Asegúrate de seguir los próximos pasos para instalarla correctamente.
En VS Code, en el menú View, selecciona Extensions.
En la barra de título del panel Extensions, haz clic en el ícono de menú. more_horiz y, luego, sigue Instalar desde VSIX...

Desarrollo de IDX

IDX es un entorno optimizado para el desarrollo de apps web. Si eres un desarrollador de Kotlin para Android, sigue los pasos que se indican en la página VS Code Desarrollo.

Para configurar una plantilla de IDX de Data Connect, haz lo siguiente:

Accede a la plantilla en el sitio de Project IDX.
Sigue el flujo de configuración.

De forma opcional, puedes instalar una base de datos de PostgreSQL local para el desarrollo local con el emulador de Data Connect. Esta configuración se aborda al final del esta guía de inicio rápido.

Configura tu proyecto local

Instala la CLI siguiendo las instrucciones habituales. Si tienes npm ya instalada, ejecuta el siguiente comando:

npm install -g firebase-tools

Para configurar tu proyecto local, inicializa el directorio del proyecto.

Configura el directorio de tu proyecto

Para configurar tu proyecto local, inicializa el directorio del proyecto.

En el panel del lado izquierdo de VS Code, haz clic en el ícono de Firebase para abrir Firebase VS. IU de extensión de código.

En la IU de la extensión de Firebase:

Asegúrate de que accediste a tu cuenta.
Haz clic en el botón Run firebase init.
Revisa la pestaña Terminal en el panel inferior de VS Code para ver los mensajes.
Selecciona Conexión de datos como función para usar en este directorio.
Cuando se te solicite, proporciona los IDs del proyecto, del servicio y de la base de datos de la Proyecto de conexión de datos que creaste anteriormente en la consola.

Crea un esquema y consulta de Data Connect

Comienza a usar GraphQL para modelar usuarios y correos electrónicos. Actualizarás las fuentes en las siguientes ubicaciones:

/dataconnect/schema/schema.gql
/dataconnect/default-connector/queries.gql

Comienza a desarrollar un esquema

En el directorio de tu proyecto de Firebase, anota la carpeta dataconnect. Este es en la que se define el modelo de datos para una base de datos de Cloud SQL con GraphQL.

En el archivo /dataconnect/schema/schema.gql, comienza a definir un esquema que incluye usuarios y correos electrónicos.

Usuario

En Data Connect, los campos de GraphQL se asignan a columnas. Los usuarios tienen un uid, name y address por correo electrónico. Data Connect reconoce varias tipos de datos primitivos: String y Date.

Copia el siguiente fragmento o quita el comentario de las líneas correspondientes del archivo.

# File `/dataconnect/schema/schema.gql`

type User @table(key: "uid") {
   uid: String!
   name: String!
   address: String!
}

De forma predeterminada, Firebase Data Connect agregará una clave id de UUID si no se especifica ninguna que se proporcionan. Sin embargo, en este caso, quieres que uid sea la clave primaria, lo que que puedes hacer a través de la directiva @table(key: "uid").

Correo electrónico

Ahora que tienes usuarios, puedes modelar los correos electrónicos. Aquí puedes agregar los tipos campos (o columnas) para los datos de correo electrónico. Esta vez, omitimos la adición de una clave primaria. ya que puedes confiar en que Data Connect la administrará.

# File `/dataconnect/schema/schema.gql`

type Email @table {
   subject: String!
   sent: Date!
   text: String!
   from: User!
}

Ten en cuenta que el campo from está asignado a un tipo de User. Data Connect entiende que esta es una relación entre Email y User, y administrará esta relación por ti.

Implementa tu esquema en producción.

Si usas la extensión Firebase VS Code para trabajar con tu de producción, debes implementar tu esquema antes de continuar. Después del implementa tu esquema en tu base de datos de producción, deberías poder ver el esquema en la consola.

Puedes usar la extensión de Firebase VS Code para la implementación.
- En la IU de la extensión, en el panel de Firebase Data Connect, haz clic en Implementar todo.
Es posible que debas revisar los cambios de esquema y aprobar los posibles efectos destructivos en caso de modificaciones accidentales. Se te pedirá que hagas lo siguiente:
- Revisa los cambios de esquema con firebase dataconnect:sql:diff
- Cuando estés conforme con los cambios, aplícalos usando el flujo iniciado por firebase dataconnect:sql:migrate

Ejecuta mutaciones para agregar datos a tus tablas

En el panel del editor de VS Code, puedes ver que aparecen los botones de CodeLens sobre el Tipos de GraphQL en /dataconnect/schema/schema.gql. Dado que implementaste tu esquema a producción, puedes usar las opciones Agregar datos y Ejecutar (producción). botones en los archivos generados resultantes para realizar estas acciones en tu backend.

Para agregar registros a las tablas User y Email, haz lo siguiente:

En schema.gql, haz clic en el botón Agregar datos que se encuentra sobre el tipo User. de registro.
En el archivo User_insert.gql que se genera, codifica los datos para el tres campos.
Haz clic en el botón Run (Production).
Repite los pasos anteriores para agregar un registro a la tabla Email y proporciona el uid del usuario en el campo fromUid, como se solicita en la Email_insert.

Escribe una consulta para enumerar los correos electrónicos

Ahora la parte divertida, las consultas. Como desarrollador, estás acostumbrado a escribir en lugar de consultas de GraphQL, por lo que esto puede ser un poco diferente al principio. Sin embargo, GraphQL es mucho más tersa y segura de tipos que SQL sin procesar. Y nuestro VS Code de extensiones facilita la experiencia de desarrollo.

Comienza a editar el archivo /dataconnect/default-connector/queries.gql. Si quieres para obtener todos los correos electrónicos, usa una consulta como esta.

# File `/dataconnect/default-connector/queries.gql`

query ListEmails @auth(level: NO_ACCESS) {
  emails {
    id, subject, text, sent
    from {
      name
    }
  }
}

Ejecuta la consulta con el botón cercano de CodeLens.

Una función interesante es la capacidad de tratar relaciones como un gráfico. Como un correo electrónico tiene un campo from que hace referencia a un Usuario, puede anidar en el campo y obtener información sobre el usuario.

Implementa el prototipo completo en producción

Trabajaste en una iteración de desarrollo. Ahora puedes implementar tu el esquema, los datos y las consultas al servidor IU de extensiones o Firebase CLI, tal como lo hizo con su esquema.

Si usas la extensión de Firebase VS Code para implementar, haz clic en el botón Implementar todo. .

Una vez implementado, deberías poder ver y ejecutar tus operaciones en la consola a tus conjuntos de datos. Tu servicio de Data Connect estará listo para procesar operaciones de los clientes. La instancia de Cloud SQL para PostgreSQL se actualizará con su el esquema y los datos generados que se implementaron.

Instala PostgreSQL de forma local (opcional)

Instalar PostgreSQL de forma local e integrarlo con el emulador te permite en un entorno de desarrollo completamente local.

Puedes instalar una instancia nueva de PostgreSQL o usar una existente.

Instala PostgreSQL

Instala la versión 15.x de PostgreSQL siguiendo las instrucciones para tu plataforma.

macOS Descarga e instala Postgres.app.
Windows: Usa el instalador de EDB de la página de descargas de PostgreSQL.
Docker: extrae y ejecuta el pgvector/pgvector:15 imagen, que incluye PostgreSQL 15.x y compatibilidad con vectores.
Linux: Recomendamos usar Docker con la imagen anterior, pero también puedes seguir instrucciones alternativas para las distribuciones populares.

Ten en cuenta el nombre de host, el puerto, el nombre de usuario y la contraseña y los parámetros relacionados durante la secuencia de instalación.

Para conectarse a tu instancia de PostgreSQL, el emulador necesita:

Estos parámetros de configuración
El nombre de la base de datos de tu dataconnect.yaml y un nombre correspondiente inicializada en tu instancia local.

Usa tu instancia de PostgreSQL local

Puedes usar una instancia de PostgreSQL local existente actualizando el Configuración del emulador de Data Connect.

firebase setup:emulators:dataconnect

Cuando se te solicite, ingresa la cadena de conexión de PostgreSQL en este formato: postgresql://postgresusername:postgrespassword@localhost:5432/postgresdatabase?sslmode=disable

Para obtener más información sobre la cadena de conexión, consulta la Documentación de PostgreSQL.

Conéctate a tu instancia de PostgreSQL local

Una vez que esta configuración esté lista, sigue estos pasos para conectarte a tu base de datos local:

En VS Code, en el panel de la izquierda, haz clic en el ícono de Firebase para abrir la IU de la extensión de Firebase VS Code
Haz clic en el botón Connect to Local PostgreSQL.