Comienza a usar Firebase Data Connect de forma local

En esta guía de inicio rápido, aprenderás a compilar Firebase Data Connect en tu aplicación de forma local sin configurar una instancia de SQL de producción. Harás lo siguiente:

  • Agrega Firebase Data Connect a tu proyecto de Firebase.
  • Configura un entorno de desarrollo que incluya una extensión de Visual Studio Code para trabajar con una instancia local.
  • Luego, te mostraremos cómo hacer lo siguiente:
    • Crea un esquema para una app de películas
    • Define las consultas y mutaciones que se usarán en tu app
    • Prueba tus consultas y mutaciones con datos de muestra en un emulador local.
    • Genera SDKs fuertemente tipificados y úsalo en tu app
    • Implementa tu esquema, tus consultas y tus datos finales en la nube (opcional, con una actualización del plan de Blaze).

Elige un flujo de desarrollo local

Data Connect te ofrece dos maneras de instalar herramientas de desarrollo y trabajar de forma local.

Requisitos previos

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

Configura el entorno de desarrollo

  1. Crea un directorio nuevo para tu proyecto local.

  2. Ejecuta el siguiente comando en el directorio nuevo que creaste.

      curl -sL https://firebase.tools/dataconnect | bash

    Esta secuencia de comandos intenta configurar el entorno de desarrollo por ti y, luego, iniciar un IDE basado en el navegador. Este IDE proporciona herramientas, incluida una extensión precompilada de VS Code, para ayudarte a administrar tu esquema y definir consultas y mutaciones que se usarán en tu aplicación, y generar SDKs fuertemente tipados.

alias dataconnect='curl -sL https://firebase.tools/dataconnect | bash'

Configura el directorio de tu proyecto

Para configurar tu proyecto local, inicializa el directorio del proyecto. En la ventana del IDE, en el panel izquierdo, haz clic en el ícono de Firebase para abrir la IU de la extensión de VS Code de Data Connect:

  1. Haz clic en el botón Acceder con Google.
  2. Haz clic en el botón Connect a Firebase project y selecciona el proyecto que creaste antes en la consola.
  3. Haz clic en el botón Run firebase init.

  4. Haz clic en el botón Start emulators.

Crea un esquema

En el directorio de tu proyecto de Firebase, en el archivo /dataconnect/schema/schema.gql, comienza a definir un esquema GraphQL sobre películas.

Película

En Data Connect, los campos de GraphQL se asignan a columnas. La película tiene id, title, imageUrl y genre. Data Connect reconoce tipos de datos primitivos: String y UUID.

Copia el siguiente fragmento o quita los comentarios de las líneas correspondientes en el archivo.

# By default, a UUID id key will be created by default as primary key.
# If you want to specify a primary key, say title, which you can do through
# the @table(key: "title") directive
type Movie @table {
  id: UUID! @default(expr: "uuidV4()")
  title: String!
  imageUrl: String!
  genre: String
}

MovieMetadata

Copia el siguiente fragmento o quita los comentarios de las líneas correspondientes en el archivo.

# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
  # This time, we omit adding a primary key because
  # you can rely on Data Connect to manage it.

  # @unique indicates a 1-1 relationship
  movie: Movie! @unique
  # movieId: UUID <- this is created by the above reference
  rating: Float
  releaseYear: Int
  description: String
}

Ten en cuenta que el campo movie está asignado a un tipo de Movie. Data Connect comprende que esta es una relación entre Movie y MovieMetadata, y la administrará por ti.

Obtén más información sobre los esquemas de Data Connect en la documentación

Agrega datos a tus tablas

En el panel del editor del IDE, verás que los botones de CodeLens aparecen sobre los tipos de GraphQL en /dataconnect/schema/schema.gql. Puedes usar los botones Agregar datos y Ejecutar (local) para agregar datos a tu base de datos local.

Para agregar registros a las tablas Movie y MovieMetadata, haz lo siguiente:

  1. En schema.gql, haz clic en el botón Agregar datos que se encuentra sobre la declaración de tipo Movie.
    Botón Agregar datos de CodeLens para Firebase Data Connect
  2. En el archivo Movie_insert.gql que se genera, codifica los datos de los tres campos.
  3. Haz clic en el botón Run (Local).
    Botón Run de CodeLens para Firebase Data Connect
  4. Repite los pasos anteriores para agregar un registro a la tabla MovieMetadata y proporcionar el id de tu película en el campo movieId, como se indica en la mutación MovieMetadata_insert generada.

Para verificar rápidamente si se agregaron los datos, haz lo siguiente:

  1. En schema.gql, haz clic en el botón Read data sobre la declaración de tipo Movie.
  2. En el archivo Movie_read.gql resultante, haz clic en el botón Run (Local) para ejecutar la consulta.

Obtén más información sobre las mutaciones de Data Connect en la documentación

Define tu consulta

Ahora viene la parte divertida: definamos las consultas que necesitarás en tu aplicación. Como desarrollador, estás acostumbrado a escribir consultas SQL en lugar de consultas de GraphQL, por lo que esto puede parecer un poco diferente al principio.

