DocumentApiClient Class |
Provides access to ArangoDB document API.
Inheritance HierarchyNamespace: ArangoDBNetStandard.DocumentApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe DocumentApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DocumentApiClient(IApiClientTransport) |
Creates an instance of DocumentApiClient
using the provided transport layer and the default JSON serialization.
|
| DocumentApiClient(IApiClientTransport, IApiClientSerialization) |
Creates an instance of DocumentApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteDocumentAsync(String, DeleteDocumentQuery, DocumentHeaderProperties) |
Delete a document based on its document ID.
|
| DeleteDocumentAsync(String, String, DeleteDocumentQuery, DocumentHeaderProperties) |
Delete a document.
|
| DeleteDocumentAsyncT(String, DeleteDocumentQuery, DocumentHeaderProperties) |
Delete a document based on its document ID.
|
| DeleteDocumentAsyncT(String, String, DeleteDocumentQuery, DocumentHeaderProperties) |
Delete a document.
|
| DeleteDocumentsAsync(String, IListString, DeleteDocumentsQuery, DocumentHeaderProperties) |
Delete multiple documents based on the passed document selectors.
A document selector is either the document ID or the document Key.
|
| DeleteDocumentsAsyncT(String, IListString, DeleteDocumentsQuery, DocumentHeaderProperties) |
Delete multiple documents based on the passed document selectors.
A document selector is either the document ID or the document Key.
|
 | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetDocumentAsyncT(String, DocumentHeaderProperties) |
Get an existing document based on its Document ID.
|
| GetDocumentAsyncT(String, String, DocumentHeaderProperties) |
Get an existing document.
|
| GetDocumentsAsyncT |
Get multiple documents.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetHeaderCollection |
Method to get the header collection.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HeadDocumentAsync(String, DocumentHeaderProperties) |
Like GET, but only returns the header fields and not the body. You
can use this call to get the current revision of a document or check if
the document was deleted.
HEAD/_api/document/{document-handle}
|
| HeadDocumentAsync(String, String, DocumentHeaderProperties) |
Like GET, but only returns the header fields and not the body. You
can use this call to get the current revision of a document or check if
the document was deleted.
HEAD /_api/document/{document-handle}
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PatchDocumentAsyncT, U(String, T, PatchDocumentQuery, ApiClientSerializationOptions, DocumentHeaderProperties) |
Partially updates the document identified by document-handle.
The body of the request must contain a JSON document with the
attributes to patch(the patch document). All attributes from the
patch document will be added to the existing document if they do not
yet exist, and overwritten in the existing document if they do exist
there.
PATCH/_api/document/{document-handle}
|
| PatchDocumentAsyncT, U(String, String, T, PatchDocumentQuery, DocumentHeaderProperties) |
Partially updates the document identified by document-handle.
The body of the request must contain a JSON document with the
attributes to patch(the patch document). All attributes from the
patch document will be added to the existing document if they do not
yet exist, and overwritten in the existing document if they do exist
there.
PATCH/_api/document/{document-handle}
|
| PatchDocumentsAsyncT, U |
Partially updates documents, the documents to update are specified
by the _key attributes in the body objects. All attributes from the
patch documents will be added to the existing documents if they do
not yet exist, and overwritten in the existing documents if they do
exist there.
Setting an attribute value to null in the patch documents will cause a
value of null to be saved for the attribute by default.
If ignoreRevs is false and there is a _rev attribute in a
document in the body and its value does not match the revision of
the corresponding document in the database, the precondition is
violated.
PATCH /_api/document/{collection}
|
| PostDocumentAsyncT(String, T, PostDocumentsQuery, ApiClientSerializationOptions, DocumentHeaderProperties) |
Post a single document.
|
| PostDocumentAsyncT, U(String, T, PostDocumentsQuery, ApiClientSerializationOptions, DocumentHeaderProperties) |
Post a single document with the possibility to specify a different type
for the new document object returned in the response.
|
| PostDocumentsAsyncT |
Post multiple documents in a single request.
|
| PutDocumentAsyncT(String, T, PutDocumentQuery, ApiClientSerializationOptions, DocumentHeaderProperties) |
Replaces the document with the provided document ID with the one in
the body, provided there is such a document and no precondition is
violated.
|
| PutDocumentAsyncT(String, String, T, PutDocumentQuery, DocumentHeaderProperties) |
Replaces the document based on its Document ID with the one in
the body, provided there is such a document and no precondition is
violated.
|
| PutDocumentsAsyncT |
Replace multiple documents.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _client |
The transport client used to communicate with the ArangoDB host.
|
| _docApiPath |
The root path of the API.
|
See Also