ImportDocumentsQuery Properties |
The ImportDocumentsQuery type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Collection |
Required. Used to specify the target
collection for the import. Importing
data into a non-existing collection
will produce an error.
|
| Complete |
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.
|
| Details |
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.
|
| FromPrefix |
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.
|
| OnDuplicate |
Controls what action is carried out in case
of a unique key constraint violation.
|
| Overwrite |
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.
|
| ToPrefix |
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.
|
| Type |
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
|
| WaitForSync |
Optional. Can be set to true to make the import
only return if all documents have
been synced to disk.
|
See Also