Sin embargo, GraphQL es mucho más conciso y seguro de tipo que SQL sin procesar. Además, nuestra extensión de VS Code facilita la experiencia de desarrollo.

Empieza a editar el archivo /dataconnect/connector/queries.gql. Si quieres obtener todas las películas, usa una consulta como esta.

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

# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
  }
}

Ejecuta la consulta con el botón CodeLens cercano.

Una función muy interesante aquí es la capacidad de tratar las relaciones de la base de datos como un gráfico. Dado que un registro MovieMetadata tiene un campo movie que hace referencia a una película, puedes anidar en el campo y obtener información sobre la película. Intenta agregar el tipo generado movieMetadata_on_movie a la consulta ListMovies.

query ListMovies @auth(level: PUBLIC) {
  movies {
    id
    title
    imageUrl
    genre
    movieMetadata_on_movie {
        rating
    }
  }
}

Obtén más información sobre las consultas de Data Connect en la documentación

Genera SDKs y úsalo en tu app

En el panel izquierdo del IDE, haz clic en el ícono de Firebase para abrir la IU de la extensión de VS Code de Data Connect:

  1. Haz clic en el botón Add SDK to app.

  2. En el diálogo que aparece, selecciona un directorio que contenga código para tu app. Se generará y guardará allí el código del SDK de Data Connect.

  3. Selecciona la plataforma de tu app y, luego, ten en cuenta que el código del SDK se genera de inmediato en el directorio que seleccionaste.

Usa los SDKs para llamar a tu consulta desde una app

Puedes usar el SDK que generó Data Connect para implementar una llamada a tu consulta ListMovies. Luego, puedes ejecutar esta consulta de forma local con el emulador Data Connect.

Web Swift Kotlin para Android Flutter
  1. Agrega Firebase a tu app web.

  2. En el archivo principal de tu app de React, haz lo siguiente:

    • Importa el SDK generado
    • instrumenta tu app para conectarte al emulador de Data Connect
    • Llama a los métodos Data Connect.

    Puedes copiar el siguiente fragmento y ejecutarlo como una app independiente.

    import React from 'react';
import ReactDOM from 'react-dom/client';

import { connectDataConnectEmulator } from 'firebase/data-connect';

// Generated queries.
// Update as needed with the path to your generated SDK.
import { listMovies, ListMoviesData } from '@movie-app/movies';

const dataConnect = getDataConnect(connectorConfig);
connectDataConnectEmulator(dataConnect, 'localhost', 9399);

function App() {
  const [movies, setMovies] = useState<ListMoviesData['movies']>([]);
  useEffect(() => {
    listMovies.then(res => setMovies(res.data));
  }, []);
  return (
    movies.map(movie => <h1>{movie.title}</h1>);
  );
}

const root = ReactDOM.createRoot(document.getElementById('root'));
root.render(<App />);
  1. Agrega Firebase a tu app para iOS.

  2. Para usar el SDK generado, configúralo como una dependencia en Xcode.

    En la barra de navegación superior de Xcode, selecciona File > Add Package Dependencies > Add Local y elige la carpeta que contiene el Package.swift generado.

  3. En el delegado principal de tu app, haz lo siguiente:

    • Importa el SDK generado
    • instrumenta tu app para conectarte al emulador de Data Connect
    • Llama a los métodos Data Connect.

    Puedes copiar el siguiente fragmento y ejecutarlo como una app independiente.

    import SwiftUI

import FirebaseDataConnect
// Generated queries.
// Update as needed with the package name of your generated SDK.
import <CONNECTOR-PACKAGE-NAME>

let connector = DataConnect.moviesConnector

// Connect to the emulator on "127.0.0.1:9399"
connector.useEmulator()

// (alternatively) if you're running your emulator on non-default port:
// connector.useEmulator(port: 9999)

struct ListMovieView: View {
@StateObject private var queryRef = connector.listMovies.ref()

    var body: some View {
        VStack {
            Button {
                Task {
                    do {
                        try await refresh()
                    } catch {
                        print("Failed to refresh: \(error)")
                    }
                }
            } label: {
                Text("Refresh")
            }

            // use the query results in a view
            ForEach(queryRef.data?.movies ?? [], id: \.self.id) { movie in
                    Text(movie.title)
                }
            }
    }
    @MainActor
    func refresh() async throws {
        _ = try await queryRef.execute()
    }

    struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ListMovieView()
    }
}
  1. Agrega Firebase a tu app para Android.

  2. Para usar el SDK generado, configura Data Connect como una dependencia en Gradle.

    Actualiza plugins y dependencies en tu app/build.gradle.kts.

    plugins {
  // Use whichever versions of these dependencies suit your application.
  // The versions shown here were the latest as of December 03, 2024.
  // Note, however, that the version of kotlin("plugin.serialization") must,
  // in general, match the version of kotlin("android").
  id("com.android.application") version "8.7.3"
  id("com.google.gms.google-services") version "4.4.2"
  val kotlinVersion = "2.1.0"
  kotlin("android") version kotlinVersion
  kotlin("plugin.serialization") version kotlinVersion
}

