GPUdb C++ API  Version 7.2.2.4
gpudb::UpdateRecordsBySeriesRequest Struct Reference

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

#include <gpudb/protocol/update_records_by_series.h>

Public Member Functions

 UpdateRecordsBySeriesRequest ()
 Constructs an UpdateRecordsBySeriesRequest object with default parameters. More...
 
 UpdateRecordsBySeriesRequest (const std::string &tableName_, const std::string &worldTableName_, const std::string &viewName_, const std::vector< std::string > &reserved_, const std::map< std::string, std::string > &options_)
 Constructs an UpdateRecordsBySeriesRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 Name of the view on which the update operation will be performed, in [ schema_name. ]view_name format, using standard name resolution rules. More...
 
std::string worldTableName
 Name of the table containing the complete series (track) information, in [ schema_name. ]table_name format, using standard name resolution rules. More...
 
std::string viewName
 Name of the view containing the series (tracks) which have to be updated, in [ schema_name. ]view_name format, using standard name resolution rules. More...
 
std::vector< std::string > reserved
 The default value is an empty vector. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::updateRecordsBySeries.

Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.

Definition at line 20 of file update_records_by_series.h.

Constructor & Destructor Documentation

◆ UpdateRecordsBySeriesRequest() [1/2]

gpudb::UpdateRecordsBySeriesRequest::UpdateRecordsBySeriesRequest ( )
inline

Constructs an UpdateRecordsBySeriesRequest object with default parameters.

Definition at line 26 of file update_records_by_series.h.

◆ UpdateRecordsBySeriesRequest() [2/2]

gpudb::UpdateRecordsBySeriesRequest::UpdateRecordsBySeriesRequest ( const std::string &  tableName_,
const std::string &  worldTableName_,
const std::string &  viewName_,
const std::vector< std::string > &  reserved_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an UpdateRecordsBySeriesRequest object with the specified parameters.

Parameters
[in]tableName_Name of the view on which the update operation will be performed, in [schema_name.]view_name format, using standard name resolution rules. Must be an existing view.
[in]worldTableName_Name of the table containing the complete series (track) information, in [schema_name.]table_name format, using standard name resolution rules.
[in]viewName_Name of the view containing the series (tracks) which have to be updated, in [schema_name.]view_name format, using standard name resolution rules. The default value is ''.
[in]reserved_The default value is an empty vector.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 63 of file update_records_by_series.h.

Member Data Documentation

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 104 of file update_records_by_series.h.

◆ reserved

std::vector<std::string> gpudb::UpdateRecordsBySeriesRequest::reserved

The default value is an empty vector.

Definition at line 99 of file update_records_by_series.h.

◆ tableName

std::string gpudb::UpdateRecordsBySeriesRequest::tableName

Name of the view on which the update operation will be performed, in [ schema_name. ]view_name format, using standard name resolution rules.

Must be an existing view.

Definition at line 78 of file update_records_by_series.h.

◆ viewName

std::string gpudb::UpdateRecordsBySeriesRequest::viewName

Name of the view containing the series (tracks) which have to be updated, in [ schema_name. ]view_name format, using standard name resolution rules.

The default value is ''.

Definition at line 94 of file update_records_by_series.h.

◆ worldTableName

std::string gpudb::UpdateRecordsBySeriesRequest::worldTableName

Name of the table containing the complete series (track) information, in [ schema_name. ]table_name format, using standard name resolution rules.

Definition at line 86 of file update_records_by_series.h.


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