Get started with Firestore Enterprise edition using server client libraries

This quickstart shows you how to set up Cloud Firestore , add data, then use either Core operations or Pipeline operations to query the data you just added in the Firebase console using server client libraries for Java, Node.js, and Python.

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

Create a Cloud Firestore database

1. If you haven't already, create a Firebase project: In the Firebase console , click Add project, then follow the on-screen instructions to create a Firebase project or to add Firebase services to an existing Google Cloud project.

2. Open your project in the Firebase console. In the left panel, expand Buildand then select Firestore database .

3. Click Create database.

4. Select Enterprisefor the database mode.

5. Select Firestore in Native Modefor the operation mode, which supports Core and Pipeline operations.

6. Select a location for your database.

7. Select a starting mode for your Cloud 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, make sure to review the Secure your data section.

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

   Production mode

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

   Your initial set of Cloud Firestore Security Rules will apply to your default Cloud Firestore database. If you create multiple databases for your project, you can deploy Cloud Firestore Security Rules for each database.

8. Click Create.

When you enable Cloud Firestore , it also enables the API in the Cloud API Manager .

Set up your development environment

Add the required dependencies and client libraries to your app.

Initialize Cloud Firestore

Initialize an instance of Cloud Firestore :

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

 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 
 () 
 
  firestore 
 . 
 py 
 
 

 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 
 () 
 
  firestore 
 . 
 py 
 
 

 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 
 (); 

 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 
 (); 

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 in Collections. Cloud Firestore creates collections and documents implicitly the first time you add data to the document. You don't need to explicitly create collections or documents.

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

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

  DocumentReference 
  
 docRef 
  
 = 
  
 db 
 . 
 collection 
 ( 
 "users" 
 ). 
 document 
 ( 
 "alovelace" 
 ); 
 // Add document data  with id "alovelace" using a hashmap 
 Map<String 
 , 
  
 Object 
>  
 data 
  
 = 
  
 new 
  
 HashMap 
<> (); 
 data 
 . 
 put 
 ( 
 "first" 
 , 
  
 "Ada" 
 ); 
 data 
 . 
 put 
 ( 
 "last" 
 , 
  
 "Lovelace" 
 ); 
 data 
 . 
 put 
 ( 
 "born" 
 , 
  
 1815 
 ); 
 //asynchronously write data 
 ApiFuture<WriteResult> 
  
 result 
  
 = 
  
 docRef 
 . 
 set 
 ( 
 data 
 ); 
 // ... 
 // result.get() blocks on response 
 System 
 . 
 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 the Firebase console to quickly verify that you've added data to Cloud Firestore .

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

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

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

  // asynchronously retrieve all users 
 ApiFuture<QuerySnapshot> 
  
 query 
  
 = 
  
 db 
 . 
 collection 
 ( 
 "users" 
 ). 
 get 
 (); 
 // ... 
 // query.get() blocks on response 
 QuerySnapshot 
  
 querySnapshot 
  
 = 
  
 query 
 . 
 get 
 (); 
 List<QueryDocumentSnapshot> 
  
 documents 
  
 = 
  
 querySnapshot 
 . 
 getDocuments 
 (); 
 for 
  
 ( 
 QueryDocumentSnapshot 
  
 document 
  
 : 
  
 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 query experience.

 const 
  
 readDataPipeline 
  
 = 
  
 db 
 . 
 pipeline 
 () 
  
 . 
 collection 
 ( 
 "users" 
 ); 
 // Execute the pipeline and handle the result 
 try 
  
 { 
  
 const 
  
 querySnapshot 
  
 = 
  
 await 
  
 readDataPipeline 
 . 
 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" 
 ) 
 for 
 result 
 in 
 pipeline 
 . 
 execute 
 (): 
 print 
 ( 
 f 
 " 
 { 
 result 
 . 
 id 
 } 
 => 
 { 
 result 
 . 
 data 
 () 
 } 
 " 
 ) 
 
  firestore_pipelines 
 . 
 py 
 
 

 Pipeline 
  
 pipeline 
  
 = 
  
 firestore 
 . 
 pipeline 
 (). 
 collection 
 ( 
 "users" 
 ); 
 ApiFuture<Pipeline 
 . 
 Snapshot 
>  
 future 
  
 = 
  
 pipeline 
 . 
 execute 
 (); 
 for 
  
 ( 
 com 
 . 
 google 
 . 
 cloud 
 . 
 firestore 
 . 
 PipelineResult 
  
 result 
  
 : 
  
 future 
 . 
 get 
 (). 
 getResults 
 ()) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 result 
 . 
 getId 
 () 
  
 + 
  
 " => " 
  
 + 
  
 result 
 . 
 getData 
 ()); 
 } 
 // or, asynchronously 
 pipeline 
 . 
 execute 
 ( 
  
 new 
  
 ApiStreamObserver<com 
 . 
 google 
 . 
 cloud 
 . 
 firestore 
 . 
 PipelineResult 
> () 
  
 { 
  
 @Override 
  
 public 
  
 void 
  
 onNext 
 ( 
 com 
 . 
 google 
 . 
 cloud 
 . 
 firestore 
 . 
 PipelineResult 
  
 result 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 result 
 . 
 getId 
 () 
  
 + 
  
 " => " 
  
 + 
  
 result 
 . 
 getData 
 ()); 
  
 } 
  
 @Override 
  
 public 
  
 void 
  
 onError 
 ( 
 Throwable 
  
 t 
 ) 
  
 { 
  
 System 
 . 
 err 
 . 
 println 
 ( 
 t 
 ); 
  
 } 
  
 @Override 
  
 public 
  
 void 
  
 onCompleted 
 () 
  
 { 
  
 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 the differences between the Core and Pipeline operations
• Learn more about querying with Core operations
• Learn more about querying with Pipeline operations .