com.arangodb.model

Class DocumentCreateOptions

java.lang.Object

com.arangodb.model.DocumentCreateOptions

public class DocumentCreateOptions
extends Object

Author:

Mark Vollmary, Michele Rastelli

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
DocumentCreateOptions()

Method Summary

Modifier and Type	Method and Description
Boolean	getMergeObjects()
Boolean	getOverwrite()
OverwriteMode	getOverwriteMode()
Boolean	getReturnNew()
Boolean	getReturnOld()
Boolean	getSilent()
String	getStreamTransactionId()
Boolean	getWaitForSync()
DocumentCreateOptions	mergeObjects(Boolean mergeObjects)
DocumentCreateOptions	overwrite(Boolean overwrite)
DocumentCreateOptions	overwriteMode(OverwriteMode overwriteMode)
DocumentCreateOptions	returnNew(Boolean returnNew)
DocumentCreateOptions	returnOld(Boolean returnOld)
DocumentCreateOptions	silent(Boolean silent)
DocumentCreateOptions	streamTransactionId(String streamTransactionId)
DocumentCreateOptions	waitForSync(Boolean waitForSync)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentCreateOptions

public DocumentCreateOptions()

Method Detail

getWaitForSync

public Boolean getWaitForSync()

waitForSync

public DocumentCreateOptions waitForSync(Boolean waitForSync)

Parameters:

waitForSync - Wait until document has been synced to disk.

Returns:

options

getReturnNew

public Boolean getReturnNew()

returnNew

public DocumentCreateOptions returnNew(Boolean returnNew)

Parameters:

returnNew - Return additionally the complete new document under the attribute new in the result.

Returns:

options

getReturnOld

public Boolean getReturnOld()

returnOld

public DocumentCreateOptions returnOld(Boolean returnOld)

Parameters:

returnOld - Additionally return the complete old document under the attribute old in the result. Only available if the overwrite option is used.

Returns:

options

Since:

ArangoDB 3.4

getOverwrite

public Boolean getOverwrite()

overwrite

public DocumentCreateOptions overwrite(Boolean overwrite)

Parameters:

overwrite - If set to true, the insert becomes a replace-insert. If a document with the same _key already exists the new document is not rejected with unique constraint violated but will replace the old document.

Returns:

options

Since:

ArangoDB 3.4

getOverwriteMode

public OverwriteMode getOverwriteMode()

overwriteMode

public DocumentCreateOptions overwriteMode(OverwriteMode overwriteMode)

Parameters:

overwriteMode - This parameter can be set to replace or update. If given it sets implicitly the overwrite flag. In case it is set to update, the replace-insert becomes an update-insert. Otherwise this option follows the rules of the overwrite parameter.

Returns:

options

Since:

ArangoDB 3.7

getSilent

public Boolean getSilent()

silent

public DocumentCreateOptions silent(Boolean silent)

Parameters:

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.

Returns:

options

getStreamTransactionId

public String getStreamTransactionId()

streamTransactionId

public DocumentCreateOptions streamTransactionId(String streamTransactionId)

Parameters:

streamTransactionId - If set, the operation will be executed within the transaction.

Returns:

options

Since:

ArangoDB 3.5.0

getMergeObjects

public Boolean getMergeObjects()

mergeObjects

public DocumentCreateOptions mergeObjects(Boolean mergeObjects)

Parameters:

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.

Returns:

options

Since:

ArangoDB 3.7