IRPCVaultAdmin.RebuildFullTextSearchIndexes
Administration API / specialized admin session idempotent
Rebuilds the full-text search indexes of the vault: the metadata index, the file data index or both.
| Service | Vault administration MFiles.IRPCVaultAdmin |
|---|---|
| gRPC method | /MFiles.IRPCVaultAdmin/RebuildFullTextSearchIndexes |
| HTTP (mf-http-grpc) | POST /grpc/v1/rebuild-full-text-search-indexes |
| Request | RebuildFullTextSearchIndexesRequest |
| Response | RebuildFullTextSearchIndexesResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session and the vault right
verify_vault. - Returns after asking the M-Files indexing service to rebuild; the indexes are rebuilt in the background. There is no task ID to follow.
- Fails if rebuilding has been disabled on the server ("Rebuilding the full-text search index has been disabled on the server due to performance reasons.").
- To rebuild one specific index, use
ExecuteIndexManagementOperation
with
INDEX_MANAGEMENT_OPERATION_REBUILD.
Request: RebuildFullTextSearchIndexesRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
rebuild_meta_data_index | bool | True to rebuild the index of the metadata (property values). |
rebuild_file_data_index | bool | True to rebuild the index of the file contents. |
Response: RebuildFullTextSearchIndexesResponse
No fields.
Related methods
- ExecuteIndexManagementOperation -- Runs a management operation on one search index of the vault: rebuild, re-index, activate, enable, disable or delete.