Dart 2.x

mReplace

Replaces multiple documents.


Arguments

Copied to clipboard!
Future<Map<String, dynamic>> mReplace(
    String index,
    String collection,
    List<Map<String, dynamic>> documents,
    { bool waitForRefresh = false, })
Arguments Type Description
index
String
Index
collection
String
Collection
documents
List<Map<String, dynamic>>
List containing the documents to replace
waitForRefresh
bool

(false)
If set to true, Kuzzle will wait for the persistence layer to finish indexing

documents

Each document has the following properties:

Arguments Type Description
_id
String
Optional document ID. Will be auto-generated if not defined.
body
Map<String, dynamic>
Document body

Return

A Map<String, dynamic> which has a successes and errors: Each created document is an object of the successes array with the following properties:

Property Type Description
_source
Map<String, dynamic>
Created document
_id
String
ID of the replaced document
_version
int
Version of the document in the persistent data storage

Each errored document is an object of the errors array with the following properties:

Property Type Description
document
Map<String, dynamic>
Document that causes the error
status
int
HTTP error status
reason
String
Human readable reason

Usage

Copied to clipboard!
final result = await kuzzle
  .document
  .mReplace('nyc-open-data', 'yellow-taxi', [
    {
      '_id': 'some-id',
      'body': {
        'name': 'Smith'
      }
    }, 
    {
      '_id': 'some-id2',
      'body': {
        'name': 'Freeman'
      }
    }
  ]);