PatchDocumentsQuery Class

Represents query parameters used when updating multiple documents.

Inheritance Hierarchy

SystemObject
ArangoDBNetStandard.DocumentApi.ModelsPatchDocumentsQuery

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

Syntax

public class PatchDocumentsQuery

Public Class PatchDocumentsQuery

public ref class PatchDocumentsQuery

type PatchDocumentsQuery =  class end

The PatchDocumentsQuery type exposes the following members.

Constructors

	Name	Description
	PatchDocumentsQuery	Initializes a new instance of the PatchDocumentsQuery class

Properties

	Name	Description
	IgnoreRevs	By default, or if this is set to true, the _rev attributes in the given documents are ignored. If this is set to false, then any _rev attribute given in a body document is taken as a precondition. The document is only updated if the current revision is the one specified.
	KeepNull	If the intention is to delete existing attributes with the patch command, this query parameter can be used with a value of false. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of null.
	MergeObjects	Controls whether objects (not arrays) will be merged if present in both the existing and the patch document. If set to false, the value in the patch document will overwrite the existing document’s value. If set to true, objects will be merged. The default is true.
	ReturnNew	Return additionally the complete new documents in the result.
	ReturnOld	Return additionally the complete previous revision of the changed documents in the result.
	Silent	If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic.
	WaitForSync	Wait until the new documents have been synced to disk.

Methods

	Name	Description
	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.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)