DocumentStore (OJAI Core Library for Java v. 3.0)

All Superinterfaces:: AutoCloseable

All Known Implementing Classes:: ForwardingStore

@API.Public
 @API.NotThreadSafe
public interface DocumentStore
extends AutoCloseable

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`beginTrackingWrites()` Begins tracking the write operations performed through this instance of `DocumentStore`.
`void`	`beginTrackingWrites(String previousWritesContext)` Begins tracking the write operations performed through this instance of `DocumentStore`.
`boolean`	`checkAndDelete(String _id, QueryCondition condition)` Atomically evaluates the condition on given document and if the condition holds true for the document then it is atomically deleted.
`boolean`	`checkAndDelete(Value _id, QueryCondition condition)`
`boolean`	`checkAndMutate(String _id, QueryCondition condition, DocumentMutation mutation)` Deprecated. Use `checkAndUpdate(String, QueryCondition, DocumentMutation)`
`boolean`	`checkAndMutate(Value _id, QueryCondition condition, DocumentMutation mutation)` Deprecated. Use `checkAndUpdate(Value, QueryCondition, DocumentMutation)`
`boolean`	`checkAndReplace(String _id, QueryCondition condition, Document doc)` Atomically evaluates the condition on the given document and if the condition holds true for the document then it atomically replaces the document with the given document.
`boolean`	`checkAndReplace(Value _id, QueryCondition condition, Document doc)`
`default boolean`	`checkAndUpdate(String _id, QueryCondition condition, DocumentMutation mutation)` Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document.
`default boolean`	`checkAndUpdate(Value _id, QueryCondition condition, DocumentMutation mutation)` Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document.
`void`	`clearTrackedWrites()` Stops the writes tracking and clears any state on this `DocumentStore` instance.
`void`	`close()` Override `AutoCloseable.close()` to avoid declaring a checked exception.
`void`	`delete(Document doc)`
`void`	`delete(Document doc, FieldPath fieldAsKey)`
`void`	`delete(DocumentStream stream)` Deletes a set of documents from the DocumentStore represented by the DocumentStream.
`void`	`delete(DocumentStream stream, FieldPath fieldAsKey)`
`void`	`delete(DocumentStream stream, String fieldAsKey)`
`void`	`delete(Document doc, String fieldAsKey)`
`void`	`delete(String _id)` Deletes a document with the given id.
`void`	`delete(Value _id)`
`String`	`endTrackingWrites()` Flushes any buffered writes operations for this `DocumentStore` and returns a writesContext which can be used to ensure that such writes are visible to ensuing queries.
`DocumentStream`	`find()` Executes a query to return all Documents in the DocumentStore.
`DocumentStream`	`find(FieldPath... fieldPaths)` Deprecated. use `find(Query)`
`QueryResult`	`find(Query query)` Executes the specified query on the DocumentStore and return a QueryResult.
`DocumentStream`	`find(QueryCondition condition)` Deprecated. use `find(Query)`
`DocumentStream`	`find(QueryCondition condition, FieldPath... fieldPaths)` Deprecated. use `find(Query)`
`DocumentStream`	`find(QueryCondition condition, String... fieldPaths)` Deprecated. use `find(Query)`
`DocumentStream`	`find(String... fieldPaths)` Deprecated. use `find(Query)`
`Document`	`findById(String _id)` Returns the Document with the given `_id` or `null` if the document with that `_id` doesn't exist in this DocumentStore.
`Document`	`findById(String _id, FieldPath... fieldPaths)` Returns the Document with the given `_id` or `null` if the document with that `_id` doesn't exist in this DocumentStore.
`Document`	`findById(String _id, QueryCondition condition)` Returns the Document with the given `_id` if it matches the specified condition.
`Document`	`findById(String _id, QueryCondition condition, FieldPath... fieldPaths)` Returns the Document with the given `_id` if it matches the specified condition.
`Document`	`findById(String _id, QueryCondition condition, String... fieldPaths)` Returns the Document with the given `_id` if it matches the specified condition.
`Document`	`findById(String _id, String... fieldPaths)` Returns the Document with the given `_id` or `null` if the document with that `_id` doesn't exist in this DocumentStore.
`Document`	`findById(Value _id)` Returns the Document with the given `_id` or `null` if the document with that `_id` doesn't exist in this DocumentStore.
`Document`	`findById(Value _id, FieldPath... fieldPaths)` Returns the Document with the given `_id` or `null` if the document with that `_id` doesn't exist in this DocumentStore.
`Document`	`findById(Value _id, QueryCondition condition)` Returns the Document with the given `_id` if it matches the specified condition.
`Document`	`findById(Value _id, QueryCondition condition, FieldPath... fieldPaths)` Returns the Document with the given `_id` if it matches the specified condition.
`Document`	`findById(Value _id, QueryCondition condition, String... fieldPaths)` Returns the Document with the given `_id` if it matches the specified condition.
`Document`	`findById(Value _id, String... fieldPaths)` Returns the Document with the given `_id` or `null` if the document with that `_id` doesn't exist in this DocumentStore.
`DocumentStream`	`findQuery(Query query)` Deprecated. use `find(Query)`
`DocumentStream`	`findQuery(String queryJSON)` Deprecated. use `find(Query)`
`void`	`flush()` Flushes any buffered writes operations for this DocumentStore.
`void`	`increment(String _id, String field, BigDecimal inc)`
`void`	`increment(String _id, String field, byte inc)` Atomically applies an increment to a given field (in dot separated notation) of the given document id.
`void`	`increment(String _id, String field, double inc)`
`void`	`increment(String _id, String field, float inc)`
`void`	`increment(String _id, String field, int inc)`
`void`	`increment(String _id, String field, long inc)`
`void`	`increment(String _id, String field, short inc)`
`void`	`increment(Value _id, String field, BigDecimal inc)`
`void`	`increment(Value _id, String field, byte inc)`
`void`	`increment(Value _id, String field, double inc)`
`void`	`increment(Value _id, String field, float inc)`
`void`	`increment(Value _id, String field, int inc)`
`void`	`increment(Value _id, String field, long inc)`
`void`	`increment(Value _id, String field, short inc)`
`void`	`insert(Document doc)`
`void`	`insert(Document doc, FieldPath fieldAsKey)`
`void`	`insert(DocumentStream stream)` Inserts a set of documents represented by the DocumentStream into the DocumentStore.
`void`	`insert(DocumentStream stream, FieldPath fieldAsKey)`
`void`	`insert(DocumentStream stream, String fieldAsKey)`
`void`	`insert(Document doc, String fieldAsKey)`
`void`	`insert(String _id, Document doc)` Inserts a document with the given id.
`void`	`insert(Value _id, Document doc)`
`void`	`insertOrReplace(Document doc)` Inserts or replaces a new document in this DocumentStore.
`void`	`insertOrReplace(Document doc, FieldPath fieldAsKey)` Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the `_id`.
`void`	`insertOrReplace(DocumentStream stream)` Inserts all documents from the specified DocumentStream into this DocumentStore.
`void`	`insertOrReplace(DocumentStream stream, FieldPath fieldAsKey)` Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter `fieldAsKey` as the "_id" field.
`void`	`insertOrReplace(DocumentStream stream, String fieldAsKey)` Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter `fieldAsKey` as the "_id" field.
`void`	`insertOrReplace(Document doc, String fieldAsKey)` Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the `_id`.
`void`	`insertOrReplace(String _id, Document r)` Inserts or replaces a new document in this DocumentStore with the given _id.
`void`	`insertOrReplace(Value _id, Document doc)` Inserts or replaces a new document in this DocumentStore with the given _id.
`boolean`	`isReadOnly()` Returns `true` if this Document store does not support any write operations like insert/update/delete, etc.
`void`	`replace(Document doc)`
`void`	`replace(Document doc, FieldPath fieldAsKey)`
`void`	`replace(DocumentStream stream)` Replaces a set of documents represented by the DocumentStream into the DocumentStore.
`void`	`replace(DocumentStream stream, FieldPath fieldAsKey)`
`void`	`replace(DocumentStream stream, String fieldAsKey)`
`void`	`replace(Document doc, String fieldAsKey)`
`void`	`replace(String _id, Document doc)` Replaces a document in the DocumentStore.
`void`	`replace(Value _id, Document doc)`
`void`	`update(String _id, DocumentMutation mutation)` Applies a mutation on the document identified by the document id. All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.
`void`	`update(Value _id, DocumentMutation mutation)` Applies a mutation on the document identified by the document id. All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.

