IDocumentWriter<TDocument> Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An interface to clients for all document oriented (or NoSQL) databases for document write operations. https://en.wikipedia.org/wiki/Document-oriented_database.
generic <typename TDocument>
public interface class IDocumentWriterpublic interface IDocumentWriter<TDocument>type IDocumentWriter<'Document> = interfacePublic Interface IDocumentWriter(Of TDocument)Type Parameters
- TDocument
The document entity type to be used as a table schema. Request results will be mapped to instance of this type.
Methods
| CreateDocumentAsync(RequestOptions<TDocument>, CancellationToken) |
Creates a document provided at Document. |
| DeleteDocumentAsync(RequestOptions<TDocument>, String, CancellationToken) |
Deletes a document associated with the id. |
| ExecuteTransactionalBatchAsync(RequestOptions<TDocument>, IReadOnlyList<BatchItem<TDocument>>, CancellationToken) |
Transactionally executes a set of operations. |
| InsertOrUpdateDocumentAsync(RequestOptions<TDocument>, String, Func<TDocument,TDocument>, CancellationToken) |
Tries to insert or update a document with provided document id with value provided in Document. |
| PatchDocumentAsync(RequestOptions<TDocument>, String, IReadOnlyList<PatchOperation>, String, CancellationToken) |
Patches a document. |
| ReplaceDocumentAsync(RequestOptions<TDocument>, String, CancellationToken) |
Replaces a document having provided id with Document. |
| UpsertDocumentAsync(RequestOptions<TDocument>, CancellationToken) |
Upserts a document provided in Document. |
