In questa guida rapida, scoprirai come compilare Firebase Data Connect nella tua applicazione localmente senza configurare un'istanza SQL di produzione. Imparerai a:
- Aggiungi Firebase Data Connect al tuo progetto Firebase.
- Configura un ambiente di sviluppo che includa un'estensione di Visual Studio Code per lavorare con un'istanza locale.
- Ti mostreremo come:
- Creare uno schema per un'app di film
- Definisci le query e le mutazioni che verranno utilizzate nella tua app
- Testa le query e le mutazioni con dati di esempio su un emulatore locale
- Genera SDK fortemente tipizzati e utilizzali nella tua app
- Esegui il deployment dello schema, delle query e dei dati finali nel cloud (facoltativo, con un upgrade del piano Blaze).
Scegli un flusso di sviluppo locale
Data Connect offre due modi per installare gli strumenti di sviluppo e lavorare localmente.
Prerequisiti
Per utilizzare questa guida rapida, devi avere quanto segue.
- Un progetto Firebase. Se non ne hai ancora creato uno, fallo nella console Firebase.
Configura l'ambiente di sviluppo
- Crea una nuova directory per il progetto locale.
Esegui il seguente comando nella nuova directory creata.
curl -sL https://firebase.tools/dataconnect | bashQuesto script tenta di configurare l'ambiente di sviluppo e di avviare un IDE basato su browser. Questo IDE fornisce strumenti, inclusa un'estensione VS Code precompilata, per aiutarti a gestire lo schema e a definire query e mutazioni da utilizzare nella tua applicazione, nonché a generare SDK fortemente tipizzati.
alias dataconnect='curl -sL https://firebase.tools/dataconnect | bash'Configura la directory del progetto
Per configurare il progetto locale, inizializza la directory del progetto. Nella finestra IDE, nel riquadro a sinistra, fai clic sull'icona di Firebase per aprire l'interfaccia utente dell'estensione VS Code di Data Connect:
- Fai clic sul pulsante Accedi con Google.
- Fai clic sul pulsante Collega un progetto Firebase e seleziona il progetto che hai creato in precedenza nella console.
- Fai clic sul pulsante Esegui firebase init.
Fai clic sul pulsante Avvia emulatori.
Crea uno schema
Nella directory del progetto Firebase, nel file /dataconnect/schema/schema.gql, inizia a definire uno schema GraphQL sui film.
Film
In Data Connect, i campi GraphQL vengono mappati alle colonne. Il film ha id,
title, imageUrl e genre. Data Connect riconosce i tipi di dati primitivi: String e UUID.
Copia lo snippet seguente o rimuovi il commento dalle righe corrispondenti nel 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
Copia lo snippet seguente o rimuovi il commento dalle righe corrispondenti nel 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
}
Tieni presente che il campo movie è mappato a un tipo di Movie.
Data Connect è consapevole che si tratta di un rapporto tra Movie
e MovieMetadata e gestirà questo rapporto per te.
Scopri di più sugli schemi di Data Connect nella documentazione
Aggiungere dati alle tabelle
Nel riquadro dell'editor IDE, vedrai i pulsanti CodeLens sopra i tipi GraphQL in /dataconnect/schema/schema.gql. Puoi utilizzare i pulsanti Aggiungi dati
e Esegui (locale) per aggiungere dati al database locale.
Per aggiungere record alle tabelle Movie e MovieMetadata:
- In
schema.gql, fai clic sul pulsante Aggiungi dati sopra la dichiarazione del tipoMovie.
- Nel file
Movie_insert.gqlgenerato, inserisci i dati hardcoded per i tre campi. - Fai clic sul pulsante Esegui (locale).
- Ripeti i passaggi precedenti per aggiungere un record alla tabella
MovieMetadata, fornendo iliddel film nel campomovieId, come richiesto nella mutazioneMovieMetadata_insertgenerata.
Per verificare rapidamente che i dati siano stati aggiunti:
- Torna in
schema.gqle fai clic sul pulsante Leggi dati sopra la dichiarazione di tipoMovie. - Nel file
Movie_read.gqlrisultante, fai clic sul pulsante Esegui (locale) per eseguire la query.
Scopri di più sulle mutazioni di Data Connect nella documentazione
Definire la query
Ora la parte divertente: definiamo le query di cui avrai bisogno nella tua applicazione. In qualità di sviluppatore, sei abituato a scrivere query SQL anziché query GraphQL, quindi all'inizio può sembrare un po' diverso.
Tuttavia, GraphQL è molto più conciso e sicuro dal punto di vista del tipo rispetto a SQL non elaborato. Inoltre, la nostra estensione VS Code semplifica l'esperienza di sviluppo.
Inizia a modificare il file /dataconnect/connector/queries.gql. Se vuoi recuperare tutti i film, utilizza una query come questa.
# 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
}
}
Esegui la query utilizzando il pulsante CodeLens nelle vicinanze.
Una funzionalità davvero interessante è la possibilità di trattare le relazioni del database come un grafo. Poiché un record MovieMetadata ha un campo movie
che fa riferimento a un film, puoi nidificare il campo e recuperare le informazioni su
le informazioni sul film. Prova ad aggiungere il tipo movieMetadata_on_movie generato alla query ListMovies.
query ListMovies @auth(level: PUBLIC) {
movies {
id
title
imageUrl
genre
movieMetadata_on_movie {
rating
}
}
}
Scopri di più sulle query Data Connect nella documentazione
Genera SDK e utilizzali nella tua app
Nel riquadro a sinistra dell'IDE, fai clic sull'icona di Firebase per aprire l'interfaccia utente dell'estensione Data Connect di VS Code:
- Fai clic sul pulsante Aggiungi SDK all'app.
Nella finestra di dialogo visualizzata, seleziona una directory contenente il codice per la tua app. Il codice dell'SDK Data Connect verrà generato e salvato lì.
Seleziona la piattaforma della tua app, quindi tieni presente che il codice SDK viene generato immediatamente nella directory selezionata.
Scopri come utilizzare l'SDK generato per chiamare query e mutazioni dalle app client (web, Android, iOS, Flutter).
Esegui il deployment dello schema e della query in produzione
Una volta completata la configurazione locale nell'app, puoi eseguire il deployment di schema, dati e query nel cloud. Per configurare un'istanza Cloud SQL, devi avere un progetto con piano Blaze.
Vai alla sezione Data Connect della console Firebase e crea un'istanza Cloud SQL di prova senza costi.
Nel terminale integrato dell'IDE, esegui
firebase init dataconnecte seleziona l'ID regione/servizio che hai appena creato nella console.Seleziona "Y" quando viene visualizzato il messaggio "Il file dataconnect/dataconnect.yaml esiste già. Vuoi sovrascriverlo?".
Nella finestra dell'IDE, nell'interfaccia utente dell'estensione VS Code, fai clic sul pulsante Esegui il deployment in produzione.
Una volta eseguito il deployment, vai alla console Firebase per verificare che lo schema, le operazioni e i dati siano stati caricati sul cloud. Dovresti essere in grado di visualizzare lo schema ed eseguire le operazioni anche sulla console. L'istanza Cloud SQL per PostgreSQL verrà aggiornata con lo schema e i dati generati di cui è stato eseguito il deployment finale.
Passaggi successivi
Esamina il progetto di cui è stato eseguito il deployment e scopri altri strumenti:
- Aggiungi dati al database, controlla e modifica gli schemi e monitora il servizio Data Connect nella console Firebase.
Per ulteriori informazioni, consulta la documentazione. Ad esempio, poiché hai completato la guida rapida:
- Scopri di più sullo sviluppo di schemi, query e mutazioni
- Scopri come generare SDK client e chiamare query e mutazioni dal codice client per web, Android, iOS e Flutter.