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

#include <gpudb/protocol/show_resource_objects.h>

Public Member Functions
	ShowResourceObjectsRequest ()
	Constructs a ShowResourceObjectsRequest object with default parameters. More...

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

Public Attributes
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::showResourceObjects.

Returns information about the internal sub-components (tiered objects) which use resources of the system. The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.

Definition at line 22 of file show_resource_objects.h.

Constructor & Destructor Documentation

◆ ShowResourceObjectsRequest() [1/2]

gpudb::ShowResourceObjectsRequest::ShowResourceObjectsRequest ( )

inline

Constructs a ShowResourceObjectsRequest object with default parameters.

Definition at line 28 of file show_resource_objects.h.

◆ ShowResourceObjectsRequest() [2/2]

gpudb::ShowResourceObjectsRequest::ShowResourceObjectsRequest ( const std::map< std::string, std::string > & options_ )

inline

Constructs a ShowResourceObjectsRequest object with the specified parameters.

Parameters

[in]

options_

Optional parameters.

show_resource_objects_tiers: Comma-separated list of tiers to query, leave blank for all tiers.
show_resource_objects_expression: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
show_resource_objects_order_by: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
show_resource_objects_limit: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. The default value is '100'.
show_resource_objects_table_names: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.

The default value is an empty map.

Definition at line 105 of file show_resource_objects.h.

Member Data Documentation

◆ options

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

Optional parameters.

show_resource_objects_tiers: Comma-separated list of tiers to query, leave blank for all tiers.
show_resource_objects_expression: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
show_resource_objects_order_by: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
show_resource_objects_limit: An integer indicating the maximum number of results to be returned, per rank, or (-1) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. The default value is '100'.
show_resource_objects_table_names: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.

The default value is an empty map.

Definition at line 159 of file show_resource_objects.h.

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

gpudb/protocol/show_resource_objects.h