Package io.nitric.api.document

Provides the Document Service API.

The example below illustrates the Documents API.

 import io.nitric.api.document.Documents;
 ...

 // Create a "customers" collection
 var customers = Documents.collection("customers");

 // Get a customer document reference by id
 var customerRef = customers.doc("[email protected]");

 // Get the document references content
 var contentMap = customerRef.get();

 // Update customer document content
 contentMap.put("status", "active");
 customerRef.set(contentMap);

 // Delete a customer document
 customerRef.delete();
 

Class Summary

Class	Description
AbstractCollection	Provides an abstract Collection class.
Collection	Provides a Collection class.
CollectionGroup	Provides a query sub CollectionGroup class.
DocumentRef<T>	Provides an Document Reference class.
Documents	Provides the Document API client.
Key	Provides a Document Key class.
Query<T>	Provides a Document Query class.
QueryResults<T>	Provides an iterable Query Result class.
ResultDoc<T>	Provides a Result Document class for QueryResults and Streams.