Mulai menggunakan Firebase Data Connect secara lokal

Dalam panduan memulai ini, Anda akan mempelajari cara mem-build Firebase Data Connect di aplikasi secara lokal tanpa menyiapkan instance SQL produksi.

  • Tambahkan Firebase Data Connect ke project Firebase Anda.
  • Siapkan lingkungan pengembangan, termasuk ekstensi Visual Studio Code untuk digunakan dengan instance lokal.
  • Kemudian, kami akan menunjukkan cara:
    • Membuat skema untuk aplikasi film
    • Menentukan kueri dan mutasi yang akan digunakan di aplikasi Anda
    • Menguji kueri dan mutasi dengan data sampel terhadap emulator lokal
    • Membuat SDK dengan jenis yang kuat dan menggunakannya di aplikasi
    • Deploy skema, kueri, dan data akhir Anda ke cloud (Opsional, paket Blaze diperlukan).

Prasyarat

Untuk menggunakan quickstart ini, Anda memerlukan hal berikut.

Menyiapkan lingkungan pengembangan

Anda memerlukan Visual Studio Code untuk mengelola skema dan menentukan kueri yang akan digunakan dalam aplikasi Anda, dan SDK dengan jenis yang kuat akan otomatis dibuat untuk Anda:

  1. Buat direktori baru untuk project lokal Anda.
  2. Buka VS Code di direktori baru.
  3. Instal ekstensi Firebase Data Connect dari Visual Studio Code Marketplace.

Menyiapkan direktori project

Untuk menyiapkan project lokal, lakukan inisialisasi direktori project. Di panel kiri VS Code, klik ikon Firebase untuk membuka UI ekstensi Data Connect VS Code:

  1. Klik tombol Sign in with Google.
  2. Klik tombol Connect a Firebase project dan pilih project yang Anda buat sebelumnya di konsol.
  3. Klik tombol Run firebase init.

  4. Klik tombol Start emulators.

Membuat skema

Di direktori project Firebase, dalam file /dataconnect/schema/schema.gql, mulai tentukan skema GraphQL tentang film.

Film

Di Data Connect, kolom GraphQL dipetakan ke kolom. Film memiliki id, title, imageUrl, dan genre. Data Connect mengenali jenis data primitif: String dan UUID.

Salin cuplikan berikut atau hapus tanda komentar pada baris yang sesuai dalam file.

# 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

Salin cuplikan berikut atau hapus tanda komentar pada baris yang sesuai dalam file.

# 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
}

Perhatikan bahwa kolom movie dipetakan ke jenis Movie. Data Connect memahami bahwa ini adalah hubungan antara Movie dan MovieMetadata dan akan mengelola hubungan ini untuk Anda.

Pelajari skema Data Connect lebih lanjut dalam dokumentasi

Menambahkan data ke tabel

Di panel editor VS Code, Anda akan melihat tombol CodeLens muncul di atas jenis GraphQL di /dataconnect/schema/schema.gql. Anda dapat menggunakan tombol Tambahkan data dan Jalankan (Lokal) untuk menambahkan data ke database lokal.

Untuk menambahkan kumpulan data ke tabel Movie dan MovieMetadata:

  1. Di schema.gql, klik tombol Tambahkan data di atas deklarasi jenis Movie.
    Tombol Tambahkan data Lensa Kode untuk Firebase Data Connect
  2. Dalam file Movie_insert.gql yang dihasilkan, hard code data untuk tiga kolom.
  3. Klik tombol Run (Local).
    Tombol Run Lensa Kode untuk Firebase Data Connect
  4. Ulangi langkah sebelumnya untuk menambahkan data ke tabel MovieMetadata, dengan menyediakan id Film Anda di kolom movieId, seperti yang diminta dalam mutasi MovieMetadata_insert yang dihasilkan.

Untuk memverifikasi bahwa data telah ditambahkan dengan cepat:

  1. Kembali ke schema.gql, klik tombol Baca data di atas deklarasi jenis Movie.
  2. Pada file Movie_read.gql yang dihasilkan, klik tombol Run (Local) untuk menjalankan kueri.

Pelajari mutasi Data Connect lebih lanjut dalam dokumentasi

Menentukan kueri

Sekarang bagian yang menyenangkan: mari kita tentukan kueri yang akan Anda perlukan dalam aplikasi. Sebagai developer, Anda terbiasa menulis kueri SQL, bukan kueri GraphQL, sehingga hal ini mungkin terasa sedikit berbeda pada awalnya. Namun, GraphQL jauh lebih ringkas dan aman dari jenis daripada SQL mentah. Selain itu, ekstensi VS Code kami akan memudahkan pengalaman pengembangan.

Mulai edit file /dataconnect/connector/queries.gql. Jika Anda ingin mendapatkan semua film, gunakan kueri seperti ini.

# 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
  }
}

Jalankan kueri menggunakan tombol CodeLens di dekatnya.

Fitur yang sangat menarik di sini adalah kemampuan untuk memperlakukan hubungan database seperti grafik. Karena MovieMetadata memiliki kolom movie yang mereferensikan film, Anda dapat menyusun bertingkat ke dalam kolom dan mendapatkan informasi tentang info film kembali. Coba tambahkan jenis movieMetadata_on_movie yang dihasilkan ke kueri ListMovies.

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

Pelajari kueri Data Connect lebih lanjut dalam dokumentasi

Membuat SDK dan menggunakannya di aplikasi

Di panel sebelah kiri VS Code, klik ikon Firebase untuk membuka UI ekstensi VS Code Data Connect:

  1. Klik tombol Tambahkan SDK ke aplikasi.

  2. Pada dialog yang muncul, pilih direktori yang berisi kode untuk aplikasi Anda. Data Connect. Kode SDK akan dibuat dan disimpan di sana.

  3. Pilih platform aplikasi Anda, lalu perhatikan bahwa kode SDK akan langsung dibuat di direktori yang Anda pilih.

Pelajari cara menggunakan SDK yang dihasilkan untuk memanggil kueri dan mutasi dari aplikasi klien (web, Android, iOS, Flutter).

Men-deploy skema dan kueri ke produksi

Setelah menyiapkan aplikasi secara lokal, sekarang Anda dapat men-deploy skema, data, dan kueri ke cloud. Anda memerlukan paket Blaze untuk menyiapkan instance Cloud SQL.

  1. Buka bagian Data Connect di konsol Firebase dan buat instance Cloud SQL uji coba gratis.

  2. Di Terminal terintegrasi VS Code, jalankan firebase init dataconnect dan pilih Region/Service ID yang baru saja Anda buat di konsol.

  3. Pilih "Y" saat diminta dengan "File dataconnect/dataconnect.yaml sudah ada, Ganti?".

  4. Di UI Ekstensi VS Code Data Connect, klik tombol Deploy to production.

  5. Setelah di-deploy, buka konsol Firebase untuk memverifikasi bahwa skema, operasi, dan data telah diupload ke cloud. Anda akan dapat melihat skema, dan menjalankan operasi di konsol juga. Instance Cloud SQL untuk PostgreSQL akan diperbarui dengan skema dan data akhir yang dihasilkan dan di-deploy.

Langkah berikutnya

Tinjau project yang di-deploy dan temukan alat lainnya:

  • Tambahkan data ke database, periksa dan ubah skema, serta pantau layanan Data Connect di Firebase console.

Akses informasi selengkapnya dalam dokumentasi. Misalnya, karena Anda telah menyelesaikan panduan memulai: