Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/admin/verifydb

URL: http://<db.host>:<db.port>/admin/verifydb

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.

Input Parameter Description

NameTypeDescription
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
rebuild_on_error

[DEPRECATED -- Use the Rebuild DB feature of GAdmin instead.] The default value is false. The supported values are:

  • true
  • false
verify_nulls

When true, verifies that null values are set to zero The default value is false. The supported values are:

  • true
  • 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. The default value is false. The supported values are:

  • true
  • 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. The default value is true. The supported values are:

  • true
  • false
verify_rank0

If true, compare rank0 table metadata against workers' metadata The default value is false. The supported values are:

  • true
  • false
delete_orphaned_tables

If true, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. Must set verify_persist in input parameter options to true. It is recommended to run this while the database is offline OR set concurrent_safe in input parameter options to true The default value is false. The supported values are:

  • true
  • false
verify_orphaned_tables_only

If true, only the presence of orphaned table directories will be checked, all persistence checks will be skipped The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'admin_verify_db_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /admin/verifydb endpoint:

NameTypeDescription
verified_okbooleanTrue if no errors were found, false otherwise. The default value is false.
error_listarray of stringsList of errors found while validating the database internal state. The default value is an empty array ( [] ).
orphaned_tables_total_sizelongIf 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.
infomap of string to stringsAdditional information.

Empty string in case of an error.