Skip to main content

A set of parameters for GPUdb::dropSession. More…

#include <gpudb/protocol/drop_session.h>

Public Member Functions

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

Public Attributes

std::map< std::string, std::string > options
 Optional parameters.
 

Detailed Description

A set of parameters for GPUdb::dropSession.

Ends the client session named by the X-Kinetica-Session HTTP header of this request, dropping every session temp table (a table created in SQL as #name) that belongs to it. Objects outside the session that depend on those tables are invalidated, not dropped.

A client sends its session ID in the X-Kinetica-Session HTTP header to every endpoint (e.g., /execute/sql), and needs to call this endpoint only when a response’s info map has carried session_id_used set to true.

Only the user that owns the session, or a system administrator, may drop it. Dropping an unknown session is a no-op.

Definition at line 28 of file drop_session.h.

Constructor & Destructor Documentation

◆ DropSessionRequest() [1/2]

gpudb::DropSessionRequest::DropSessionRequest ()
inline

Constructs a DropSessionRequest object with default parameters.

Definition at line 33 of file drop_session.h.

◆ DropSessionRequest() [2/2]

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

Constructs a DropSessionRequest object with the specified parameters.

Parameters
[in]options_Optional parameters. The default value is an empty map.

Definition at line 45 of file drop_session.h.

Member Data Documentation

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 53 of file drop_session.h.


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