- Method Detail
  - isReadOnly
```
boolean isReadOnly()
```
    Returns true if this Document store does not support any write operations like insert/update/delete, etc.
  - flush
```
void flush()
    throws StoreException
```
    Flushes any buffered writes operations for this DocumentStore.
    
    Throws:
    
    StoreException - if the flush failed or if the flush of any buffered operation resulted in an error
  - beginTrackingWrites
```
void beginTrackingWrites()
                  throws StoreException
```
    Begins tracking the write operations performed through this instance of DocumentStore.
    
    Throws:
    
    IllegalStateException - if a beginTrackingWrites() was already called and a corresponding endTrackingWrites()/clearTrackedWrites() wasn't
    
    StoreException
    
    See Also:
    
    endTrackingWrites(), clearTrackedWrites(), Query.waitForTrackedWrites(String)
  - beginTrackingWrites
```
void beginTrackingWrites(@API.NonNullable
                         String previousWritesContext)
                  throws StoreException
```
    Begins tracking the write operations performed through this instance of DocumentStore.
    
    Parameters:
    
    previousWritesContext - previously tracked writes that were retrieved from this DocumentStore, or from other DocumentStore instances. The tracking begins by using this context as the base state
    
    Throws:
    
    NullPointerException - if previousWrites is null
    
    IllegalStateException - if a beginTrackingWrites() was already called and a corresponding endTrackingWrites()/clearTrackedWrites() wasn't
    
    IllegalArgumentException - if the specified argument can not be parsed
    
    StoreException
    
    See Also:
    
    endTrackingWrites(), clearTrackedWrites(), Query.waitForTrackedWrites(String)
  - endTrackingWrites
```
String endTrackingWrites()
                  throws StoreException
```
    Flushes any buffered writes operations for this DocumentStore and returns a writesContext which can be used to ensure that such writes are visible to ensuing queries.
    The write-context is cleared and tracking is stopped.
    This call does not isolate the writes originating from this instance of DocumentStore from other instances and as a side-effect other writes issued to the same document-store through other DocumentStore instances could get flushed.
    
    Returns:
    
    an encoded string representing the write-context of all writes issued, since beginTrackingWrites() until now, through this instance of DocumentStore
    
    Throws:
    
    StoreException - if the flush failed or if the flush of any buffered operation resulted in an error.
    
    IllegalStateException - if a corresponding beginTrackingWrites() was not called before calling this method
    
    See Also:
    
    beginTrackingWrites(), clearTrackedWrites(), Query.waitForTrackedWrites(String)
  - clearTrackedWrites
```
void clearTrackedWrites()
                 throws StoreException
```
    Stops the writes tracking and clears any state on this DocumentStore instance.
    This API should be called to stop tracking the writes-context in case where beginTrackingWrites() was previously called but a commit context is not needed anymore, for example in case of an error in any of the mutation.
    
    Throws:
    
    IllegalStateException - if a corresponding beginTrackingWrites() was not called before calling this method
    
    StoreException
  - findById
```
Document findById(String _id)
           throws StoreException
```
    Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
    
    Parameters:
    
    _id - document id
    
    Returns:
    
    an OJAI Document with the specified id or null if one does not exist in this DocumentStore
    
    Throws:
    
    StoreException
  - findById
```
Document findById(Value _id)
           throws StoreException
```
    Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore.
    
    Parameters:
    
    _id - Document _id
    
    Returns:
    
    an OJAI Document with the specified id or null if one does not exist in this DocumentStore
    
    Throws:
    
    StoreException
  - findById
