GPUdb C++ API  Version 7.2.3.0
gpudb::CheckTableRequest Struct Reference

A set of parameters for GPUdb::checkTable. More...

#include <gpudb/protocol/check_table.h>

Public Member Functions

 CheckTableRequest ()
 Constructs a CheckTableRequest object with default parameters. More...
 
 CheckTableRequest (const std::vector< std::string > &tableNames_, const std::map< std::string, std::string > &options_)
 Constructs a CheckTableRequest object with the specified parameters. More...
 

Public Attributes

std::vector< std::string > tableNames
 List of tables to query. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::checkTable.

Scans the requested tables as specified in tableNames for integrity. Any table chunks which fail the check will be marked as corrupt. By default the database will automatically repair corrupt tables (via truncating). Note that since this reads every table column from disk it may be a potentially long-running operation. The option local_only can be used to skip any table files already written to a remote storage. Returns table corruption results.

Definition at line 24 of file check_table.h.

Constructor & Destructor Documentation

◆ CheckTableRequest() [1/2]

gpudb::CheckTableRequest::CheckTableRequest ( )
inline

Constructs a CheckTableRequest object with default parameters.

Definition at line 29 of file check_table.h.

◆ CheckTableRequest() [2/2]

gpudb::CheckTableRequest::CheckTableRequest ( const std::vector< std::string > &  tableNames_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a CheckTableRequest object with the specified parameters.

Parameters
[in]tableNames_List of tables to query. An asterisk returns all tables.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 74 of file check_table.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::CheckTableRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 111 of file check_table.h.

◆ tableNames

std::vector<std::string> gpudb::CheckTableRequest::tableNames

List of tables to query.

An asterisk returns all tables.

Definition at line 83 of file check_table.h.


The documentation for this struct was generated from the following file: