Verify database is in a consistent state. When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
Parameters
Optional parameters. Allowed keys are:
rebuild_on_error – [DEPRECATED] Use the Rebuild DB feature of GAdmin instead. Allowed values are:
true
false
The default value is ‘false’.
verify_nulls – When true, verifies that null values are set to zero. Allowed values are:
true
false
The default value is ‘false’.
verify_persist – When true, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set concurrent_safe in input parameter options to true or place the database offline. Allowed values are:
true
false
The default value is ‘false’.
concurrent_safe – When true, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Allowed values are:
true
false
The default value is ‘true’.
verify_rank0 – If true, compare rank0 table metadata against workers’ metadata. Allowed values are:
true
false
The default value is ‘false’.
delete_orphaned_tables – If true, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set concurrent_safe in input parameter options to true. Allowed values are:
true
false
The default value is ‘false’.
verify_orphaned_tables_only – If true, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Allowed values are:
true
false
The default value is ‘false’.
table_includes – Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with table_excludes.
table_excludes – Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with table_includes.
The default value is an empty dict ( ).
Returns
A dict with the following entries–
True if no errors were found, false otherwise. The default value is False.
List of errors found while validating the database internal state. The default value is an empty list ( [] ).
If verify_persist is true, verify_orphaned_tables_only is true or delete_orphaned_tables is true, this is the sum in bytes of all orphaned tables found. Otherwise, -1.
Additional information.