```
Document findById(String _id,
                  String... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - Document _id
    
    fieldPaths - Array of field paths that should be returned
    
    Returns:
    
    an OJAI Document with the specified id or null if one does not exist in this DocumentStore
    
    Throws:
    
    StoreException
  - findById
```
Document findById(String _id,
                  FieldPath... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - Document _id
    
    fieldPaths - Array of field paths that should be returned
    
    Returns:
    
    an OJAI Document with the specified id or null if one does not exist in this DocumentStore
    
    Throws:
    
    StoreException
  - findById
```
Document findById(Value _id,
                  String... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - Document _id
    
    fieldPaths - Array of of field paths that should be returned
    
    Returns:
    
    an OJAI Document with the specified id or null if one does not exist in this DocumentStore
    
    Throws:
    
    StoreException
  - findById
```
Document findById(Value _id,
                  FieldPath... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` or null if the document with that `_id` doesn't exist in this DocumentStore. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - Document _id
    
    fieldPaths - Array of of field paths that should be returned
    
    Returns:
    
    an OJAI Document with the specified id or null if one does not exist in this DocumentStore
    
    Throws:
    
    StoreException
  - findById
```
Document findById(String _id,
                  QueryCondition condition)
           throws StoreException
```
    Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned.
    
    Parameters:
    
    _id - document id
    
    condition - query condition to test the document
    
    Returns:
    
    an OJAI Document with the specified _id
    
    Throws:
    
    StoreException
  - findById
```
Document findById(Value _id,
                  QueryCondition condition)
           throws StoreException
```
    Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned.
    
    Parameters:
    
    _id - document id
    
    condition - query condition to test the document
    
    Returns:
    
    an OJAI Document with the specified _id
    
    Throws:
    
    StoreException
  - findById
```
Document findById(String _id,
                  QueryCondition condition,
                  String... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - document id
    
    fieldPaths - list of fields that should be returned in the read document
    
    condition - query condition to test the document
    
    Returns:
    
    an OJAI Document with the specified _id
    
    Throws:
    
    StoreException
  - findById
```
Document findById(String _id,
                  QueryCondition condition,
                  FieldPath... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - document id
    
    fieldPaths - list of fields that should be returned in the read document
    
    condition - query condition to test the document
    
    Returns:
    
    an OJAI Document with the specified _id
    
    Throws:
    
    StoreException
  - findById
```
Document findById(Value _id,
                  QueryCondition condition,
                  String... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - document id
    
    fieldPaths - list of fields that should be returned in the read document
    
    condition - query condition to test the document
    
    Returns:
    
    an OJAI Document with the specified _id
    
    Throws:
    
    StoreException
  - findById
```
Document findById(Value _id,
                  QueryCondition condition,
                  FieldPath... fieldPaths)
           throws StoreException
```
    Returns the Document with the given `_id` if it matches the specified condition. If a Document with the specified `_id` does not exist in this DocumentStore or does not satisfy the specified condition, null is returned. The returned Document will include only the specified fields.
    
    Parameters:
    
    _id - document id
    
    fieldPaths - list of fields that should be returned in the read document
    
    condition - query condition to test the document
    
    Returns:
    
    an OJAI Document with the specified _id
    
    Throws:
    
    StoreException
  - find
```
QueryResult find(@API.NonNullable
                 Query query)
          throws StoreException
```
    Executes the specified query on the DocumentStore and return a QueryResult.
    The returned QueryResult must be closed after retrieving the documents.
    
    Returns:
    
    a QueryResult that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - find
```
DocumentStream find()
             throws StoreException
```
    Executes a query to return all Documents in the DocumentStore.
    The returned DocumentStream must be closed after retrieving the documents.
    
    Returns:
    
    a DocumentStream of all documents in the this DocumentStore
    
    Throws:
    
    StoreException
  - findQuery
```
DocumentStream findQuery(@API.NonNullable
                         Query query)
                  throws StoreException
```
    Deprecated. use find(Query)
    
    Executes the specified query on the DocumentStore and return a DocumentStream of the result.
    The returned DocumentStream must be closed after retrieving the documents.
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - findQuery
```
DocumentStream findQuery(@API.NonNullable
                         String queryJSON)
                  throws StoreException
```
    Deprecated. use find(Query)
    
    Executes the specified query on the DocumentStore and return a DocumentStream of the result.
    The returned DocumentStream must be closed after retrieving the documents.
    
    Parameters:
    
    queryJSON - a Json string representation of OJAI Query
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - find
```
DocumentStream find(@API.NonNullable
                    String... fieldPaths)
             throws StoreException
```
    Deprecated. use find(Query)
    
    Executes a query to return all Documents in the DocumentStore.
    Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.
    
    Parameters:
    
    fieldPaths - list of fields that should be returned in the read document
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - find
```
DocumentStream find(@API.NonNullable
                    FieldPath... fieldPaths)
             throws StoreException
```
    Deprecated. use find(Query)
    
    Executes a query to return all Documents in the DocumentStore.
    Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.
    
    Parameters:
    
    fieldPaths - list of fields that should be returned in the read document
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - find
```
DocumentStream find(@API.NonNullable
                    QueryCondition condition)
             throws StoreException
```
    Deprecated. use find(Query)
    
    Returns a DocumentStream with all the documents in the DocumentStore that satisfies the QueryCondition.
    
    Parameters:
    
    condition - the QueryCondition to match the documents
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - find
```
DocumentStream find(@API.NonNullable
                    QueryCondition condition,
                    @API.NonNullable
                    String... fieldPaths)
             throws StoreException
```
    Deprecated. use find(Query)
    
    Executes a query on the DocumentStore and return a DocumentStream of the Document matching the specified QueryCondition.
    Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.
    
    Parameters:
    
    condition - the QueryCondition to match the documents
    
    fieldPaths - list of fields that should be returned in the read document
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - find
```
DocumentStream find(@API.NonNullable
                    QueryCondition condition,
                    @API.NonNullable
                    FieldPath... fieldPaths)
             throws StoreException
```
    Deprecated. use find(Query)
    
    Executes a query on the DocumentStore and return a DocumentStream of the Document matching the specified QueryCondition.
    Each Document will contain only those field paths that are specified in the argument. If no fields are specified then it returns a full document.
    
    Parameters:
    
    condition - the QueryCondition to match the documents
    
    fieldPaths - list of fields that should be returned in the read document
    
    Returns:
    
    a DocumentStream that can be used to retrieve the documents in the result
    
    Throws:
    
    StoreException
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     Document doc)
              throws StoreException
```
    Inserts or replaces a new document in this DocumentStore.
    
    The specified Document must contain an "_id" field or the operation will fail.
    
    If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.
    
    Parameters:
    
    doc - the Document to be inserted or replaced in the DocumentStore
    
    Throws:
    
    StoreException
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     String _id,
                     @API.NonNullable
                     Document r)
              throws StoreException
```
    Inserts or replaces a new document in this DocumentStore with the given _id.
    
    The specified document should either not contain an "_id" field or its value should be same as the specified _id or the operation will fail.
    
    If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.
    
    Parameters:
    
    doc - the Document to be inserted or replaced in the DocumentStore
    
    _id - value to be used as the _id for this document
    
    Throws:
    
    StoreException
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     Value _id,
                     @API.NonNullable
                     Document doc)
              throws StoreException
```
    Inserts or replaces a new document in this DocumentStore with the given _id.
    
    The specified document should either not contain an "_id" field or its value should be same as the specified _id or the operation will fail.
    
    If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.
    
    Parameters:
    
    doc - the Document to be inserted or replaced in the DocumentStore
    
    _id - value to be used as the _id for this document
    
    Throws:
    
    StoreException
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     Document doc,
                     @API.NonNullable
                     FieldPath fieldAsKey)
              throws StoreException
```
    Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.
    
    If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.
    
    Parameters:
    
    doc - the Document to be inserted or replaced in the DocumentStore
    
    fieldAsKey - document's field to be used as the key when an id is not passed in and the document doesn't have an "_id" field or a different field is desired to be used as _id
    
    Throws:
    
    StoreException
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     Document doc,
                     @API.NonNullable
                     String fieldAsKey)
              throws StoreException
```
    Inserts or replaces a new document in this DocumentStore with the value of the specified Field as the _id.
    
    If the document with the given _id exists in the DocumentStore then that document will be replaced by the specified document.
    
    Parameters:
    
    doc - the Document to be inserted or replaced in the DocumentStore
    
    fieldAsKey - document's field to be used as the key when an id is not passed in and the document doesn't have an "_id" field or a different field is desired to be used as _id
    
    Throws:
    
    StoreException
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     DocumentStream stream)
              throws MultiOpException
```
    Inserts all documents from the specified DocumentStream into this DocumentStore.
    
    This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error has occurred while storing the documents. Each document read from the DocumentStream must have a field "_id"; otherwise, the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown containing the list of documents that failed to be stored in the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the rest of the documents will remain un-consumed in the DocumentStream.
    
    Parameters:
    
    stream - the DocumentStream to read the documents from
    
    Throws:
    
    MultiOpException - which has a list of write-failed documents and their errors
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     DocumentStream stream,
                     @API.NonNullable
                     FieldPath fieldAsKey)
              throws MultiOpException
