This quickstart shows you how to set upCloud Firestore, add data, then useeither Core operations or Pipeline operations to query the data youjust added in theFirebase console using server client libraries forJava, Node.js, and Python.

Use these client libraries to set up privileged server environments with fullaccess to your database..

Create aCloud Firestore database

1. If you haven't already, create a Firebase project: In theFirebase console, clickAdd project,then follow the on-screen instructions to create a Firebase project or toadd Firebase services to an existingGoogle Cloud project.

2. Open your project in theFirebase console. In the left panel, expandBuild and then selectFirestore database.

3. ClickCreate database.

4. SelectEnterprise for the database mode.

5. SelectFirestore in Native Mode for the operation mode, which supportsCore and Pipeline operations.

   Note: You can create a database in either Native mode or MongoDB compatibilitymode. For more information about MongoDB compatibility mode, see thequickstart for creating MongoDB compatible databases.

6. Select alocation for your database.

7. Select a starting mode for yourCloud Firestore Security Rules:

   Test mode

   Good for getting started with the mobile and web client libraries,but allows anyone to read and overwrite your data. After testing,makesure to review theSecure your data section.

   To get started with the web, Apple platforms, or Android SDK, select testmode.

   Production mode

   Denies all reads and writes from mobile and web clients.Your authenticated application servers (Node.js, Python, Java) can stillaccess your database.

   Your initial set ofCloud Firestore Security Rules will apply to your defaultCloud Firestore database. If you create multiple databases for yourproject, you can deployCloud Firestore Security Rules for each database.

8. ClickCreate.

When you enableCloud Firestore, it also enables the API in theCloud API Manager.

Set up your development environment

Add the required dependencies and client libraries to your app.

InitializeCloud Firestore

Initialize an instance ofCloud Firestore:

importfirebase_adminfromfirebase_adminimportfirestore# Application Default credentials are automatically created.app=firebase_admin.initialize_app()db=firestore.client()
firestore.py

importfirebase_adminfromfirebase_adminimportcredentialsfromfirebase_adminimportfirestore# Use the application default credentials.cred=credentials.ApplicationDefault()firebase_admin.initialize_app(cred)db=firestore.client()
firestore.py

importfirebase_adminfromfirebase_adminimportcredentialsfromfirebase_adminimportfirestore# Use a service account.cred=credentials.Certificate('path/to/serviceAccount.json')app=firebase_admin.initialize_app(cred)db=firestore.client()
firestore.py

importcom.google.auth.oauth2.GoogleCredentials;importcom.google.cloud.firestore.Firestore;importcom.google.firebase.FirebaseApp;importcom.google.firebase.FirebaseOptions;// Use the application default credentialsGoogleCredentialscredentials=GoogleCredentials.getApplicationDefault();FirebaseOptionsoptions=newFirebaseOptions.Builder().setCredentials(credentials).setProjectId(projectId).build();FirebaseApp.initializeApp(options);Firestoredb=FirestoreClient.getFirestore();

importcom.google.auth.oauth2.GoogleCredentials;importcom.google.cloud.firestore.Firestore;importcom.google.firebase.FirebaseApp;importcom.google.firebase.FirebaseOptions;// Use a service accountInputStreamserviceAccount=newFileInputStream("path/to/serviceAccount.json");GoogleCredentialscredentials=GoogleCredentials.fromStream(serviceAccount);FirebaseOptionsoptions=newFirebaseOptions.Builder().setCredentials(credentials).build();FirebaseApp.initializeApp(options);Firestoredb=FirestoreClient.getFirestore();

Add data using Core operations

In order to explore Core operations and Pipeline operations for querying data,add data to your database using Core operations.

Cloud Firestore stores data in Documents, which are stored inCollections.Cloud Firestore creates collections and documents implicitlythe first time you add data to the document. You don't need to explicitlycreate collections or documents.

Create a new collection and a document using the following example code.

constdocRef=db.collection('users').doc('alovelace');awaitdocRef.set({first:'Ada',last:'Lovelace',born:1815});
index.js

DocumentReferencedocRef=db.collection("users").document("alovelace");// Add document data  with id "alovelace" using a hashmapMap<String,Object>data=newHashMap<>();data.put("first","Ada");data.put("last","Lovelace");data.put("born",1815);//asynchronously write dataApiFuture<WriteResult>result=docRef.set(data);// ...// result.get() blocks on responseSystem.out.println("Update time : "+result.get().getUpdateTime());
Quickstart.java

doc_ref=db.collection("users").document("alovelace")doc_ref.set({"first":"Ada","last":"Lovelace","born":1815})
snippets.py

Read data using Core operations

Use the data viewer in theFirebase consoleto quickly verify that you've added data toCloud Firestore.

You can also use the "get" method to retrieve the entire collection.

constsnapshot=awaitdb.collection('users').get();snapshot.forEach((doc)=>{console.log(doc.id,'=>',doc.data());});
index.js

users_ref=db.collection("users")docs=users_ref.stream()fordocindocs:print(f"{doc.id} =>{doc.to_dict()}")
snippets.py

// asynchronously retrieve all usersApiFuture<QuerySnapshot>query=db.collection("users").get();// ...// query.get() blocks on responseQuerySnapshotquerySnapshot=query.get();List<QueryDocumentSnapshot>documents=querySnapshot.getDocuments();for(QueryDocumentSnapshotdocument:documents){System.out.println("User: "+document.getId());System.out.println("First: "+document.getString("first"));if(document.contains("middle")){System.out.println("Middle: "+document.getString("middle"));}System.out.println("Last: "+document.getString("last"));System.out.println("Born: "+document.getLong("born"));}
Quickstart.java

Read data using Pipeline operations

Now you can compare the Pipeline query experience with the Core queryexperience.

constreadDataPipeline=db.pipeline().collection("users");// Execute the pipeline and handle the resulttry{constquerySnapshot=awaitreadDataPipeline.execute();querySnapshot.results.forEach((result)=>{console.log(`${result.id} =>${result.data()}`);});}catch(error){console.error("Error getting documents: ",error);}
test.firestore.js

pipeline=client.pipeline().collection("users")forresultinpipeline.execute():print(f"{result.id} =>{result.data()}")
firestore_pipelines.py

Pipelinepipeline=firestore.pipeline().collection("users");ApiFuture<Pipeline.Snapshot>future=pipeline.execute();for(com.google.cloud.firestore.PipelineResultresult:future.get().getResults()){System.out.println(result.getId()+" => "+result.getData());}// or, asynchronouslypipeline.execute(newApiStreamObserver<com.google.cloud.firestore.PipelineResult>(){@OverridepublicvoidonNext(com.google.cloud.firestore.PipelineResultresult){System.out.println(result.getId()+" => "+result.getData());}@OverridepublicvoidonError(Throwablet){System.err.println(t);}@OverridepublicvoidonCompleted(){System.out.println("done");}});
PipelineSnippets.java

Next steps

Deepen your knowledge of Core and Pipeline operations with the following topics:

• Make sure you're familiar with thedifferences between the Core and Pipeline operations
• Learn more about querying withCore operations
• Learn more about querying withPipeline operations.