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

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

#include <gpudb/protocol/show_datasource.h>

Public Member Functions

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

Public Attributes

std::string name
 Name of the data source for which to retrieve information. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showDatasource.

Shows information about a specified data source or all data sources.

Definition at line 20 of file show_datasource.h.

Constructor & Destructor Documentation

◆ ShowDatasourceRequest() [1/2]

gpudb::ShowDatasourceRequest::ShowDatasourceRequest ( )
inline

Constructs a ShowDatasourceRequest object with default parameters.

Definition at line 25 of file show_datasource.h.

◆ ShowDatasourceRequest() [2/2]

gpudb::ShowDatasourceRequest::ShowDatasourceRequest ( const std::string &  name_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowDatasourceRequest object with the specified parameters.

Parameters
[in]name_Name of the data source for which to retrieve information. The name must refer to a currently existing data source. If '*' is specified, information about all data sources will be returned.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 43 of file show_datasource.h.

Member Data Documentation

◆ name

std::string gpudb::ShowDatasourceRequest::name

Name of the data source for which to retrieve information.

The name must refer to a currently existing data source. If '*' is specified, information about all data sources will be returned.

Definition at line 54 of file show_datasource.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 59 of file show_datasource.h.


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