```
    Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field. If an "_id" field is present in the documents, an exception will be thrown.
    
    This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error has occurred while storing the documents. Each document read from the DocumentStream must have a field "_id"; otherwise, the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown containing the list of documents that failed to be stored in the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the rest of the documents will remain un-consumed in the DocumentStream.
    
    Parameters:
    
    stream - the DocumentStream to read the documents from
    
    fieldAsKey - field from each document whose value is to be used as the document key for insertion
    
    Throws:
    
    MultiOpException - which has a list of write-failed documents and their errors
  - insertOrReplace
```
void insertOrReplace(@API.NonNullable
                     DocumentStream stream,
                     @API.NonNullable
                     String fieldAsKey)
              throws MultiOpException
```
    Inserts all documents from the specified DocumentStream into this DocumentStore using the field specified by parameter fieldAsKey as the "_id" field. If an "_id" field is present in the documents, an exception will be thrown.
    
    This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error has occurred while storing the documents. Each document read from the DocumentStream must have a field "_id"; otherwise, the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown containing the list of documents that failed to be stored in the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the rest of the documents will remain un-consumed in the DocumentStream.
    
    Parameters:
    
    stream - the DocumentStream to read the documents from
    
    fieldAsKey - field from each document whose value is to be used as the document key for insertion
    
    Throws:
    
    MultiOpException - which has a list of write-failed documents and their errors
  - update
```
void update(@API.NonNullable
            String _id,
            @API.NonNullable
            DocumentMutation mutation)
     throws StoreException
```
    Applies a mutation on the document identified by the document id.
    
    All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.
    
    Parameters:
    
    _id - document id
    
    m - a mutation object specifying the mutation operations on the document
    
    Throws:
    
    StoreException
  - update
```
void update(@API.NonNullable
            Value _id,
            @API.NonNullable
            DocumentMutation mutation)
     throws StoreException
```
    Applies a mutation on the document identified by the document id.
    
    All updates specified by the mutation object should be applied atomically, and consistently meaning either all of the updates in mutation are applied or none of them is applied and a partial update should not be visible to an observer.
    
    Parameters:
    
    _id - document id
    
    m - a mutation object specifying the mutation operations on the document
    
    Throws:
    
    StoreException
  - delete
```
void delete(@API.NonNullable
            String _id)
     throws StoreException
```
    Deletes a document with the given id. This operation is successful even when the document with the given id doesn't exist. If the parameter fieldAsKey is provided, its value will be used as the "_id" to delete the document.
    
    Parameters:
    
    _id - document id
    
    doc - JSON document to be deleted
    
    fieldAsKey - document's field to be used as the key when an id is not passed in and a document doesn't have an "_id" field
    
    Throws:
    
    StoreException
  - delete
```
void delete(@API.NonNullable
            Value _id)
     throws StoreException
```
    Throws:
    
    StoreException
  - delete
```
void delete(@API.NonNullable
            Document doc)
     throws StoreException
```
    Throws:
    
    StoreException
  - delete
```
void delete(@API.NonNullable
            Document doc,
            @API.NonNullable
            FieldPath fieldAsKey)
     throws StoreException
```
    Throws:
    
    StoreException
  - delete
```
void delete(@API.NonNullable
            Document doc,
            @API.NonNullable
            String fieldAsKey)
     throws StoreException
