xia_engine.document.Batch

class xia_engine.document.Batch(engine)

Bases: object

Batch Operations

Methods

`__init__`(engine)
`clean`()
`commit`([clean_on_failed])	Commit batch
`record_operation`(op, cls, doc_id, content[, log])
`record_original`(cls, doc_id, content)

Attributes

`id`	Batch ID
`engine`	Connected Main Engine

commit(clean_on_failed: bool = False)

Commit batch

Parameters: clean_on_failed – Clean the batch even when the batch is failed
Returns: commit result with error message (in the case of errors)