com.arangodb.util

Class ImportOptions

java.lang.Object

com.arangodb.util.ImportOptions

All Implemented Interfaces:

OptionsInterface

Direct Known Subclasses:

ImportOptionsJson

public class ImportOptions
extends Object
implements OptionsInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportOptions.OnDuplicate

Constructor Summary

Constructors

Constructor and Description
ImportOptions()

Method Summary

Modifier and Type	Method and Description
Boolean	getComplete() (optional) If set to true, it will make the whole import fail if any error occurs.
Boolean	getDetails() (optional) If set to true, the result will include an attribute details with details about documents that could not be imported.
ImportOptions.OnDuplicate	getOnDuplicate() (optional) Controls what action is carried out in case of a unique key constraint violation.
Boolean	getOverwrite() overwrite (optional): If this parameter has a value of true, then all data in the collection will be removed prior to the import.
Boolean	getWaitForSync() (optional) Wait until documents have been synced to disk before returning.
ImportOptions	setComplete(Boolean complete) (optional) If set to true, it will make the whole import fail if any error occurs.
ImportOptions	setDetails(Boolean details) (optional) If set to true, the result will include an attribute details with details about documents that could not be imported.
ImportOptions	setOnDuplicate(ImportOptions.OnDuplicate onDuplicate) (optional) Controls what action is carried out in case of a unique key constraint violation.
ImportOptions	setOverwrite(Boolean overwrite) overwrite (optional): If this parameter has a value of true, then all data in the collection will be removed prior to the import.
ImportOptions	setWaitForSync(Boolean waitForSync) (optional) Wait until documents have been synced to disk before returning.
Map<String,Object>	toMap()

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportOptions

public ImportOptions()

Method Detail

getOverwrite

public Boolean getOverwrite()

overwrite (optional): If this parameter has a value of true, then all data in the collection will be removed prior to the import. Note that any existing index definitions will be preseved.

Returns:

setOverwrite

public ImportOptions setOverwrite(Boolean overwrite)

overwrite (optional): If this parameter has a value of true, then all data in the collection will be removed prior to the import. Note that any existing index definitions will be preseved.

Parameters:

overwrite -

Returns:

this ImportOptions object

getWaitForSync

public Boolean getWaitForSync()

(optional) Wait until documents have been synced to disk before returning.

Returns:

setWaitForSync

public ImportOptions setWaitForSync(Boolean waitForSync)

(optional) Wait until documents have been synced to disk before returning.

Parameters:

waitForSync -

Returns:

this ImportOptions object

getOnDuplicate

public ImportOptions.OnDuplicate getOnDuplicate()

(optional) Controls what action is carried out in case of a unique key constraint violation. Possible values are: OnDuplicate.ERROR: this will not import the current document because of the unique key constraint violation. This is the default setting. OnDuplicate.UPDATE: this will update an existing document in the database with the data specified in the request. Attributes of the existing document that are not present in the request will be preseved. OnDuplicate.REPLACE: this will replace an existing document in the database with the data specified in the request. OnDuplicate.IGNORE: this will not update an existing document and simply ignore the error caused by the unique key constraint violation.

Returns:

setOnDuplicate

public ImportOptions setOnDuplicate(ImportOptions.OnDuplicate onDuplicate)

(optional) Controls what action is carried out in case of a unique key constraint violation. Possible values are: OnDuplicate.ERROR: this will not import the current document because of the unique key constraint violation. This is the default setting. OnDuplicate.UPDATE: this will update an existing document in the database with the data specified in the request. Attributes of the existing document that are not present in the request will be preseved. OnDuplicate.REPLACE: this will replace an existing document in the database with the data specified in the request. OnDuplicate.IGNORE: this will not update an existing document and simply ignore the error caused by the unique key constraint violation.

Parameters:

onDuplicate -

Returns:

this ImportOptions object

getComplete

public Boolean getComplete()

(optional) If set to true, it will make the whole import fail if any error occurs. Otherwise the import will continue even if some documents cannot be imported.

Returns:

setComplete

public ImportOptions setComplete(Boolean complete)

(optional) If set to true, it will make the whole import fail if any error occurs. Otherwise the import will continue even if some documents cannot be imported.

Parameters:

complete -

Returns:

this ImportOptions object

getDetails

public Boolean getDetails()

(optional) If set to true, the result will include an attribute details with details about documents that could not be imported.

Returns:

setDetails

public ImportOptions setDetails(Boolean details)

(optional) If set to true, the result will include an attribute details with details about documents that could not be imported.

Parameters:

details -

Returns:

this ImportOptions object

toMap

public Map<String,Object> toMap()

Specified by:

toMap in interface OptionsInterface