/admin/verifydb

URL: http://GPUDB_IP_ADDRESS:GPUDB_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
The default value is false. The supported values are:
  • true
  • false
verify_nulls

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

  • true
  • false
verify_persist
The default value is false. The supported values are:
  • true
  • false
concurrent_safe

When enabled, 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

When enabled, compares rank0 table meta-data against workers meta-data 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_request' 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 ( [] ).
infomap of string to stringsAdditional information.

Empty string in case of an error.