dependencies {
  // Use whichever versions of these dependencies suit your application.
  // The versions shown here were the latest versions as of December 03, 2024.
  implementation("com.google.firebase:firebase-dataconnect:16.0.0-beta03")
  implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.9.0")
  implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.7.3")

  // These dependencies are not strictly required, but will very likely be used
  // when writing modern Android applications.
  implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0")
  implementation("androidx.appcompat:appcompat:1.7.0")
  implementation("androidx.activity:activity-ktx:1.9.3")
  implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.8.7")
  implementation("com.google.android.material:material:1.12.0")
}

  3. En la actividad principal de tu app, haz lo siguiente:

    • Importa el SDK generado
    • instrumenta tu app para conectarte al emulador de Data Connect
    • Llama a los métodos Data Connect.

    Puedes copiar el siguiente fragmento y ejecutarlo como una app independiente.

    import android.os.Bundle
import android.widget.TextView
import androidx.appcompat.app.AppCompatActivity
import androidx.lifecycle.Lifecycle
import androidx.lifecycle.lifecycleScope
import androidx.lifecycle.repeatOnLifecycle
import kotlinx.coroutines.launch


private val connector = com.myapplication.MoviesConnector.instance
  .apply {
    // Connect to the emulator on "10.0.2.2:9399" (default port)
    dataConnect.useEmulator()

    // (alternatively) if you're running your emulator on non-default port:
    // dataConnect.useEmulator(port = 9999)
  }


class MainActivity : AppCompatActivity() {

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    val textView: TextView = findViewById(R.id.text_view)

    lifecycleScope.launch {
      lifecycle.repeatOnLifecycle(Lifecycle.State.STARTED) {
        
        val result = connector.listMovies.runCatching { execute { } }
        
        val newTextViewText = result.fold(
          onSuccess = {
            val titles = it.data.movies.map { it.title }
            "${titles.size} movies: " + titles.joinToString(", ")
          },
          onFailure = { "ERROR: ${it.message}" }
        )
        textView.text = newTextViewText
      }
    }
  }
}
  1. Agrega Firebase a tu app de Flutter.
  2. Instala la CLI de flutterfire dart pub global activate flutterfire_cli.
  3. Ejecuta flutterfire configure.

  4. En la función principal de tu app, haz lo siguiente:

    • Importa el SDK generado
    • instrumenta tu app para conectarte al emulador de Data Connect
    • Llama a los métodos Data Connect.

    Puedes copiar el siguiente fragmento y ejecutarlo como una app independiente.

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';
import 'firebase_options.dart';

// Generated queries.
// Update as needed with the path to your generated SDK

import 'movies_connector/movies.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  await Firebase.initializeApp(
    options: DefaultFirebaseOptions.currentPlatform,
  );
  
  MoviesConnector.instance.dataConnect
      .useDataConnectEmulator(Uri.base.host, 443, isSecure: true);
  
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
        home: Scaffold(
            body: Column(children: [
      ConstrainedBox(
        constraints: const BoxConstraints(maxHeight: 200),
        child: FutureBuilder(
            future: MoviesConnector.instance.listMovies().execute(),
            builder: (context, snapshot) {
              if (snapshot.connectionState == ConnectionState.done) {
                return ListView.builder(
                  scrollDirection: Axis.vertical,
                  itemBuilder: (context, index) => Card(
                      child: Text(
                    snapshot.data!.data.movies[index].title,
                  )),
                  itemCount: snapshot.data!.data.movies.length,
                );
              }
              return const CircularProgressIndicator();
            }),
      )
    ])));
  }
}

Implementa tu esquema y consulta en producción

Una vez que tengas la configuración local en tu app, podrás implementar tu esquema, datos y consultas en la nube. Necesitas un proyecto del plan Blaze para configurar una instancia de Cloud SQL.

  1. Navega a la sección Data Connect de la consola de Firebase y crea una instancia de Cloud SQL de prueba gratuita.

  2. En la Terminal integrada en el IDE, ejecuta firebase init dataconnect y selecciona el ID de región o servicio que acabas de crear en la consola.

  3. Selecciona "Y" cuando se te solicite "El archivo dataconnect/dataconnect.yaml ya existe, ¿Quieres reemplazarlo?".

  4. En la ventana del IDE, en la IU de la extensión de VS Code, haz clic en el botón Deploy to production.

  5. Una vez que se implemente, ve a la consola de Firebase para verificar que el esquema, las operaciones y los datos se hayan subido a la nube. Debes poder ver el esquema y ejecutar tus operaciones en la consola. La instancia de Cloud SQL para PostgreSQL se actualizará con su esquema y datos generados y, luego, se implementará.

Próximos pasos

Revisa tu proyecto implementado y descubre más herramientas:

  • Agrega datos a tu base de datos, inspecciona y modifica tus esquemas, y supervisa tu servicio de Data Connect en la consola de Firebase.

Accede a más información en la documentación. Por ejemplo, como completaste la guía de inicio rápido, puedes hacer lo siguiente: