Click or drag to resize

ImportDocumentsQuery Class

Inheritance Hierarchy
SystemObject
  ArangoDBNetStandard.BulkOperationsApi.ModelsImportDocumentsQuery

Namespace:  ArangoDBNetStandard.BulkOperationsApi.Models
Assembly:  ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
Syntax
public class ImportDocumentsQuery

The ImportDocumentsQuery type exposes the following members.

Constructors
  NameDescription
Public methodImportDocumentsQuery
Initializes a new instance of the ImportDocumentsQuery class
Top
Properties
  NameDescription
Public propertyCollection
Required. Used to specify the target collection for the import. Importing data into a non-existing collection will produce an error.
Public propertyComplete
Optional. The complete query parameter can be set to true to make the entire import fail if any of the uploaded documents is invalid and cannot be imported. In this case, no documents will be imported by the import run, even if a failure happens at the end of the import. If complete has a value other than true, valid documents will be imported while invalid documents will be rejected, meaning only some of the uploaded documents might have been imported.
Public propertyDetails
Optional. The details query parameter can be set to true to make the import API return details about documents that could not be imported. If details is true, then the result will also contain a details attribute which is an array of detailed error messages. If the details is set to false or omitted, no details will be returned.
Public propertyFromPrefix
Optional. An optional prefix for the values in _from attributes. If specified, the value is automatically prepended to each _from input value. This allows specifying just the keys for _from.
Public propertyOnDuplicate
Controls what action is carried out in case of a unique key constraint violation.
Public propertyOverwrite
If this parameter has a value of true or yes, then all data in the collection will be removed prior to the import. Note that any existing index definitions will be preserved.
Public propertyToPrefix
Optional. An optional prefix for the values in _to attributes. If specified, the value is automatically prepended to each _to input value. This allows specifying just the keys for _to.
Public propertyType
Required for [!:BulkOperationsApiClient.PostImportDocumentObjectsAsync(ImportDocumentsQuery, ImportDocumentObjectsBody)] Determines how the body of the request will be interpreted. Type can have the following values: 1) documents: When this type is used, each line in the request body is expected to be an individual JSON-encoded document. Multiple JSON objects in the request body need to be separated by newlines. 2) list: When this type is used, the request body must contain a single JSON-encoded array of individual objects to import. 3) auto: if set, this will automatically determine the body type
Public propertyWaitForSync
Optional. Can be set to true to make the import only return if all documents have been synced to disk.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also