```
    Throws:
    
    StoreException
  - delete
```
void delete(@API.NonNullable
            DocumentStream stream)
     throws MultiOpException
```
    Deletes a set of documents from the DocumentStore represented by the DocumentStream. This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error occurs while writing the documents. Each document read from the DocumentStream must have a field "_id" of type BINARY or UTF8-string; otherwise the operation will fail. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown that contains a list of documents that failed to write to the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the current list of failed document is returned in a multi op exception. The untouched documents will remain in the DocumentStream.
    
    Parameters:
    
    stream - DocumentStream
    
    fieldAsKey - a field from each document whose value is to be used as the document key for deletion
    
    Throws:
    
    MultiOpException - which has a list of write-failed documents and their errors
  - delete
```
void delete(@API.NonNullable
            DocumentStream stream,
            @API.NonNullable
            FieldPath fieldAsKey)
     throws MultiOpException
```
    Throws:
    
    MultiOpException
  - delete
```
void delete(@API.NonNullable
            DocumentStream stream,
            @API.NonNullable
            String fieldAsKey)
     throws MultiOpException
```
    Throws:
    
    MultiOpException
  - insert
```
void insert(@API.NonNullable
            String _id,
            @API.NonNullable
            Document doc)
     throws StoreException
```
    Inserts a document with the given id. This operation is successful only when the document with the given id doesn't exist. "fieldAsKey", when provided, will also be stored as the "_id" field in the written document for the document. If "_id" already existed in the document, then an error will be thrown. When reading the document back from the DB, the key will be returned back as usual as the "_id" field. Note that an insertOrReplace() operation would be more efficient than an insert() call.
    
    Parameters:
    
    doc - JSON document as the new value for the given document
    
    _id - to be used as the key for the document
    
    fieldAsKey - document's field to be used as the key when the id is not passed in and document doesn't have an "_id" field
    
    Throws:
    
    TableNotFoundException - when a DocumentStore does not exist to add this document
    
    ReadOnlyException - when a DocumentStore is not accepting writes
    
    OpNotPermittedException - when the server returned EPERM
    
    DocumentExistsException - when a document with id already exists in DocumentStore
    
    StoreException
  - insert
```
void insert(@API.NonNullable
            Value _id,
            @API.NonNullable
            Document doc)
     throws StoreException
```
    Throws:
    
    StoreException
  - insert
```
void insert(@API.NonNullable
            Document doc)
     throws StoreException
```
    Throws:
    
    StoreException
  - insert
```
void insert(@API.NonNullable
            Document doc,
            @API.NonNullable
            FieldPath fieldAsKey)
     throws StoreException
```
    Throws:
    
    StoreException
  - insert
```
void insert(@API.NonNullable
            Document doc,
            @API.NonNullable
            String fieldAsKey)
     throws StoreException
```
    Throws:
    
    StoreException
  - insert
```
void insert(@API.NonNullable
            DocumentStream stream)
     throws MultiOpException
```
    Inserts a set of documents represented by the DocumentStream into the DocumentStore. This is a synchronous API that won't return until all the documents in the DocumentStream are written to the DocumentStore or some error occurs while writing the documents. Each document read from the DocumentStream must have a field "_id" of type BINARY or UTF8-string; otherwise, the operation will fail or it will be of the Document type. If a document with the given key exists on the server then it throws a document exists exception, similar to the non-DocumentStream based insert() API. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown that contains a list of documents that failed to write to the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the current list of failed document is returned in a multi op exception. The untouched documents will remain in the DocumentStream.
    
    Parameters:
    
    stream - DocumentStream
    
    fieldAsKey - a field from each document whose value is to be used as the document key for deletion
    
    Throws:
    
    MultiOpException - which has a list of write-failed documents and their errors
  - insert
```
void insert(@API.NonNullable
            DocumentStream stream,
            @API.NonNullable
            FieldPath fieldAsKey)
     throws MultiOpException
```
    Throws:
    
    MultiOpException
  - insert
```
void insert(@API.NonNullable
            DocumentStream stream,
            @API.NonNullable
            String fieldAsKey)
     throws MultiOpException
```
    Throws:
    
    MultiOpException
  - replace
```
void replace(@API.NonNullable
             String _id,
             @API.NonNullable
             Document doc)
      throws StoreException
