IDocumentApiClientPatchDocumentsAsyncT, U Method

Partially updates documents, the documents to update are specified by the _key attributes in the body objects.The body of the request must contain a JSON array of document updates with the attributes to patch(the patch documents). 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}

Namespace: ArangoDBNetStandard.DocumentApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0

Syntax

C++

Copy

Task<PatchDocumentsResponse<U>> PatchDocumentsAsync<T, U>(
	string collectionName,
	IList<T> patches,
	PatchDocumentsQuery query = null,
	ApiClientSerializationOptions serializationOptions = null,
	DocumentHeaderProperties headers = null
)

Function PatchDocumentsAsync(Of T, U) ( 
	collectionName As String,
	patches As IList(Of T),
	Optional query As PatchDocumentsQuery = Nothing,
	Optional serializationOptions As ApiClientSerializationOptions = Nothing,
	Optional headers As DocumentHeaderProperties = Nothing
) As Task(Of PatchDocumentsResponse(Of U))

generic<typename T, typename U>
Task<PatchDocumentsResponse<U>^>^ PatchDocumentsAsync(
	String^ collectionName, 
	IList<T>^ patches, 
	PatchDocumentsQuery^ query = nullptr, 
	ApiClientSerializationOptions^ serializationOptions = nullptr, 
	DocumentHeaderProperties^ headers = nullptr
)

abstract PatchDocumentsAsync : 
        collectionName : string * 
        patches : IList<'T> * 
        ?query : PatchDocumentsQuery * 
        ?serializationOptions : ApiClientSerializationOptions * 
        ?headers : DocumentHeaderProperties 
(* Defaults:
        let _query = defaultArg query null
        let _serializationOptions = defaultArg serializationOptions null
        let _headers = defaultArg headers null
*)
-> Task<PatchDocumentsResponse<'U>>

Parameters

collectionName: Type: SystemString
patches: Type: System.Collections.GenericIListT
query (Optional): Type: ArangoDBNetStandard.DocumentApi.ModelsPatchDocumentsQuery
serializationOptions (Optional): Type: ArangoDBNetStandard.SerializationApiClientSerializationOptions
The serialization options. When the value is null the the serialization options should be provided by the serializer, otherwise the given options should be used.
headers (Optional): Type: ArangoDBNetStandard.DocumentApi.ModelsDocumentHeaderProperties
The DocumentHeaderProperties values.

Type Parameters

T: Type of the patch object used to partially update documents.
U: Type of the returned documents, only applies when ReturnNew or ReturnOld are used.

Return Value

Type: TaskPatchDocumentsResponseU

Reference

IDocumentApiClient Interface

ArangoDBNetStandard.DocumentApi Namespace

IDocumentApiClientAddLanguageSpecificTextSet("LST59339F10_0?cpp=::|nu=.");PatchDocumentsAsyncAddLanguageSpecificTextSet("LST59339F10_1?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");T, UAddLanguageSpecificTextSet("LST59339F10_2?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Method

Parameters

Type Parameters

Return Value

Reference

IDocumentApiClientPatchDocumentsAsyncT, U Method