Este início rápido mostra como configurar o Cloud Firestore, adicionar dados e visualizar os dados que você acabou de adicionar no Firebase console.
Criar um banco de dados do Cloud Firestore
Crie um projeto do Firebase, caso ainda não o tenha feito: no console do Firebase , clique em Adicionar projeto e siga as instruções na tela para criar um projeto do Firebase ou adicionar serviços do Firebase a um projeto GCP existente.
Navegue até a seção Cloud Firestore do console do Firebase . Você será solicitado a selecionar um projeto existente do Firebase. Siga o fluxo de trabalho de criação do banco de dados.
Selecione um modo inicial para suas regras de segurança do Cloud Firestore:
- Modo de teste
Bom para começar com as bibliotecas de clientes móveis e da web, mas permite que qualquer pessoa leia e sobrescreva seus dados. Após o teste, certifique-se de revisar a seção Proteja seus dados .
Para começar com a web, plataformas Apple ou Android SDK, selecione o modo de teste.
- modo bloqueado
Nega todas as leituras e gravações de clientes móveis e da web. Seus servidores de aplicativos autenticados (C#, Go, Java, Node.js, PHP, Python ou Ruby) ainda podem acessar seu banco de dados.
Para começar a usar a biblioteca cliente do servidor C#, Go, Java, Node.js, PHP, Python ou Ruby, selecione o modo bloqueado.
Selecione um local para seu banco de dados.
Essa configuração de local é o local de recurso padrão do Google Cloud Platform (GCP) do seu projeto. Observe que esse local será usado para serviços do GCP em seu projeto que exigem uma configuração de local, especificamente, seu intervalo padrão do Cloud Storage e seu aplicativo do App Engine (o que é necessário se você usar o Cloud Scheduler).
Se você não conseguir selecionar um local, seu projeto já tem um local de recurso padrão do GCP. Foi definido durante a criação do projeto ou ao configurar outro serviço que requer uma configuração de localização.
Clique em Concluído .
Quando você ativa o Cloud Firestore, ele também ativa a API no Cloud API Manager .
Configure seu ambiente de desenvolvimento
Adicione as dependências necessárias e as bibliotecas de cliente ao seu aplicativo.
Web version 8
- Siga as instruções para adicionar o Firebase ao seu aplicativo da Web .
- Adicione as bibliotecas Firebase e Cloud Firestore ao seu aplicativo:
<script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-app.js"></script> <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-firestore.js"></script>
O Cloud Firestore SDK também está disponível como um pacote npm.npm install firebase@8.10.1 --save
Você precisará exigir manualmente o Firebase e o Cloud Firestore.const firebase = require("firebase"); // Required for side-effects require("firebase/firestore");
Web version 9
- Siga as instruções para adicionar o Firebase ao seu aplicativo da Web .
- O Cloud Firestore SDK está disponível como um pacote npm.
npm install firebase@9.17.1 --save
Você precisará importar o Firebase e o Cloud Firestore.import { initializeApp } from "firebase/app"; import { getFirestore } from "firebase/firestore";
iOS+
Siga as instruções para adicionar o Firebase ao seu aplicativo Apple .
Use o Swift Package Manager para instalar e gerenciar dependências do Firebase.
- No Xcode, com seu projeto de aplicativo aberto, navegue até File > Swift Packages > Add Package Dependency .
- Quando solicitado, adicione o repositório Firebase Apple Platform SDK:
- Escolha a biblioteca do Firestore.
- Quando terminar, o Xcode começará automaticamente a resolver e baixar suas dependências em segundo plano.
https://github.com/firebase/firebase-ios-sdk
Kotlin+KTX
- Siga as instruções para adicionar o Firebase ao seu aplicativo Android .
- Usando o Firebase Android BoM , declare a dependência da biblioteca Cloud Firestore Android no arquivo Gradle do módulo (nível do aplicativo) (geralmente
app/build.gradle
).dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:31.2.0') // Declare the dependency for the Cloud Firestore library // When using the BoM, you don't specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-firestore-ktx' }
Ao usar o Firebase Android BoM , seu aplicativo sempre usará versões compatíveis das bibliotecas do Firebase Android.
(Alternativa) Declarar dependências da biblioteca Firebase sem usar o BoM
Se você optar por não usar o Firebase BoM, deverá especificar cada versão da biblioteca Firebase em sua linha de dependência.
Observe que, se você usar várias bibliotecas do Firebase em seu aplicativo, é altamente recomendável usar o BoM para gerenciar as versões da biblioteca, o que garante que todas as versões sejam compatíveis.
dependencies { // Declare the dependency for the Cloud Firestore library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-firestore-ktx:24.4.2' }
Java
- Siga as instruções para adicionar o Firebase ao seu aplicativo Android .
- Usando o Firebase Android BoM , declare a dependência da biblioteca Cloud Firestore Android no arquivo Gradle do módulo (nível do aplicativo) (geralmente
app/build.gradle
).dependencies { // Import the BoM for the Firebase platform implementation platform('com.google.firebase:firebase-bom:31.2.0') // Declare the dependency for the Cloud Firestore library // When using the BoM, you don't specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-firestore' }
Ao usar o Firebase Android BoM , seu aplicativo sempre usará versões compatíveis das bibliotecas do Firebase Android.
(Alternativa) Declarar dependências da biblioteca Firebase sem usar o BoM
Se você optar por não usar o Firebase BoM, deverá especificar cada versão da biblioteca Firebase em sua linha de dependência.
Observe que, se você usar várias bibliotecas do Firebase em seu aplicativo, é altamente recomendável usar o BoM para gerenciar as versões da biblioteca, o que garante que todas as versões sejam compatíveis.
dependencies { // Declare the dependency for the Cloud Firestore library // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation 'com.google.firebase:firebase-firestore:24.4.2' }
Dart
- Se ainda não o fez, configure e inicialize o Firebase em seu aplicativo Flutter.
- Na raiz do seu projeto Flutter, execute o seguinte comando para instalar o plug-in:
flutter pub add cloud_firestore
- Depois de concluído, reconstrua seu aplicativo Flutter:
flutter run
- Opcional: melhore os tempos de compilação do iOS e macOS incluindo a estrutura pré-compilada.
Atualmente, o SDK do Firestore para iOS depende de um código que pode levar mais de 5 minutos para ser criado no Xcode. Para reduzir significativamente os tempos de compilação, você pode usar uma versão pré-compilada adicionando esta linha ao bloco
target 'Runner' do
em seu Podfile:target 'Runner' do pod 'FirebaseFirestore', :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git', :tag => '8.15.0' # ... end
Além disso, certifique-se de ter atualizado o CocoaPods para 1.9.1 ou superior:
gem install cocoapods
Para obter mais informações, consulte o problema no GitHub .
Java
- Adicione o Firebase Admin SDK ao seu aplicativo:
- Usando Gradle:
compile 'com.google.firebase:firebase-admin:1.32.0'
- Usando Maven:
<dependency> <groupId>com.google.firebase</groupId> <artifactId>firebase-admin</artifactId> <version>1.32.0</version> </dependency>
- Usando Gradle:
- Siga as instruções abaixo para inicializar o Cloud Firestore com as credenciais adequadas em seu ambiente.
Pitão
- Adicione o Firebase Admin SDK ao seu aplicativo Python:
pip install --upgrade firebase-admin
- Siga as instruções abaixo para inicializar o Cloud Firestore com as credenciais adequadas em seu ambiente.
C++
- Siga as instruções para adicionar o Firebase ao seu projeto C++ .
- Interface C++ para Android.
- Dependências Gradle. Adicione o seguinte ao arquivo Gradle do módulo (nível de aplicativo) (geralmente
app/build.gradle
):android.defaultConfig.externalNativeBuild.cmake { arguments "-DFIREBASE_CPP_SDK_DIR=$gradle.firebase_cpp_sdk_dir" } apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle" firebaseCpp.dependencies { // earlier entries auth firestore }
- Dependências binárias. Da mesma forma, a maneira recomendada de obter as dependências binárias é adicionar o seguinte ao arquivo
CMakeLists.txt
:add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL) set(firebase_libs firebase_auth firebase_firestore firebase_app) # Replace the target name below with the actual name of your target, # for example, "native-lib". target_link_libraries(${YOUR_TARGET_NAME_HERE} "${firebase_libs}")
- Para configurar a integração da área de trabalho, consulte Adicionar Firebase ao seu projeto C++ .
Unidade
- Siga as instruções para adicionar o Firebase ao seu projeto Unity .
- Interface Unity para Android.
- Selecione Arquivo > Configurações de compilação
- Alterne 'Plataforma' para 'Android' e clique em 'Alternar plataforma'
- Clique em 'Configurações do jogador…'
- Na IU principal do Unity, em 'Configurações para Android', selecione 'Configurações de publicação'
- Na seção 'Minify', altere as configurações de Release e Debug de 'None' para 'ProGuard'
Ao compilar para Android, habilite o ProGuarding para evitar o limite Android DEX. Para fazer isso, no editor do Unity:
Node.js
- Adicione o Firebase Admin SDK ao seu aplicativo:
npm install firebase-admin --save
- Siga as instruções abaixo para inicializar o Cloud Firestore com as credenciais adequadas em seu ambiente.
Vai
- Adicione o Firebase Admin SDK ao seu aplicativo Go:
go get firebase.google.com/go
- Siga as instruções abaixo para inicializar o Cloud Firestore com as credenciais adequadas em seu ambiente.
PHP
- As bibliotecas de cliente do servidor Cloud Firestore (Java, Node.js, Python, Go, PHP, C# e Ruby) usam o Google Application Default Credentials para autenticação.
- Para autenticar em seu ambiente de desenvolvimento, defina a variável de ambiente
GOOGLE_APPLICATION_CREDENTIALS
para apontar para um arquivo de chave de conta de serviço JSON. Você pode criar um arquivo de chave na página Credenciais do API Console .export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/keyfile.json"
- Em seu ambiente de produção, você não precisa se autenticar se executar seu aplicativo no App Engine ou no Compute Engine, usando o mesmo projeto usado para o Cloud Firestore. Caso contrário, configure uma conta de serviço .
- Para autenticar em seu ambiente de desenvolvimento, defina a variável de ambiente
- Instale e habilite a extensão gRPC para PHP, que você precisará para usar a biblioteca cliente.
- Adicione a biblioteca PHP do Cloud Firestore ao seu aplicativo:
composer require google/cloud-firestore
C #
- As bibliotecas de cliente do servidor Cloud Firestore (Java, Node.js, Python, Go, PHP, C# e Ruby) usam o Google Application Default Credentials para autenticação.
- Para autenticar em seu ambiente de desenvolvimento, defina a variável de ambiente
GOOGLE_APPLICATION_CREDENTIALS
para apontar para um arquivo de chave de conta de serviço JSON. Você pode criar um arquivo de chave na página Credenciais do API Console .export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/keyfile.json"
- Em seu ambiente de produção, você não precisa se autenticar se executar seu aplicativo no App Engine ou no Compute Engine, usando o mesmo projeto usado para o Cloud Firestore. Caso contrário, configure uma conta de serviço .
- Para autenticar em seu ambiente de desenvolvimento, defina a variável de ambiente
- Adicione a biblioteca Cloud Firestore C# ao seu aplicativo em seu arquivo
.csproj
:<ItemGroup> <PackageReference Include="Google.Cloud.Firestore" Version="1.1.0-beta01" /> </ItemGroup>
- Adicione o seguinte ao seu arquivo
Program.cs
:using Google.Cloud.Firestore;
Rubi
- As bibliotecas de cliente do servidor Cloud Firestore (Java, Node.js, Python, Go, PHP, C# e Ruby) usam o Google Application Default Credentials para autenticação.
- Para autenticar em seu ambiente de desenvolvimento, defina a variável de ambiente
GOOGLE_APPLICATION_CREDENTIALS
para apontar para um arquivo de chave de conta de serviço JSON. Você pode criar um arquivo de chave na página Credenciais do API Console .export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/keyfile.json"
- Em seu ambiente de produção, você não precisa se autenticar se executar seu aplicativo no App Engine ou no Compute Engine, usando o mesmo projeto usado para o Cloud Firestore. Caso contrário, configure uma conta de serviço .
- Para autenticar em seu ambiente de desenvolvimento, defina a variável de ambiente
- Adicione a biblioteca Cloud Firestore Ruby ao seu aplicativo em seu
Gemfile
:gem "google-cloud-firestore"
- Instale as dependências do seu
Gemfile
usando:bundle install
(Opcional) Protótipo e teste com Firebase Local Emulator Suite
Para desenvolvedores móveis, antes de falar sobre como seu aplicativo grava e lê do Cloud Firestore, vamos apresentar um conjunto de ferramentas que você pode usar para prototipar e testar a funcionalidade do Cloud Firestore: Firebase Local Emulator Suite. Se você está experimentando diferentes modelos de dados, otimizando suas regras de segurança ou trabalhando para encontrar a maneira mais econômica de interagir com o back-end, poder trabalhar localmente sem implantar serviços ao vivo pode ser uma ótima ideia.
Um emulador do Cloud Firestore faz parte do Local Emulator Suite, que permite que seu aplicativo interaja com o conteúdo e a configuração do banco de dados emulado, bem como, opcionalmente, com os recursos do projeto emulado (funções, outros bancos de dados e regras de segurança).
Usar o emulador Cloud Firestore envolve apenas algumas etapas:
- Adicionando uma linha de código à configuração de teste do seu aplicativo para se conectar ao emulador.
- Na raiz do diretório local do projeto, execute
firebase emulators:start
. - Faça chamadas a partir do código do protótipo do seu aplicativo usando um SDK da plataforma Cloud Firestore como de costume.
Um passo a passo detalhado envolvendo Cloud Firestore e Cloud Functions está disponível. Você também deve dar uma olhada na introdução do Local Emulator Suite .
Inicializar Cloud Firestore
Inicialize uma instância do Cloud Firestore:
Web version 9
import { initializeApp } from "firebase/app"; import { getFirestore } from "firebase/firestore"; // TODO: Replace the following with your app's Firebase project configuration // See: https://support.google.com/firebase/answer/7015592 const firebaseConfig = { FIREBASE_CONFIGURATION }; // Initialize Firebase const app = initializeApp(firebaseConfig); // Initialize Cloud Firestore and get a reference to the service const db = getFirestore(app);
Substitua FIREBASE_CONFIGURATION pelo firebaseConfig
do seu aplicativo da web.
Para manter os dados quando o dispositivo perder a conexão, consulte a documentação Ativar dados offline .
Web version 8
import firebase from "firebase/app"; import "firebase/firestore"; // TODO: Replace the following with your app's Firebase project configuration // See: https://support.google.com/firebase/answer/7015592 const firebaseConfig = { FIREBASE_CONFIGURATION }; // Initialize Firebase firebase.initializeApp(firebaseConfig); // Initialize Cloud Firestore and get a reference to the service const db = firebase.firestore();
Substitua FIREBASE_CONFIGURATION pelo firebaseConfig
do seu aplicativo da web.
Para manter os dados quando o dispositivo perder a conexão, consulte a documentação Ativar dados offline .
Rápido
import FirebaseCore import FirebaseFirestore
FirebaseApp.configure() let db = Firestore.firestore()
Objective-C
@import FirebaseCore; @import FirebaseFirestore; // Use Firebase library to configure APIs [FIRApp configure];
FIRFirestore *defaultFirestore = [FIRFirestore firestore];
Kotlin+KTX
// Access a Cloud Firestore instance from your Activity
val db = Firebase.firestore
Java
// Access a Cloud Firestore instance from your Activity
FirebaseFirestore db = FirebaseFirestore.getInstance();
Dart
db = FirebaseFirestore.instance;
Java
O Cloud Firestore SDK é inicializado de maneiras diferentes, dependendo do seu ambiente. Abaixo estão os métodos mais comuns. Para obter uma referência completa, consulte Inicializar o Admin SDK .import com.google.auth.oauth2.GoogleCredentials; import com.google.cloud.firestore.Firestore; import com.google.firebase.FirebaseApp; import com.google.firebase.FirebaseOptions; // Use the application default credentials GoogleCredentials credentials = GoogleCredentials.getApplicationDefault(); FirebaseOptions options = new FirebaseOptions.Builder() .setCredentials(credentials) .setProjectId(projectId) .build(); FirebaseApp.initializeApp(options); Firestore db = FirestoreClient.getFirestore();
Para usar o Firebase Admin SDK em seu próprio servidor, use uma conta de serviço .
Acesse IAM e administrador > Contas de serviço no console do Google Cloud. Gere uma nova chave privada e salve o arquivo JSON. Em seguida, use o arquivo para inicializar o SDK:
import com.google.auth.oauth2.GoogleCredentials; import com.google.cloud.firestore.Firestore; import com.google.firebase.FirebaseApp; import com.google.firebase.FirebaseOptions; // Use a service account InputStream serviceAccount = new FileInputStream("path/to/serviceAccount.json"); GoogleCredentials credentials = GoogleCredentials.fromStream(serviceAccount); FirebaseOptions options = new FirebaseOptions.Builder() .setCredentials(credentials) .build(); FirebaseApp.initializeApp(options); Firestore db = FirestoreClient.getFirestore();
Pitão
O Cloud Firestore SDK é inicializado de maneiras diferentes, dependendo do seu ambiente. Abaixo estão os métodos mais comuns. Para obter uma referência completa, consulte Inicializar o Admin SDK .import firebase_admin from firebase_admin import firestore # Application Default credentials are automatically created. app = firebase_admin.initialize_app() db = firestore.client()
Uma credencial padrão de aplicativo existente também pode ser usada para inicializar o SDK.
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore # Use the application default credentials. cred = credentials.ApplicationDefault() firebase_admin.initialize_app(cred) db = firestore.client()
Para usar o Firebase Admin SDK em seu próprio servidor, use uma conta de serviço .
Acesse IAM e administrador > Contas de serviço no console do Google Cloud. Gere uma nova chave privada e salve o arquivo JSON. Em seguida, use o arquivo para inicializar o SDK:
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore # Use a service account. cred = credentials.Certificate('path/to/serviceAccount.json') app = firebase_admin.initialize_app(cred) db = firestore.client()
Python
O Cloud Firestore SDK é inicializado de maneiras diferentes, dependendo do seu ambiente. Abaixo estão os métodos mais comuns. Para obter uma referência completa, consulte Inicializar o Admin SDK .import firebase_admin from firebase_admin import firestore_async # Application Default credentials are automatically created. app = firebase_admin.initialize_app() db = firestore_async.client()
Uma credencial padrão de aplicativo existente também pode ser usada para inicializar o SDK.
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore_async # Use the application default credentials. cred = credentials.ApplicationDefault() firebase_admin.initialize_app(cred) db = firestore_async.client()
Para usar o Firebase Admin SDK em seu próprio servidor, use uma conta de serviço .
Acesse IAM e administrador > Contas de serviço no console do Google Cloud. Gere uma nova chave privada e salve o arquivo JSON. Em seguida, use o arquivo para inicializar o SDK:
import firebase_admin from firebase_admin import credentials from firebase_admin import firestore_async # Use a service account. cred = credentials.Certificate('path/to/serviceAccount.json') app = firebase_admin.initialize_app(cred) db = firestore_async.client()
C++
// Make sure the call to `Create()` happens some time before you call Firestore::GetInstance(). App::Create(); Firestore* db = Firestore::GetInstance();
Node.js
O Cloud Firestore SDK é inicializado de maneiras diferentes, dependendo do seu ambiente. Abaixo estão os métodos mais comuns. Para obter uma referência completa, consulte Inicializar o Admin SDK .- Inicializar no Cloud Functions
const { initializeApp, applicationDefault, cert } = require('firebase-admin/app'); const { getFirestore, Timestamp, FieldValue } = require('firebase-admin/firestore');
initializeApp(); const db = getFirestore();
- Inicializar no Google Cloud
const { initializeApp, applicationDefault, cert } = require('firebase-admin/app'); const { getFirestore, Timestamp, FieldValue } = require('firebase-admin/firestore');
initializeApp({ credential: applicationDefault() }); const db = getFirestore();
- Inicializar em seu próprio servidor
Para usar o Firebase Admin SDK em seu próprio servidor (ou qualquer outro ambiente Node.js), use uma conta de serviço . Acesse IAM e administrador > Contas de serviço no console do Google Cloud. Gere uma nova chave privada e salve o arquivo JSON. Em seguida, use o arquivo para inicializar o SDK:
const { initializeApp, applicationDefault, cert } = require('firebase-admin/app'); const { getFirestore, Timestamp, FieldValue } = require('firebase-admin/firestore');
const serviceAccount = require('./path/to/serviceAccountKey.json'); initializeApp({ credential: cert(serviceAccount) }); const db = getFirestore();
Vai
O Cloud Firestore SDK é inicializado de maneiras diferentes, dependendo do seu ambiente. Abaixo estão os métodos mais comuns. Para obter uma referência completa, consulte Inicializar o Admin SDK .import ( "log" firebase "firebase.google.com/go" "google.golang.org/api/option" ) // Use the application default credentials ctx := context.Background() conf := &firebase.Config{ProjectID: projectID} app, err := firebase.NewApp(ctx, conf) if err != nil { log.Fatalln(err) } client, err := app.Firestore(ctx) if err != nil { log.Fatalln(err) } defer client.Close()
Para usar o Firebase Admin SDK em seu próprio servidor, use uma conta de serviço .
Acesse IAM e administrador > Contas de serviço no console do Google Cloud. Gere uma nova chave privada e salve o arquivo JSON. Em seguida, use o arquivo para inicializar o SDK:
import ( "log" firebase "firebase.google.com/go" "google.golang.org/api/option" ) // Use a service account ctx := context.Background() sa := option.WithCredentialsFile("path/to/serviceAccount.json") app, err := firebase.NewApp(ctx, nil, sa) if err != nil { log.Fatalln(err) } client, err := app.Firestore(ctx) if err != nil { log.Fatalln(err) } defer client.Close()
PHP
PHP
Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .
Unidade
using Firebase.Firestore; using Firebase.Extensions;
FirebaseFirestore db = FirebaseFirestore.DefaultInstance;
C #
C #
Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .
Rubi
Adicionar dados
O Cloud Firestore armazena dados em Documentos, que são armazenados em Coleções. O Cloud Firestore cria coleções e documentos implicitamente na primeira vez que você adiciona dados ao documento. Você não precisa criar coleções ou documentos explicitamente.
Crie uma nova coleção e um documento usando o código de exemplo a seguir.
Web version 9
import { collection, addDoc } from "firebase/firestore"; try { const docRef = await addDoc(collection(db, "users"), { first: "Ada", last: "Lovelace", born: 1815 }); console.log("Document written with ID: ", docRef.id); } catch (e) { console.error("Error adding document: ", e); }
Web version 8
db.collection("users").add({ first: "Ada", last: "Lovelace", born: 1815 }) .then((docRef) => { console.log("Document written with ID: ", docRef.id); }) .catch((error) => { console.error("Error adding document: ", error); });
Rápido
// Add a new document with a generated ID var ref: DocumentReference? = nil ref = db.collection("users").addDocument(data: [ "first": "Ada", "last": "Lovelace", "born": 1815 ]) { err in if let err = err { print("Error adding document: \(err)") } else { print("Document added with ID: \(ref!.documentID)") } }
Objective-C
// Add a new document with a generated ID __block FIRDocumentReference *ref = [[self.db collectionWithPath:@"users"] addDocumentWithData:@{ @"first": @"Ada", @"last": @"Lovelace", @"born": @1815 } completion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error adding document: %@", error); } else { NSLog(@"Document added with ID: %@", ref.documentID); } }];
Kotlin+KTX
// Create a new user with a first and last name val user = hashMapOf( "first" to "Ada", "last" to "Lovelace", "born" to 1815 ) // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener { documentReference -> Log.d(TAG, "DocumentSnapshot added with ID: ${documentReference.id}") } .addOnFailureListener { e -> Log.w(TAG, "Error adding document", e) }
Java
// Create a new user with a first and last name Map<String, Object> user = new HashMap<>(); user.put("first", "Ada"); user.put("last", "Lovelace"); user.put("born", 1815); // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener(new OnSuccessListener<DocumentReference>() { @Override public void onSuccess(DocumentReference documentReference) { Log.d(TAG, "DocumentSnapshot added with ID: " + documentReference.getId()); } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "Error adding document", e); } });
Dart
// Create a new user with a first and last name final user = <String, dynamic>{ "first": "Ada", "last": "Lovelace", "born": 1815 }; // Add a new document with a generated ID db.collection("users").add(user).then((DocumentReference doc) => print('DocumentSnapshot added with ID: ${doc.id}'));
Java
Pitão
Python
C++
// Add a new document with a generated ID Future<DocumentReference> user_ref = db->Collection("users").Add({{"first", FieldValue::String("Ada")}, {"last", FieldValue::String("Lovelace")}, {"born", FieldValue::Integer(1815)}}); user_ref.OnCompletion([](const Future<DocumentReference>& future) { if (future.error() == Error::kErrorOk) { std::cout << "DocumentSnapshot added with ID: " << future.result()->id() << std::endl; } else { std::cout << "Error adding document: " << future.error_message() << std::endl; } });
Node.js
Vai
PHP
PHP
Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .
Unidade
DocumentReference docRef = db.Collection("users").Document("alovelace"); Dictionary<string, object> user = new Dictionary<string, object> { { "First", "Ada" }, { "Last", "Lovelace" }, { "Born", 1815 }, }; docRef.SetAsync(user).ContinueWithOnMainThread(task => { Debug.Log("Added data to the alovelace document in the users collection."); });
C #
Rubi
Agora adicione outro documento à coleção de users
. Observe que este documento inclui um par chave-valor (nome do meio) que não aparece no primeiro documento. Os documentos em uma coleção podem conter diferentes conjuntos de informações.
Web version 9
// Add a second document with a generated ID. import { addDoc, collection } from "firebase/firestore"; try { const docRef = await addDoc(collection(db, "users"), { first: "Alan", middle: "Mathison", last: "Turing", born: 1912 }); console.log("Document written with ID: ", docRef.id); } catch (e) { console.error("Error adding document: ", e); }
Web version 8
// Add a second document with a generated ID. db.collection("users").add({ first: "Alan", middle: "Mathison", last: "Turing", born: 1912 }) .then((docRef) => { console.log("Document written with ID: ", docRef.id); }) .catch((error) => { console.error("Error adding document: ", error); });
Rápido
// Add a second document with a generated ID. ref = db.collection("users").addDocument(data: [ "first": "Alan", "middle": "Mathison", "last": "Turing", "born": 1912 ]) { err in if let err = err { print("Error adding document: \(err)") } else { print("Document added with ID: \(ref!.documentID)") } }
Objective-C
// Add a second document with a generated ID. __block FIRDocumentReference *ref = [[self.db collectionWithPath:@"users"] addDocumentWithData:@{ @"first": @"Alan", @"middle": @"Mathison", @"last": @"Turing", @"born": @1912 } completion:^(NSError * _Nullable error) { if (error != nil) { NSLog(@"Error adding document: %@", error); } else { NSLog(@"Document added with ID: %@", ref.documentID); } }];
Kotlin+KTX
// Create a new user with a first, middle, and last name val user = hashMapOf( "first" to "Alan", "middle" to "Mathison", "last" to "Turing", "born" to 1912 ) // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener { documentReference -> Log.d(TAG, "DocumentSnapshot added with ID: ${documentReference.id}") } .addOnFailureListener { e -> Log.w(TAG, "Error adding document", e) }
Java
// Create a new user with a first, middle, and last name Map<String, Object> user = new HashMap<>(); user.put("first", "Alan"); user.put("middle", "Mathison"); user.put("last", "Turing"); user.put("born", 1912); // Add a new document with a generated ID db.collection("users") .add(user) .addOnSuccessListener(new OnSuccessListener<DocumentReference>() { @Override public void onSuccess(DocumentReference documentReference) { Log.d(TAG, "DocumentSnapshot added with ID: " + documentReference.getId()); } }) .addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception e) { Log.w(TAG, "Error adding document", e); } });
Dart
// Create a new user with a first and last name final user = <String, dynamic>{ "first": "Alan", "middle": "Mathison", "last": "Turing", "born": 1912 }; // Add a new document with a generated ID db.collection("users").add(user).then((DocumentReference doc) => print('DocumentSnapshot added with ID: ${doc.id}'));
Java
Pitão
Python
C++
db->Collection("users") .Add({{"first", FieldValue::String("Alan")}, {"middle", FieldValue::String("Mathison")}, {"last", FieldValue::String("Turing")}, {"born", FieldValue::Integer(1912)}}) .OnCompletion([](const Future<DocumentReference>& future) { if (future.error() == Error::kErrorOk) { std::cout << "DocumentSnapshot added with ID: " << future.result()->id() << std::endl; } else { std::cout << "Error adding document: " << future.error_message() << std::endl; } });
Node.js
Vai
PHP
PHP
Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .
Unidade
DocumentReference docRef = db.Collection("users").Document("aturing"); Dictionary<string, object> user = new Dictionary<string, object> { { "First", "Alan" }, { "Middle", "Mathison" }, { "Last", "Turing" }, { "Born", 1912 } }; docRef.SetAsync(user).ContinueWithOnMainThread(task => { Debug.Log("Added data to the aturing document in the users collection."); });
C #
Rubi
Ler dados
Para verificar rapidamente se você adicionou dados ao Cloud Firestore, use o visualizador de dados no Firebase console .
Você também pode usar o método "get" para recuperar a coleção inteira.
Web version 9
import { collection, getDocs } from "firebase/firestore"; const querySnapshot = await getDocs(collection(db, "users")); querySnapshot.forEach((doc) => { console.log(`${doc.id} => ${doc.data()}`); });
Web version 8
db.collection("users").get().then((querySnapshot) => { querySnapshot.forEach((doc) => { console.log(`${doc.id} => ${doc.data()}`); }); });
Rápido
db.collection("users").getDocuments() { (querySnapshot, err) in if let err = err { print("Error getting documents: \(err)") } else { for document in querySnapshot!.documents { print("\(document.documentID) => \(document.data())") } } }
Objective-C
[[self.db collectionWithPath:@"users"] getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot, NSError * _Nullable error) { if (error != nil) { NSLog(@"Error getting documents: %@", error); } else { for (FIRDocumentSnapshot *document in snapshot.documents) { NSLog(@"%@ => %@", document.documentID, document.data); } } }];
Kotlin+KTX
db.collection("users") .get() .addOnSuccessListener { result -> for (document in result) { Log.d(TAG, "${document.id} => ${document.data}") } } .addOnFailureListener { exception -> Log.w(TAG, "Error getting documents.", exception) }
Java
db.collection("users") .get() .addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() { @Override public void onComplete(@NonNull Task<QuerySnapshot> task) { if (task.isSuccessful()) { for (QueryDocumentSnapshot document : task.getResult()) { Log.d(TAG, document.getId() + " => " + document.getData()); } } else { Log.w(TAG, "Error getting documents.", task.getException()); } } });
Dart
await db.collection("users").get().then((event) { for (var doc in event.docs) { print("${doc.id} => ${doc.data()}"); } });
Java
Pitão
users_ref = db.collection(u'users') docs = users_ref.stream() for doc in docs: print(f'{doc.id} => {doc.to_dict()}')
Python
C++
Future<QuerySnapshot> users = db->Collection("users").Get(); users.OnCompletion([](const Future<QuerySnapshot>& future) { if (future.error() == Error::kErrorOk) { for (const DocumentSnapshot& document : future.result()->documents()) { std::cout << document << std::endl; } } else { std::cout << "Error getting documents: " << future.error_message() << std::endl; } });
Node.js
Vai
PHP
PHP
Para saber mais sobre como instalar e criar um cliente Cloud Firestore, consulte Bibliotecas de cliente Cloud Firestore .
Unidade
CollectionReference usersRef = db.Collection("users"); usersRef.GetSnapshotAsync().ContinueWithOnMainThread(task => { QuerySnapshot snapshot = task.Result; foreach (DocumentSnapshot document in snapshot.Documents) { Debug.Log(String.Format("User: {0}", document.Id)); Dictionary<string, object> documentDictionary = document.ToDictionary(); Debug.Log(String.Format("First: {0}", documentDictionary["First"])); if (documentDictionary.ContainsKey("Middle")) { Debug.Log(String.Format("Middle: {0}", documentDictionary["Middle"])); } Debug.Log(String.Format("Last: {0}", documentDictionary["Last"])); Debug.Log(String.Format("Born: {0}", documentDictionary["Born"])); } Debug.Log("Read all data from the users collection."); });
C #
Rubi
Proteja seus dados
Se você estiver usando o SDK das plataformas Web, Android ou Apple, use o Firebase Authentication e as regras de segurança do Cloud Firestore para proteger seus dados no Cloud Firestore.
Aqui estão alguns conjuntos de regras básicas que você pode usar para começar. Você pode modificar suas regras de segurança na guia Regras do console.
Autenticação necessária
// Allow read/write access on all documents to any user signed in to the application
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if request.auth != null;
}
}
}
modo bloqueado
// Deny read/write access to all users under any conditions
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if false;
}
}
}
Modo de teste
// Allow read/write access to all users under any conditions
// Warning: **NEVER** use this rule set in production; it allows
// anyone to overwrite your entire database.
service cloud.firestore {
match /databases/{database}/documents {
match /{document=**} {
allow read, write: if true;
}
}
}
Antes de implantar seu aplicativo Web, Android ou iOS para produção, também tome medidas para garantir que apenas os clientes do aplicativo possam acessar seus dados do Cloud Firestore. Consulte a documentação do App Check .
Se você estiver usando um dos SDKs de servidor, use o Identity and Access Management (IAM) para proteger seus dados no Cloud Firestore.
Assista a um tutorial em vídeo
Para obter orientações detalhadas sobre como começar a usar as bibliotecas de cliente móvel do Cloud Firestore, assista a um dos seguintes tutoriais em vídeo:
Rede
iOS+
Android
Você pode encontrar mais vídeos no canal do YouTube do Firebase.
Próximos passos
Aprofunde seus conhecimentos com os seguintes tópicos:
- Codelabs — Aprenda a usar o Cloud Firestore em um app real seguindo o codelab para Android , iOS ou Web .
- Modelo de dados — saiba mais sobre como os dados são estruturados no Cloud Firestore, incluindo dados hierárquicos e subcoleções.
- Adicionar dados — Saiba mais sobre como criar e atualizar dados no Cloud Firestore.
- Obter dados — Saiba mais sobre como recuperar dados.
- Realize consultas simples e compostas — Aprenda a executar consultas simples e compostas.
- Ordenar e limitar consultas Saiba como ordenar e limitar os dados retornados por suas consultas.