Data export (IRPCDataExport)
Reads objects, value list items and property value history in bulk, in batches ordered by ID, for exporting vault data to another system.
| gRPC service | MFiles.IRPCDataExport |
|---|---|
| Book and level | Vault API, standard |
| Methods | 5 |
| Proto file | mfiles/IRPCDataExport.proto |
Overview
The methods are built for bulk reading with stable paging: each batch continues after the last ID the caller received. M-Files Reporting uses them to fill reporting databases (see IRPCExportedDataSets), but they work for any session and always apply the caller's permissions.
A typical export of one object type:
- Page through the objects with
SearchExportedObjects: conditions that
select one object type,
last_received_obj_id0 first, then the ID of the last object received, until a batch comes back empty. - Read the properties of each batch with GetExportedObjectProperties.
- Optionally read how a property changed over time with GetPropertyValueHistory.
- Page through the value lists that the properties refer to with GetExportedValueListItems, or fetch single items with GetExportedValueListItemsByID.
All methods need a vault session and no special vault rights; objects, values and items the user cannot see are left out. For interactive searches use SearchObjects instead.
Methods
| Method | Summary | Facts |
|---|---|---|
| GetExportedObjectProperties | Gets the version information and property values of many objects in one call. | read session idempotent |
| GetExportedValueListItems | Gets the items of a value list in batches ordered by item ID. | read session idempotent |
| GetExportedValueListItemsByID | Gets the given items of a value list. | read session idempotent |
| GetPropertyValueHistory | Gets how one property of each given object changed over the object's versions. | read session idempotent |
| SearchExportedObjects | Searches objects in batches ordered by object ID, for paging through all objects that match. | read session idempotent |