Previous Next JavaScript must be enabled to correctly display this content

## plan verify-data

post

/V0/nosql/admin/plan#verify-data

`verifyLog` verifies the checksum of each data record in the log file of JE. It is enabled by default.

`logReadDelay` configures the the delay time between file reads and the default value is 100 millisecond.

`verifyBtree` verifies that the b-tree of database in memory contains the valid reference to each data record in disk. It is enabled by default.

`btreeBatchDelay` configures the delay time, in milliseconds, between batches (1000 records) and the default value is 10 milliseconds.

`verifyBtree` can be combined with `datarecord` and `index.`

`datarecord` is disabled by default. If it is enabled, the plan will read and verify data records on disk which are not in the cache. This will take longer and cause more read IO.

`index` is enabled by default. It runs verification on indexes.

`dataRecord` needs to be enabled to do a full verification. If `datarecord` is disabled, the command will only verify the reference from index to primary table, but not the reference from primary table to index.

Users can run the verification on either the specified service using `service,` or all service instances of the specified type or all types that are deployed to the specified zone or all zones using one of the `all-*` flags. A `all-*` flag can be combined with `zn` or `znname` to verify data on all instances of the service type deployed to the specified zone. If one of the `all-*` flags is used without also specifying the zone, then the verification will be run on all instances of the specified type or all types within the store, regardless of zone.

### Request

There are no request parameters for this operation.

Supported Media Types

- application/json

Request Body - application/json ()
Root Schema : schema
Type: `object`
Show Source

- arguments: array arguments
- command(required): string
  Allowed Values: `[ "verify-data" ]`

    {
        "required":[
            "command"
        ],
        "properties":{
            "command":{
                "type":"string",
                "enum":[
                    "verify-data"
                ]
            },
            "arguments":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "argumentName":{
                            "type":"string"
                        },
                        "argumentValue":{
                            "oneOf":[
                                {
                                    "type":"string"
                                },
                                {
                                    "type":"boolean"
                                }
                            ]
                        }
                    }
                }
            }
        },
        "example":{
            "command":"verify-data",
            "arguments":[
                {
                    "verifyLog":"enable|disable Whether to verify logs"
                },
                {
                    "logReadDelay":"Log read delay in milliseconds"
                },
                {
                    "verifyBtree":"enable|disable Whether to verify btree"
                },
                {
                    "btreeBatchDelay":"Btree batch delay in milliseconds"
                },
                {
                    "index":"enable|disable Whether to verify index"
                },
                {
                    "datarecord":"enable|disable Whether to verify data records"
                },
                {
                    "service":"Id of the service to run verification"
                },
                {
                    "allServices":"true|false Whether to verify all services"
                },
                {
                    "zn":"Id of the zone to verify services in zone"
                },
                {
                    "znname":"Name of the zone to verify services in zone"
                },
                {
                    "allRns":"true|false Whether to verify all RNs"
                },
                {
                    "allAdmins":"true|false Whether to verify all Admins"
                }
            ]
        }
    }

Example:

    {
        "command":"verify-data",
        "arguments":[
            {
                "verifyLog":"enable|disable Whether to verify logs"
            },
            {
                "logReadDelay":"Log read delay in milliseconds"
            },
            {
                "verifyBtree":"enable|disable Whether to verify btree"
            },
            {
                "btreeBatchDelay":"Btree batch delay in milliseconds"
            },
            {
                "index":"enable|disable Whether to verify index"
            },
            {
                "datarecord":"enable|disable Whether to verify data records"
            },
            {
                "service":"Id of the service to run verification"
            },
            {
                "allServices":"true|false Whether to verify all services"
            },
            {
                "zn":"Id of the zone to verify services in zone"
            },
            {
                "znname":"Name of the zone to verify services in zone"
            },
            {
                "allRns":"true|false Whether to verify all RNs"
            },
            {
                "allAdmins":"true|false Whether to verify all Admins"
            }
        ]
    }

Nested Schema : arguments
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "argumentName":{
                    "type":"string"
                },
                "argumentValue":{
                    "oneOf":[
                        {
                            "type":"string"
                        },
                        {
                            "type":"boolean"
                        }
                    ]
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- argumentName: string
- argumentValue: argumentValue

    {
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }

Nested Schema : argumentValue
Match One Schema
Show Source

- string
- boolean

    {
        "oneOf":[
            {
                "type":"string"
            },
            {
                "type":"boolean"
            }
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json

#### 200 Response

Operation ended successfully
Body ()
Root Schema : commonResponse
Type: `object`
Show Source

- description(required): string
- operation(required): string
- returnCode(required): string
- returnValue(required): object returnValue

    {
        "properties":{
            "operation":{
                "type":"string"
            },
            "returnCode":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "returnValue":{
                "type":"object"
            }
        },
        "example":{
            "operation":"operation executed",
            "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
            "description":"error description when returnCode != 5000",
            "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
        },
        "required":[
            "operation",
            "returnCode",
            "description",
            "returnValue"
        ]
    }

Example:

    {
        "operation":"operation executed",
        "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
        "description":"error description when returnCode != 5000",
        "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
    }

Nested Schema : returnValue
Type: `object`
Back to Top