```
    Replaces a document in the DocumentStore. The document id is either explicitly specified as parameter "id" or it is implicitly specified as the field "_id" in the passed document. If the document id is explicitly passed then the document should not contain "_id" field or its value should be the same as the explicitly specified id; otherwise, the operation will fail. If the document with the given key does not exist on the server then it will throw DocumentNotFoundException. "fieldAsKey", when provided, will also be stored as the "_id" field in the written document for the document. If "_id" already existed in the document, then an error will be thrown. When reading the document back from the DB, the key would be returned back as usual as "_id" field. Note that an insertOrReplace() operation would be more efficient than an replace() call.
    
    Parameters:
    
    doc - JSON document as the new value for the given document
    
    _id - to be used as the key for the document
    
    fieldAsKey - document's field to be used as the key when an id is not passed in and document doesn't have an "_id" field
    
    Throws:
    
    TableNotFoundException - when a DocumentStore does not exist to which to add this document
    
    ReadOnlyException - when a DocumentStore is not accepting writes
    
    OpNotPermittedException - when the server returns EPERM
    
    DocumentNotFoundException - when a document with the id does not exist in DocumentStore
    
    StoreException
  - replace
```
void replace(@API.NonNullable
             Value _id,
             @API.NonNullable
             Document doc)
      throws StoreException
```
    Throws:
    
    StoreException
  - replace
```
void replace(@API.NonNullable
             Document doc)
      throws StoreException
```
    Throws:
    
    StoreException
  - replace
```
void replace(@API.NonNullable
             Document doc,
             @API.NonNullable
             FieldPath fieldAsKey)
      throws StoreException
```
    Throws:
    
    StoreException
  - replace
```
void replace(@API.NonNullable
             Document doc,
             @API.NonNullable
             String fieldAsKey)
      throws StoreException
```
    Throws:
    
    StoreException
  - replace
```
void replace(@API.NonNullable
             DocumentStream stream)
      throws MultiOpException
```
    Replaces a set of documents represented by the DocumentStream into the DocumentStore. This is a synchronous API and it won't return until all the documents in the DocumentStream are written to the DocumentStore or some error occurs while writing the documents. Each document read from the DocumentStream must have a field "_id" of type BINARY or UTF8-string; otherwise, the operation will fail or it will be of Document type. If the document with the given key does not exist on the server then it throws, a document not exists exception, similar to the non-DocumentStream based replace() API. If there is an error in reading from the stream or in writing to the DocumentStore then a MultiOpException will be thrown that contains a list of documents that failed to write to the DocumentStore. Reading from a stream stops on the first read error. If only write errors occur, the iterator will stop and the current list of failed document is returned in a multi op exception. The untouched documents will remain in the DocumentStream.
    
    Parameters:
    
    stream - a DocumentStream to read the documents from
    
    fieldAsKey - field from each document whose value is to be used as the document key for deletion
    
    Throws:
    
    MultiOpException - which has list of write-failed documents and their errors
  - replace
```
void replace(@API.NonNullable
             DocumentStream stream,
             @API.NonNullable
             FieldPath fieldAsKey)
      throws MultiOpException
```
    Throws:
    
    MultiOpException
  - replace
```
void replace(@API.NonNullable
             DocumentStream stream,
             @API.NonNullable
             String fieldAsKey)
      throws MultiOpException
```
    Throws:
    
    MultiOpException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               byte inc)
        throws StoreException
```
    Atomically applies an increment to a given field (in dot separated notation) of the given document id. If the field doesn't exist on the server then it will be created with the type of the incremental value. The increment operation can be applied on any of the numeric types, such as byte, short, int, long, float, double, or decimal, of a field. The operation will fail if the increment is applied to a field that is of a non-numeric type. If an id doesn't exist, it gets created (similar to the insertOrReplace behavior). And it is created, with the value of 'inc' parameter. The same logic applies to intermittent paths in the path: they get created top to bottom. If the type is different than the field in the operation, it fails. The increment operation won't change the type of existing value stored in the given field for the document. The resultant value of the field will be truncated based on the original type of the field. For example, if a field 'score' is of type int and contains 60 and an increment of double '5.675' is applied, then the resultant value of the field will be 65 (65.675 will be truncated to 65). If the type to which the increment is applied is a byte, short, or int, then it needs to use long as the operation.
    
    Parameters:
    
    _id - document id
    
    field - the field name in dot separated notation
    
    inc - increment to apply to a field. Can be positive or negative
    
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               short inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               int inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               long inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               float inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               double inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               String _id,
               @API.NonNullable
               String field,
               @API.NonNullable
               BigDecimal inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               byte inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               short inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               int inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               long inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               float inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               double inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - increment
```
void increment(@API.NonNullable
               Value _id,
               @API.NonNullable
               String field,
               @API.NonNullable
               BigDecimal inc)
        throws StoreException
```
    Throws:
    
    StoreException
  - checkAndMutate
```
@Deprecated
boolean checkAndMutate(@API.NonNullable
                                    String _id,
                                    @API.NonNullable
                                    QueryCondition condition,
                                    @API.NonNullable
                                    DocumentMutation mutation)
                             throws StoreException
```
    Deprecated. Use checkAndUpdate(String, QueryCondition, DocumentMutation)
    
    Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document. If an id doesn't exist, the function returns false (no exception is thrown). If the mutation operation fails, it throws exception.
    
    Parameters:
    
    _id - document id
    
    condition - the condition to evaluate on the document
    
    m - mutation to apply on the document
    
    Returns:
    
    True if the condition is true for the document; otherwise, false
    
    Throws:
    
    StoreException - if the condition passes but the mutate fails
  - checkAndMutate
