Indexing data source (version 2) (IRPCIndexingDataSource2)
More methods for search indexers, continuing IRPCIndexingDataSource.
| gRPC service | MFiles.IRPCIndexingDataSource2 |
|---|---|
| Book and level | Server integration API, specialized |
| Methods | 5 |
| Proto file | mfiles/IRPCIndexingDataSource2.proto |
Overview
For M-Files components only. M-Files' cloud search indexing services use these methods together with the combined enumerator of IRPCIndexingDataSource (GetNextObjectsForIX). Applications should not call them; to search, use IRPCSearch.
- Rights: a vault session with the vault rights
see_all_objectsandsee_deleted_objects; no server role is needed. A normal user is denied. The data is returned regardless of the caller's object permissions; the objects' own permissions are included for the index. - Tasks: value list items for the index (GetValueListItemsForIX), one object by ID (GetObjectForIXById), the extracted text of a file (GetTextContentForFileForIX), the index configuration (GetIndexConfigurationsForIX), and the current crawl position (GetCurrentTimestampForIX).
- Only for vaults that the server hosts itself; external (unmanaged) objects and files are not supported and fail with "Not implemented." (0x80004001).
Methods
| Method | Summary | Facts |
|---|---|---|
| GetCurrentTimestampForIX | Gets the vault's current crawl position for the combined enumerator: a crawl that starts there sees every change committed after the call and none committed before it. | internal: not for applications read session idempotent |
| GetIndexConfigurationsForIX | Gets the vault's search index configuration as JSON, without secrets, plus the vault settings that an index built from it must agree on. | internal: not for applications read session idempotent |
| GetObjectForIXById | Gets the index data of one object by its ID: the same data that GetNextObjectsForIX returns for the latest checked-in version and, if requested, the checked-out version. | internal: not for applications read session idempotent |
| GetTextContentForFileForIX | Gets the text that the server extracts from a file version for indexing, in the response. | internal: not for applications read session idempotent |
| GetValueListItemsForIX | Gets the items of one value list for a search index: all items page by page, or the changes since a known version. | internal: not for applications read session idempotent |