```
@Deprecated
boolean checkAndMutate(@API.NonNullable
                                    Value _id,
                                    @API.NonNullable
                                    QueryCondition condition,
                                    @API.NonNullable
                                    DocumentMutation mutation)
                             throws StoreException
```
    Deprecated. Use checkAndUpdate(Value, QueryCondition, DocumentMutation)
    
    Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document. If an id doesn't exist, the function returns false (no exception is thrown). If the mutation operation fails, it throws exception.
    
    Parameters:
    
    _id - document id
    
    condition - the condition to evaluate on the document
    
    m - mutation to apply on the document
    
    Returns:
    
    True if the condition is true for the document; otherwise, false
    
    Throws:
    
    StoreException - if the condition passes but the mutate fails
  - checkAndUpdate
```
default boolean checkAndUpdate(@API.NonNullable
                               String _id,
                               @API.NonNullable
                               QueryCondition condition,
                               @API.NonNullable
                               DocumentMutation mutation)
                        throws StoreException
```
    Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document. If an id doesn't exist, the function returns false (no exception is thrown). If the mutation operation fails, it throws exception.
    
    Parameters:
    
    _id - document id
    
    condition - the condition to evaluate on the document
    
    m - mutation to apply on the document
    
    Returns:
    
    True if the condition is true for the document; otherwise, false
    
    Throws:
    
    StoreException - if the condition passes but the mutate fails
  - checkAndUpdate
```
default boolean checkAndUpdate(@API.NonNullable
                               Value _id,
                               @API.NonNullable
                               QueryCondition condition,
                               @API.NonNullable
                               DocumentMutation mutation)
                        throws StoreException
```
    Atomically evaluates the condition on a given document and if the condition holds true for the document then a mutation is applied on the document. If an id doesn't exist, the function returns false (no exception is thrown). If the mutation operation fails, it throws exception.
    
    Parameters:
    
    _id - document id
    
    condition - the condition to evaluate on the document
    
    m - mutation to apply on the document
    
    Returns:
    
    True if the condition is true for the document; otherwise, false
    
    Throws:
    
    StoreException - if the condition passes but the mutate fails
  - checkAndDelete
```
boolean checkAndDelete(@API.NonNullable
                       String _id,
                       @API.NonNullable
                       QueryCondition condition)
                throws StoreException
```
    Atomically evaluates the condition on given document and if the condition holds true for the document then it is atomically deleted. If id doesn't exist, returns false (no exception is thrown). If deletion operation fails, it throws exception.
    
    Parameters:
    
    _id - document id
    
    condition - condition to evaluate on the document
    
    Returns:
    
    True if the condition is valid for the document, otherwise false.
    
    Throws:
    
    StoreException - if the condition passes but the delete fails
  - checkAndDelete
```
boolean checkAndDelete(@API.NonNullable
                       Value _id,
                       @API.NonNullable
                       QueryCondition condition)
                throws StoreException
```
    Throws:
    
    StoreException
  - checkAndReplace
```
boolean checkAndReplace(@API.NonNullable
                        String _id,
                        @API.NonNullable
                        QueryCondition condition,
                        @API.NonNullable
                        Document doc)
                 throws StoreException
```
    Atomically evaluates the condition on the given document and if the condition holds true for the document then it atomically replaces the document with the given document. If the id doesn't exist, the function returns false (no exception is thrown). If the replace operation fails, it throws an exception.
    
    Parameters:
    
    _id - document id
    
    condition - the condition to evaluate on the document
    
    doc - document to replace
    
    Returns:
    
    True if the condition is true for the document otherwise false
    
    Throws:
    
    StoreException - if the condition passes but the replace fails
  - checkAndReplace
```
boolean checkAndReplace(@API.NonNullable
                        Value _id,
                        @API.NonNullable
                        QueryCondition condition,
                        @API.NonNullable
                        Document doc)
                 throws StoreException
```
    Throws:
    
    StoreException
  - close
```
void close()
    throws StoreException
```
    Override AutoCloseable.close() to avoid declaring a checked exception.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    StoreException

Interface DocumentStore

Method Summary

Method Detail

isReadOnly

flush

beginTrackingWrites

beginTrackingWrites

endTrackingWrites

clearTrackedWrites

findById

findById

findById

findById

findById

findById

findById

findById

findById

findById

findById

findById

find

find

findQuery

findQuery

find

find

find

find

find

insertOrReplace

insertOrReplace

insertOrReplace

insertOrReplace

insertOrReplace

insertOrReplace

insertOrReplace

insertOrReplace

update

update

delete

delete

delete

delete

delete

delete

delete

delete

insert

insert

insert

insert

insert

insert

insert

insert

replace

replace

replace

replace

replace

replace

replace

replace

increment

increment

increment

increment

increment

increment

increment

increment

increment

increment

increment

increment

increment

increment

checkAndMutate

checkAndMutate