GPUdb C++ API  Version 6.2.0.3
gpudb::GPUdb Class Reference

#include <gpudb/GPUdb.hpp>

Inherits noncopyable.

Classes

class  Options
 

Public Member Functions

 GPUdb (const HttpUrl &url, const Options &options=Options())
 
 GPUdb (const std::string &url, const Options &options=Options())
 
 GPUdb (const std::vector< HttpUrl > &urls, const Options &options=Options())
 
 GPUdb (const std::vector< std::string > &urls, const Options &options=Options())
 
const HttpUrlgetUrl () const
 Some getters. More...
 
const std::vector< HttpUrl > & getUrls () const
 
const HttpUrlgetHmUrl () const
 
const std::vector< HttpUrl > & getHmUrls () const
 
boost::asio::ssl::context * getSslContext () const
 
const std::string & getUsername () const
 
const std::string & getPassword () const
 
bool getUseSnappy () const
 
size_t getThreadCount () const
 
avro::ExecutorPtr getExecutor () const
 
const std::map< std::string, std::string > & getHttpHeaders () const
 
size_t getTimeout () const
 
void updateHostManagerPort ()
 Update the host manager port by inquiring the server. More...
 
template<typename TRequest , typename TResponse >
TResponse & submitRequest (const HttpUrl &url, const TRequest &request, TResponse &response, const bool enableCompression=false) const
 
template<typename TRequest , typename TResponse >
TResponse & submitRequest (const std::string &endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const
 
template<typename TRequest , typename TResponse >
TResponse & submitRequest (const char *endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const
 
template<typename TRequest , typename TResponse >
TResponse & submitRequestToHostManager (const std::string &endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const
 Submit an HTTP request to the host manager. More...
 
template<typename TRequest , typename TResponse >
TResponse & submitRequestToHostManager (const char *endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const
 Submit an HTTP request to the host manager. More...
 
AdminAlterJobsResponse adminAlterJobs (const AdminAlterJobsRequest &request_) const
 Perform the requested action on a list of one or more job(s). More...
 
AdminAlterJobsResponseadminAlterJobs (const AdminAlterJobsRequest &request_, AdminAlterJobsResponse &response_) const
 Perform the requested action on a list of one or more job(s). More...
 
AdminAlterJobsResponse adminAlterJobs (const std::vector< int32_t > &jobIds, const std::string &action, const std::map< std::string, std::string > &options) const
 Perform the requested action on a list of one or more job(s). More...
 
AdminAlterJobsResponseadminAlterJobs (const std::vector< int32_t > &jobIds, const std::string &action, const std::map< std::string, std::string > &options, AdminAlterJobsResponse &response_) const
 Perform the requested action on a list of one or more job(s). More...
 
AdminOfflineResponse adminOffline (const AdminOfflineRequest &request_) const
 Take the system offline. More...
 
AdminOfflineResponseadminOffline (const AdminOfflineRequest &request_, AdminOfflineResponse &response_) const
 Take the system offline. More...
 
AdminOfflineResponse adminOffline (const bool offline, const std::map< std::string, std::string > &options) const
 Take the system offline. More...
 
AdminOfflineResponseadminOffline (const bool offline, const std::map< std::string, std::string > &options, AdminOfflineResponse &response_) const
 Take the system offline. More...
 
AdminShowAlertsResponse adminShowAlerts (const AdminShowAlertsRequest &request_) const
 Retrieves a list of the most recent alerts generated. More...
 
AdminShowAlertsResponseadminShowAlerts (const AdminShowAlertsRequest &request_, AdminShowAlertsResponse &response_) const
 Retrieves a list of the most recent alerts generated. More...
 
AdminShowAlertsResponse adminShowAlerts (const int32_t numAlerts, const std::map< std::string, std::string > &options) const
 Retrieves a list of the most recent alerts generated. More...
 
AdminShowAlertsResponseadminShowAlerts (const int32_t numAlerts, const std::map< std::string, std::string > &options, AdminShowAlertsResponse &response_) const
 Retrieves a list of the most recent alerts generated. More...
 
AdminShowJobsResponse adminShowJobs (const AdminShowJobsRequest &request_) const
 Get a list of the current jobs in GPUdb. More...
 
AdminShowJobsResponseadminShowJobs (const AdminShowJobsRequest &request_, AdminShowJobsResponse &response_) const
 Get a list of the current jobs in GPUdb. More...
 
AdminShowJobsResponse adminShowJobs (const std::map< std::string, std::string > &options) const
 Get a list of the current jobs in GPUdb. More...
 
AdminShowJobsResponseadminShowJobs (const std::map< std::string, std::string > &options, AdminShowJobsResponse &response_) const
 Get a list of the current jobs in GPUdb. More...
 
AdminShowShardsResponse adminShowShards (const AdminShowShardsRequest &request_) const
 Show the mapping of shards to the corresponding rank and tom. More...
 
AdminShowShardsResponseadminShowShards (const AdminShowShardsRequest &request_, AdminShowShardsResponse &response_) const
 Show the mapping of shards to the corresponding rank and tom. More...
 
AdminShowShardsResponse adminShowShards (const std::map< std::string, std::string > &options) const
 Show the mapping of shards to the corresponding rank and tom. More...
 
AdminShowShardsResponseadminShowShards (const std::map< std::string, std::string > &options, AdminShowShardsResponse &response_) const
 Show the mapping of shards to the corresponding rank and tom. More...
 
AdminShutdownResponse adminShutdown (const AdminShutdownRequest &request_) const
 Exits the database server application. More...
 
AdminShutdownResponseadminShutdown (const AdminShutdownRequest &request_, AdminShutdownResponse &response_) const
 Exits the database server application. More...
 
AdminShutdownResponse adminShutdown (const std::string &exitType, const std::string &authorization, const std::map< std::string, std::string > &options) const
 Exits the database server application. More...
 
AdminShutdownResponseadminShutdown (const std::string &exitType, const std::string &authorization, const std::map< std::string, std::string > &options, AdminShutdownResponse &response_) const
 Exits the database server application. More...
 
AdminVerifyDbResponse adminVerifyDb (const AdminVerifyDbRequest &request_) const
 Verify database is in a consistent state. More...
 
AdminVerifyDbResponseadminVerifyDb (const AdminVerifyDbRequest &request_, AdminVerifyDbResponse &response_) const
 Verify database is in a consistent state. More...
 
AdminVerifyDbResponse adminVerifyDb (const std::map< std::string, std::string > &options) const
 Verify database is in a consistent state. More...
 
AdminVerifyDbResponseadminVerifyDb (const std::map< std::string, std::string > &options, AdminVerifyDbResponse &response_) const
 Verify database is in a consistent state. More...
 
AggregateConvexHullResponse aggregateConvexHull (const AggregateConvexHullRequest &request_) const
 Calculates and returns the convex hull for the values in a table specified by tableName. More...
 
AggregateConvexHullResponseaggregateConvexHull (const AggregateConvexHullRequest &request_, AggregateConvexHullResponse &response_) const
 Calculates and returns the convex hull for the values in a table specified by tableName. More...
 
AggregateConvexHullResponse aggregateConvexHull (const std::string &tableName, const std::string &xColumnName, const std::string &yColumnName, const std::map< std::string, std::string > &options) const
 Calculates and returns the convex hull for the values in a table specified by tableName. More...
 
AggregateConvexHullResponseaggregateConvexHull (const std::string &tableName, const std::string &xColumnName, const std::string &yColumnName, const std::map< std::string, std::string > &options, AggregateConvexHullResponse &response_) const
 Calculates and returns the convex hull for the values in a table specified by tableName. More...
 
RawAggregateGroupByResponse aggregateGroupByRaw (const AggregateGroupByRequest &request_) const
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...
 
RawAggregateGroupByResponseaggregateGroupByRaw (const AggregateGroupByRequest &request_, RawAggregateGroupByResponse &response_) const
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...
 
AggregateGroupByResponse aggregateGroupBy (const AggregateGroupByRequest &request_) const
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...
 
AggregateGroupByResponseaggregateGroupBy (const AggregateGroupByRequest &request_, AggregateGroupByResponse &response_) const
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...
 
AggregateGroupByResponse aggregateGroupBy (const std::string &tableName, const std::vector< std::string > &columnNames, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...
 
AggregateGroupByResponseaggregateGroupBy (const std::string &tableName, const std::vector< std::string > &columnNames, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, AggregateGroupByResponse &response_) const
 Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...
 
AggregateHistogramResponse aggregateHistogram (const AggregateHistogramRequest &request_) const
 Performs a histogram calculation given a table, a column, and an interval function. More...
 
AggregateHistogramResponseaggregateHistogram (const AggregateHistogramRequest &request_, AggregateHistogramResponse &response_) const
 Performs a histogram calculation given a table, a column, and an interval function. More...
 
AggregateHistogramResponse aggregateHistogram (const std::string &tableName, const std::string &columnName, const double start, const double end, const double interval, const std::map< std::string, std::string > &options) const
 Performs a histogram calculation given a table, a column, and an interval function. More...
 
AggregateHistogramResponseaggregateHistogram (const std::string &tableName, const std::string &columnName, const double start, const double end, const double interval, const std::map< std::string, std::string > &options, AggregateHistogramResponse &response_) const
 Performs a histogram calculation given a table, a column, and an interval function. More...
 
AggregateKMeansResponse aggregateKMeans (const AggregateKMeansRequest &request_) const
 This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. More...
 
AggregateKMeansResponseaggregateKMeans (const AggregateKMeansRequest &request_, AggregateKMeansResponse &response_) const
 This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. More...
 
AggregateKMeansResponse aggregateKMeans (const std::string &tableName, const std::vector< std::string > &columnNames, const int32_t k, const double tolerance, const std::map< std::string, std::string > &options) const
 This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. More...
 
AggregateKMeansResponseaggregateKMeans (const std::string &tableName, const std::vector< std::string > &columnNames, const int32_t k, const double tolerance, const std::map< std::string, std::string > &options, AggregateKMeansResponse &response_) const
 This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. More...
 
AggregateMinMaxResponse aggregateMinMax (const AggregateMinMaxRequest &request_) const
 Calculates and returns the minimum and maximum values of a particular column in a table. More...
 
AggregateMinMaxResponseaggregateMinMax (const AggregateMinMaxRequest &request_, AggregateMinMaxResponse &response_) const
 Calculates and returns the minimum and maximum values of a particular column in a table. More...
 
AggregateMinMaxResponse aggregateMinMax (const std::string &tableName, const std::string &columnName, const std::map< std::string, std::string > &options) const
 Calculates and returns the minimum and maximum values of a particular column in a table. More...
 
AggregateMinMaxResponseaggregateMinMax (const std::string &tableName, const std::string &columnName, const std::map< std::string, std::string > &options, AggregateMinMaxResponse &response_) const
 Calculates and returns the minimum and maximum values of a particular column in a table. More...
 
AggregateMinMaxGeometryResponse aggregateMinMaxGeometry (const AggregateMinMaxGeometryRequest &request_) const
 Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More...
 
AggregateMinMaxGeometryResponseaggregateMinMaxGeometry (const AggregateMinMaxGeometryRequest &request_, AggregateMinMaxGeometryResponse &response_) const
 Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More...
 
AggregateMinMaxGeometryResponse aggregateMinMaxGeometry (const std::string &tableName, const std::string &columnName, const std::map< std::string, std::string > &options) const
 Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More...
 
AggregateMinMaxGeometryResponseaggregateMinMaxGeometry (const std::string &tableName, const std::string &columnName, const std::map< std::string, std::string > &options, AggregateMinMaxGeometryResponse &response_) const
 Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table. More...
 
AggregateStatisticsResponse aggregateStatistics (const AggregateStatisticsRequest &request_) const
 Calculates the requested statistics of the given column(s) in a given table. More...
 
AggregateStatisticsResponseaggregateStatistics (const AggregateStatisticsRequest &request_, AggregateStatisticsResponse &response_) const
 Calculates the requested statistics of the given column(s) in a given table. More...
 
AggregateStatisticsResponse aggregateStatistics (const std::string &tableName, const std::string &columnName, const std::string &stats, const std::map< std::string, std::string > &options) const
 Calculates the requested statistics of the given column(s) in a given table. More...
 
AggregateStatisticsResponseaggregateStatistics (const std::string &tableName, const std::string &columnName, const std::string &stats, const std::map< std::string, std::string > &options, AggregateStatisticsResponse &response_) const
 Calculates the requested statistics of the given column(s) in a given table. More...
 
AggregateStatisticsByRangeResponse aggregateStatisticsByRange (const AggregateStatisticsByRangeRequest &request_) const
 Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More...
 
AggregateStatisticsByRangeResponseaggregateStatisticsByRange (const AggregateStatisticsByRangeRequest &request_, AggregateStatisticsByRangeResponse &response_) const
 Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More...
 
AggregateStatisticsByRangeResponse aggregateStatisticsByRange (const std::string &tableName, const std::string &selectExpression, const std::string &columnName, const std::string &valueColumnName, const std::string &stats, const double start, const double end, const double interval, const std::map< std::string, std::string > &options) const
 Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More...
 
AggregateStatisticsByRangeResponseaggregateStatisticsByRange (const std::string &tableName, const std::string &selectExpression, const std::string &columnName, const std::string &valueColumnName, const std::string &stats, const double start, const double end, const double interval, const std::map< std::string, std::string > &options, AggregateStatisticsByRangeResponse &response_) const
 Divides the given set into bins and calculates statistics of the values of a value-column in each bin. More...
 
RawAggregateUniqueResponse aggregateUniqueRaw (const AggregateUniqueRequest &request_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). More...
 
RawAggregateUniqueResponseaggregateUniqueRaw (const AggregateUniqueRequest &request_, RawAggregateUniqueResponse &response_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). More...
 
AggregateUniqueResponse aggregateUnique (const AggregateUniqueRequest &request_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). More...
 
AggregateUniqueResponseaggregateUnique (const AggregateUniqueRequest &request_, AggregateUniqueResponse &response_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). More...
 
AggregateUniqueResponse aggregateUnique (const std::string &tableName, const std::string &columnName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). More...
 
AggregateUniqueResponseaggregateUnique (const std::string &tableName, const std::string &columnName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, AggregateUniqueResponse &response_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). More...
 
RawAggregateUnpivotResponse aggregateUnpivotRaw (const AggregateUnpivotRequest &request_) const
 Rotate the column values into rows values. More...
 
RawAggregateUnpivotResponseaggregateUnpivotRaw (const AggregateUnpivotRequest &request_, RawAggregateUnpivotResponse &response_) const
 Rotate the column values into rows values. More...
 
AggregateUnpivotResponse aggregateUnpivot (const AggregateUnpivotRequest &request_) const
 Rotate the column values into rows values. More...
 
AggregateUnpivotResponseaggregateUnpivot (const AggregateUnpivotRequest &request_, AggregateUnpivotResponse &response_) const
 Rotate the column values into rows values. More...
 
AggregateUnpivotResponse aggregateUnpivot (const std::string &tableName, const std::vector< std::string > &columnNames, const std::string &variableColumnName, const std::string &valueColumnName, const std::vector< std::string > &pivotedColumns, const std::map< std::string, std::string > &options) const
 Rotate the column values into rows values. More...
 
AggregateUnpivotResponseaggregateUnpivot (const std::string &tableName, const std::vector< std::string > &columnNames, const std::string &variableColumnName, const std::string &valueColumnName, const std::vector< std::string > &pivotedColumns, const std::map< std::string, std::string > &options, AggregateUnpivotResponse &response_) const
 Rotate the column values into rows values. More...
 
AlterSystemPropertiesResponse alterSystemProperties (const AlterSystemPropertiesRequest &request_) const
 The alterSystemProperties(const AlterSystemPropertiesRequest&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More...
 
AlterSystemPropertiesResponsealterSystemProperties (const AlterSystemPropertiesRequest &request_, AlterSystemPropertiesResponse &response_) const
 The alterSystemProperties(const AlterSystemPropertiesRequest&,AlterSystemPropertiesResponse&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More...
 
AlterSystemPropertiesResponse alterSystemProperties (const std::map< std::string, std::string > &propertyUpdatesMap, const std::map< std::string, std::string > &options) const
 The alterSystemProperties(const std::map<std::string, std::string>&,const std::map<std::string, std::string>&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More...
 
AlterSystemPropertiesResponsealterSystemProperties (const std::map< std::string, std::string > &propertyUpdatesMap, const std::map< std::string, std::string > &options, AlterSystemPropertiesResponse &response_) const
 The alterSystemProperties(const std::map<std::string, std::string>&,const std::map<std::string, std::string>&,AlterSystemPropertiesResponse&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More...
 
AlterTableResponse alterTable (const AlterTableRequest &request_) const
 Apply various modifications to a table, view, or collection. More...
 
AlterTableResponsealterTable (const AlterTableRequest &request_, AlterTableResponse &response_) const
 Apply various modifications to a table, view, or collection. More...
 
AlterTableResponse alterTable (const std::string &tableName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options) const
 Apply various modifications to a table, view, or collection. More...
 
AlterTableResponsealterTable (const std::string &tableName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options, AlterTableResponse &response_) const
 Apply various modifications to a table, view, or collection. More...
 
AlterTableMetadataResponse alterTableMetadata (const AlterTableMetadataRequest &request_) const
 Updates (adds or changes) metadata for tables. More...
 
AlterTableMetadataResponsealterTableMetadata (const AlterTableMetadataRequest &request_, AlterTableMetadataResponse &response_) const
 Updates (adds or changes) metadata for tables. More...
 
AlterTableMetadataResponse alterTableMetadata (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &metadataMap, const std::map< std::string, std::string > &options) const
 Updates (adds or changes) metadata for tables. More...
 
AlterTableMetadataResponsealterTableMetadata (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &metadataMap, const std::map< std::string, std::string > &options, AlterTableMetadataResponse &response_) const
 Updates (adds or changes) metadata for tables. More...
 
AlterUserResponse alterUser (const AlterUserRequest &request_) const
 Alters a user. More...
 
AlterUserResponsealterUser (const AlterUserRequest &request_, AlterUserResponse &response_) const
 Alters a user. More...
 
AlterUserResponse alterUser (const std::string &name, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options) const
 Alters a user. More...
 
AlterUserResponsealterUser (const std::string &name, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options, AlterUserResponse &response_) const
 Alters a user. More...
 
AppendRecordsResponse appendRecords (const AppendRecordsRequest &request_) const
 Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). More...
 
AppendRecordsResponseappendRecords (const AppendRecordsRequest &request_, AppendRecordsResponse &response_) const
 Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). More...
 
AppendRecordsResponse appendRecords (const std::string &tableName, const std::string &sourceTableName, const std::map< std::string, std::string > &fieldMap, const std::map< std::string, std::string > &options) const
 Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). More...
 
AppendRecordsResponseappendRecords (const std::string &tableName, const std::string &sourceTableName, const std::map< std::string, std::string > &fieldMap, const std::map< std::string, std::string > &options, AppendRecordsResponse &response_) const
 Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). More...
 
ClearTableResponse clearTable (const ClearTableRequest &request_) const
 Clears (drops) one or all tables in the database cluster. More...
 
ClearTableResponseclearTable (const ClearTableRequest &request_, ClearTableResponse &response_) const
 Clears (drops) one or all tables in the database cluster. More...
 
ClearTableResponse clearTable (const std::string &tableName, const std::string &authorization, const std::map< std::string, std::string > &options) const
 Clears (drops) one or all tables in the database cluster. More...
 
ClearTableResponseclearTable (const std::string &tableName, const std::string &authorization, const std::map< std::string, std::string > &options, ClearTableResponse &response_) const
 Clears (drops) one or all tables in the database cluster. More...
 
ClearTableMonitorResponse clearTableMonitor (const ClearTableMonitorRequest &request_) const
 Deactivates a table monitor previously created with createTableMonitor(const CreateTableMonitorRequest&) const. More...
 
ClearTableMonitorResponseclearTableMonitor (const ClearTableMonitorRequest &request_, ClearTableMonitorResponse &response_) const
 Deactivates a table monitor previously created with createTableMonitor(const CreateTableMonitorRequest&,CreateTableMonitorResponse&) const. More...
 
ClearTableMonitorResponse clearTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &options) const
 Deactivates a table monitor previously created with createTableMonitor(const std::string&,const std::map<std::string, std::string>&) const. More...
 
ClearTableMonitorResponseclearTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &options, ClearTableMonitorResponse &response_) const
 Deactivates a table monitor previously created with createTableMonitor(const std::string&,const std::map<std::string, std::string>&,CreateTableMonitorResponse&) const. More...
 
ClearTriggerResponse clearTrigger (const ClearTriggerRequest &request_) const
 Clears or cancels the trigger identified by the specified handle. More...
 
ClearTriggerResponseclearTrigger (const ClearTriggerRequest &request_, ClearTriggerResponse &response_) const
 Clears or cancels the trigger identified by the specified handle. More...
 
ClearTriggerResponse clearTrigger (const std::string &triggerId, const std::map< std::string, std::string > &options) const
 Clears or cancels the trigger identified by the specified handle. More...
 
ClearTriggerResponseclearTrigger (const std::string &triggerId, const std::map< std::string, std::string > &options, ClearTriggerResponse &response_) const
 Clears or cancels the trigger identified by the specified handle. More...
 
CreateJobResponse createJob (const CreateJobRequest &request_) const
 Create a job which will run asynchronously. More...
 
CreateJobResponsecreateJob (const CreateJobRequest &request_, CreateJobResponse &response_) const
 Create a job which will run asynchronously. More...
 
CreateJobResponse createJob (const std::string &endpoint, const std::string &requestEncoding, const std::vector< uint8_t > &data, const std::string &dataStr, const std::map< std::string, std::string > &options) const
 Create a job which will run asynchronously. More...
 
CreateJobResponsecreateJob (const std::string &endpoint, const std::string &requestEncoding, const std::vector< uint8_t > &data, const std::string &dataStr, const std::map< std::string, std::string > &options, CreateJobResponse &response_) const
 Create a job which will run asynchronously. More...
 
CreateJoinTableResponse createJoinTable (const CreateJoinTableRequest &request_) const
 Creates a table that is the result of a SQL JOIN. More...
 
CreateJoinTableResponsecreateJoinTable (const CreateJoinTableRequest &request_, CreateJoinTableResponse &response_) const
 Creates a table that is the result of a SQL JOIN. More...
 
CreateJoinTableResponse createJoinTable (const std::string &joinTableName, const std::vector< std::string > &tableNames, const std::vector< std::string > &columnNames, const std::vector< std::string > &expressions, const std::map< std::string, std::string > &options) const
 Creates a table that is the result of a SQL JOIN. More...
 
CreateJoinTableResponsecreateJoinTable (const std::string &joinTableName, const std::vector< std::string > &tableNames, const std::vector< std::string > &columnNames, const std::vector< std::string > &expressions, const std::map< std::string, std::string > &options, CreateJoinTableResponse &response_) const
 Creates a table that is the result of a SQL JOIN. More...
 
CreateMaterializedViewResponse createMaterializedView (const CreateMaterializedViewRequest &request_) const
 Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More...
 
CreateMaterializedViewResponsecreateMaterializedView (const CreateMaterializedViewRequest &request_, CreateMaterializedViewResponse &response_) const
 Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More...
 
CreateMaterializedViewResponse createMaterializedView (const std::string &tableName, const std::map< std::string, std::string > &options) const
 Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More...
 
CreateMaterializedViewResponsecreateMaterializedView (const std::string &tableName, const std::map< std::string, std::string > &options, CreateMaterializedViewResponse &response_) const
 Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name. More...
 
CreateProcResponse createProc (const CreateProcRequest &request_) const
 Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More...
 
CreateProcResponsecreateProc (const CreateProcRequest &request_, CreateProcResponse &response_) const
 Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More...
 
CreateProcResponse createProc (const std::string &procName, const std::string &executionMode, const std::map< std::string, std::vector< uint8_t > > &files, const std::string &command, const std::vector< std::string > &args, const std::map< std::string, std::string > &options) const
 Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More...
 
CreateProcResponsecreateProc (const std::string &procName, const std::string &executionMode, const std::map< std::string, std::vector< uint8_t > > &files, const std::string &command, const std::vector< std::string > &args, const std::map< std::string, std::string > &options, CreateProcResponse &response_) const
 Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. More...
 
CreateProjectionResponse createProjection (const CreateProjectionRequest &request_) const
 Creates a new projection of an existing table. More...
 
CreateProjectionResponsecreateProjection (const CreateProjectionRequest &request_, CreateProjectionResponse &response_) const
 Creates a new projection of an existing table. More...
 
CreateProjectionResponse createProjection (const std::string &tableName, const std::string &projectionName, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options) const
 Creates a new projection of an existing table. More...
 
CreateProjectionResponsecreateProjection (const std::string &tableName, const std::string &projectionName, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options, CreateProjectionResponse &response_) const
 Creates a new projection of an existing table. More...
 
CreateRoleResponse createRole (const CreateRoleRequest &request_) const
 Creates a new role. More...
 
CreateRoleResponsecreateRole (const CreateRoleRequest &request_, CreateRoleResponse &response_) const
 Creates a new role. More...
 
CreateRoleResponse createRole (const std::string &name, const std::map< std::string, std::string > &options) const
 Creates a new role. More...
 
CreateRoleResponsecreateRole (const std::string &name, const std::map< std::string, std::string > &options, CreateRoleResponse &response_) const
 Creates a new role. More...
 
CreateTableResponse createTable (const CreateTableRequest &request_) const
 Creates a new table or collection. More...
 
CreateTableResponsecreateTable (const CreateTableRequest &request_, CreateTableResponse &response_) const
 Creates a new table or collection. More...
 
CreateTableResponse createTable (const std::string &tableName, const std::string &typeId, const std::map< std::string, std::string > &options) const
 Creates a new table or collection. More...
 
CreateTableResponsecreateTable (const std::string &tableName, const std::string &typeId, const std::map< std::string, std::string > &options, CreateTableResponse &response_) const
 Creates a new table or collection. More...
 
CreateTableMonitorResponse createTableMonitor (const CreateTableMonitorRequest &request_) const
 Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...
 
CreateTableMonitorResponsecreateTableMonitor (const CreateTableMonitorRequest &request_, CreateTableMonitorResponse &response_) const
 Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...
 
CreateTableMonitorResponse createTableMonitor (const std::string &tableName, const std::map< std::string, std::string > &options) const
 Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...
 
CreateTableMonitorResponsecreateTableMonitor (const std::string &tableName, const std::map< std::string, std::string > &options, CreateTableMonitorResponse &response_) const
 Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...
 
CreateTriggerByAreaResponse createTriggerByArea (const CreateTriggerByAreaRequest &request_) const
 Sets up an area trigger mechanism for two column_names for one or more tables. More...
 
CreateTriggerByAreaResponsecreateTriggerByArea (const CreateTriggerByAreaRequest &request_, CreateTriggerByAreaResponse &response_) const
 Sets up an area trigger mechanism for two column_names for one or more tables. More...
 
CreateTriggerByAreaResponse createTriggerByArea (const std::string &requestId, const std::vector< std::string > &tableNames, const std::string &xColumnName, const std::vector< double > &xVector, const std::string &yColumnName, const std::vector< double > &yVector, const std::map< std::string, std::string > &options) const
 Sets up an area trigger mechanism for two column_names for one or more tables. More...
 
CreateTriggerByAreaResponsecreateTriggerByArea (const std::string &requestId, const std::vector< std::string > &tableNames, const std::string &xColumnName, const std::vector< double > &xVector, const std::string &yColumnName, const std::vector< double > &yVector, const std::map< std::string, std::string > &options, CreateTriggerByAreaResponse &response_) const
 Sets up an area trigger mechanism for two column_names for one or more tables. More...
 
CreateTriggerByRangeResponse createTriggerByRange (const CreateTriggerByRangeRequest &request_) const
 Sets up a simple range trigger for a column_name for one or more tables. More...
 
CreateTriggerByRangeResponsecreateTriggerByRange (const CreateTriggerByRangeRequest &request_, CreateTriggerByRangeResponse &response_) const
 Sets up a simple range trigger for a column_name for one or more tables. More...
 
CreateTriggerByRangeResponse createTriggerByRange (const std::string &requestId, const std::vector< std::string > &tableNames, const std::string &columnName, const double min, const double max, const std::map< std::string, std::string > &options) const
 Sets up a simple range trigger for a column_name for one or more tables. More...
 
CreateTriggerByRangeResponsecreateTriggerByRange (const std::string &requestId, const std::vector< std::string > &tableNames, const std::string &columnName, const double min, const double max, const std::map< std::string, std::string > &options, CreateTriggerByRangeResponse &response_) const
 Sets up a simple range trigger for a column_name for one or more tables. More...
 
CreateTypeResponse createType (const CreateTypeRequest &request_) const
 Creates a new type describing the layout or schema of a table. More...
 
CreateTypeResponsecreateType (const CreateTypeRequest &request_, CreateTypeResponse &response_) const
 Creates a new type describing the layout or schema of a table. More...
 
CreateTypeResponse createType (const std::string &typeDefinition, const std::string &label, const std::map< std::string, std::vector< std::string > > &properties, const std::map< std::string, std::string > &options) const
 Creates a new type describing the layout or schema of a table. More...
 
CreateTypeResponsecreateType (const std::string &typeDefinition, const std::string &label, const std::map< std::string, std::vector< std::string > > &properties, const std::map< std::string, std::string > &options, CreateTypeResponse &response_) const
 Creates a new type describing the layout or schema of a table. More...
 
CreateUnionResponse createUnion (const CreateUnionRequest &request_) const
 Merges data from one or more tables with comparable data types into a new table. More...
 
CreateUnionResponsecreateUnion (const CreateUnionRequest &request_, CreateUnionResponse &response_) const
 Merges data from one or more tables with comparable data types into a new table. More...
 
CreateUnionResponse createUnion (const std::string &tableName, const std::vector< std::string > &tableNames, const std::vector< std::vector< std::string > > &inputColumnNames, const std::vector< std::string > &outputColumnNames, const std::map< std::string, std::string > &options) const
 Merges data from one or more tables with comparable data types into a new table. More...
 
CreateUnionResponsecreateUnion (const std::string &tableName, const std::vector< std::string > &tableNames, const std::vector< std::vector< std::string > > &inputColumnNames, const std::vector< std::string > &outputColumnNames, const std::map< std::string, std::string > &options, CreateUnionResponse &response_) const
 Merges data from one or more tables with comparable data types into a new table. More...
 
CreateUserExternalResponse createUserExternal (const CreateUserExternalRequest &request_) const
 Creates a new external user (a user whose credentials are managed by an external LDAP). More...
 
CreateUserExternalResponsecreateUserExternal (const CreateUserExternalRequest &request_, CreateUserExternalResponse &response_) const
 Creates a new external user (a user whose credentials are managed by an external LDAP). More...
 
CreateUserExternalResponse createUserExternal (const std::string &name, const std::map< std::string, std::string > &options) const
 Creates a new external user (a user whose credentials are managed by an external LDAP). More...
 
CreateUserExternalResponsecreateUserExternal (const std::string &name, const std::map< std::string, std::string > &options, CreateUserExternalResponse &response_) const
 Creates a new external user (a user whose credentials are managed by an external LDAP). More...
 
CreateUserInternalResponse createUserInternal (const CreateUserInternalRequest &request_) const
 Creates a new internal user (a user whose credentials are managed by the database system). More...
 
CreateUserInternalResponsecreateUserInternal (const CreateUserInternalRequest &request_, CreateUserInternalResponse &response_) const
 Creates a new internal user (a user whose credentials are managed by the database system). More...
 
CreateUserInternalResponse createUserInternal (const std::string &name, const std::string &password, const std::map< std::string, std::string > &options) const
 Creates a new internal user (a user whose credentials are managed by the database system). More...
 
CreateUserInternalResponsecreateUserInternal (const std::string &name, const std::string &password, const std::map< std::string, std::string > &options, CreateUserInternalResponse &response_) const
 Creates a new internal user (a user whose credentials are managed by the database system). More...
 
DeleteProcResponse deleteProc (const DeleteProcRequest &request_) const
 Deletes a proc. More...
 
DeleteProcResponsedeleteProc (const DeleteProcRequest &request_, DeleteProcResponse &response_) const
 Deletes a proc. More...
 
DeleteProcResponse deleteProc (const std::string &procName, const std::map< std::string, std::string > &options) const
 Deletes a proc. More...
 
DeleteProcResponsedeleteProc (const std::string &procName, const std::map< std::string, std::string > &options, DeleteProcResponse &response_) const
 Deletes a proc. More...
 
DeleteRecordsResponse deleteRecords (const DeleteRecordsRequest &request_) const
 Deletes record(s) matching the provided criteria from the given table. More...
 
DeleteRecordsResponsedeleteRecords (const DeleteRecordsRequest &request_, DeleteRecordsResponse &response_) const
 Deletes record(s) matching the provided criteria from the given table. More...
 
DeleteRecordsResponse deleteRecords (const std::string &tableName, const std::vector< std::string > &expressions, const std::map< std::string, std::string > &options) const
 Deletes record(s) matching the provided criteria from the given table. More...
 
DeleteRecordsResponsedeleteRecords (const std::string &tableName, const std::vector< std::string > &expressions, const std::map< std::string, std::string > &options, DeleteRecordsResponse &response_) const
 Deletes record(s) matching the provided criteria from the given table. More...
 
DeleteRoleResponse deleteRole (const DeleteRoleRequest &request_) const
 Deletes an existing role. More...
 
DeleteRoleResponsedeleteRole (const DeleteRoleRequest &request_, DeleteRoleResponse &response_) const
 Deletes an existing role. More...
 
DeleteRoleResponse deleteRole (const std::string &name, const std::map< std::string, std::string > &options) const
 Deletes an existing role. More...
 
DeleteRoleResponsedeleteRole (const std::string &name, const std::map< std::string, std::string > &options, DeleteRoleResponse &response_) const
 Deletes an existing role. More...
 
DeleteUserResponse deleteUser (const DeleteUserRequest &request_) const
 Deletes an existing user. More...
 
DeleteUserResponsedeleteUser (const DeleteUserRequest &request_, DeleteUserResponse &response_) const
 Deletes an existing user. More...
 
DeleteUserResponse deleteUser (const std::string &name, const std::map< std::string, std::string > &options) const
 Deletes an existing user. More...
 
DeleteUserResponsedeleteUser (const std::string &name, const std::map< std::string, std::string > &options, DeleteUserResponse &response_) const
 Deletes an existing user. More...
 
ExecuteProcResponse executeProc (const ExecuteProcRequest &request_) const
 Executes a proc. More...
 
ExecuteProcResponseexecuteProc (const ExecuteProcRequest &request_, ExecuteProcResponse &response_) const
 Executes a proc. More...
 
ExecuteProcResponse executeProc (const std::string &procName, const std::map< std::string, std::string > &params, const std::map< std::string, std::vector< uint8_t > > &binParams, const std::vector< std::string > &inputTableNames, const std::map< std::string, std::vector< std::string > > &inputColumnNames, const std::vector< std::string > &outputTableNames, const std::map< std::string, std::string > &options) const
 Executes a proc. More...
 
ExecuteProcResponseexecuteProc (const std::string &procName, const std::map< std::string, std::string > &params, const std::map< std::string, std::vector< uint8_t > > &binParams, const std::vector< std::string > &inputTableNames, const std::map< std::string, std::vector< std::string > > &inputColumnNames, const std::vector< std::string > &outputTableNames, const std::map< std::string, std::string > &options, ExecuteProcResponse &response_) const
 Executes a proc. More...
 
FilterResponse filter (const FilterRequest &request_) const
 Filters data based on the specified expression. More...
 
FilterResponsefilter (const FilterRequest &request_, FilterResponse &response_) const
 Filters data based on the specified expression. More...
 
FilterResponse filter (const std::string &tableName, const std::string &viewName, const std::string &expression, const std::map< std::string, std::string > &options) const
 Filters data based on the specified expression. More...
 
FilterResponsefilter (const std::string &tableName, const std::string &viewName, const std::string &expression, const std::map< std::string, std::string > &options, FilterResponse &response_) const
 Filters data based on the specified expression. More...
 
FilterByAreaResponse filterByArea (const FilterByAreaRequest &request_) const
 Calculates which objects from a table are within a named area of interest (NAI/polygon). More...
 
FilterByAreaResponsefilterByArea (const FilterByAreaRequest &request_, FilterByAreaResponse &response_) const
 Calculates which objects from a table are within a named area of interest (NAI/polygon). More...
 
FilterByAreaResponse filterByArea (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const std::vector< double > &xVector, const std::string &yColumnName, const std::vector< double > &yVector, const std::map< std::string, std::string > &options) const
 Calculates which objects from a table are within a named area of interest (NAI/polygon). More...
 
FilterByAreaResponsefilterByArea (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const std::vector< double > &xVector, const std::string &yColumnName, const std::vector< double > &yVector, const std::map< std::string, std::string > &options, FilterByAreaResponse &response_) const
 Calculates which objects from a table are within a named area of interest (NAI/polygon). More...
 
FilterByAreaGeometryResponse filterByAreaGeometry (const FilterByAreaGeometryRequest &request_) const
 Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More...
 
FilterByAreaGeometryResponsefilterByAreaGeometry (const FilterByAreaGeometryRequest &request_, FilterByAreaGeometryResponse &response_) const
 Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More...
 
FilterByAreaGeometryResponse filterByAreaGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::vector< double > &xVector, const std::vector< double > &yVector, const std::map< std::string, std::string > &options) const
 Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More...
 
FilterByAreaGeometryResponsefilterByAreaGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::vector< double > &xVector, const std::vector< double > &yVector, const std::map< std::string, std::string > &options, FilterByAreaGeometryResponse &response_) const
 Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). More...
 
FilterByBoxResponse filterByBox (const FilterByBoxRequest &request_) const
 Calculates how many objects within the given table lie in a rectangular box. More...
 
FilterByBoxResponsefilterByBox (const FilterByBoxRequest &request_, FilterByBoxResponse &response_) const
 Calculates how many objects within the given table lie in a rectangular box. More...
 
FilterByBoxResponse filterByBox (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double minX, const double maxX, const std::string &yColumnName, const double minY, const double maxY, const std::map< std::string, std::string > &options) const
 Calculates how many objects within the given table lie in a rectangular box. More...
 
FilterByBoxResponsefilterByBox (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double minX, const double maxX, const std::string &yColumnName, const double minY, const double maxY, const std::map< std::string, std::string > &options, FilterByBoxResponse &response_) const
 Calculates how many objects within the given table lie in a rectangular box. More...
 
FilterByBoxGeometryResponse filterByBoxGeometry (const FilterByBoxGeometryRequest &request_) const
 Calculates which geospatial geometry objects from a table intersect a rectangular box. More...
 
FilterByBoxGeometryResponsefilterByBoxGeometry (const FilterByBoxGeometryRequest &request_, FilterByBoxGeometryResponse &response_) const
 Calculates which geospatial geometry objects from a table intersect a rectangular box. More...
 
FilterByBoxGeometryResponse filterByBoxGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double minX, const double maxX, const double minY, const double maxY, const std::map< std::string, std::string > &options) const
 Calculates which geospatial geometry objects from a table intersect a rectangular box. More...
 
FilterByBoxGeometryResponsefilterByBoxGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double minX, const double maxX, const double minY, const double maxY, const std::map< std::string, std::string > &options, FilterByBoxGeometryResponse &response_) const
 Calculates which geospatial geometry objects from a table intersect a rectangular box. More...
 
FilterByGeometryResponse filterByGeometry (const FilterByGeometryRequest &request_) const
 Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More...
 
FilterByGeometryResponsefilterByGeometry (const FilterByGeometryRequest &request_, FilterByGeometryResponse &response_) const
 Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More...
 
FilterByGeometryResponse filterByGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &inputWkt, const std::string &operation, const std::map< std::string, std::string > &options) const
 Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More...
 
FilterByGeometryResponsefilterByGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &inputWkt, const std::string &operation, const std::map< std::string, std::string > &options, FilterByGeometryResponse &response_) const
 Applies a geometry filter against a geospatial geometry column in a given table, collection or view. More...
 
FilterByListResponse filterByList (const FilterByListRequest &request_) const
 Calculates which records from a table have values in the given list for the corresponding column. More...
 
FilterByListResponsefilterByList (const FilterByListRequest &request_, FilterByListResponse &response_) const
 Calculates which records from a table have values in the given list for the corresponding column. More...
 
FilterByListResponse filterByList (const std::string &tableName, const std::string &viewName, const std::map< std::string, std::vector< std::string > > &columnValuesMap, const std::map< std::string, std::string > &options) const
 Calculates which records from a table have values in the given list for the corresponding column. More...
 
FilterByListResponsefilterByList (const std::string &tableName, const std::string &viewName, const std::map< std::string, std::vector< std::string > > &columnValuesMap, const std::map< std::string, std::string > &options, FilterByListResponse &response_) const
 Calculates which records from a table have values in the given list for the corresponding column. More...
 
FilterByRadiusResponse filterByRadius (const FilterByRadiusRequest &request_) const
 Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...
 
FilterByRadiusResponsefilterByRadius (const FilterByRadiusRequest &request_, FilterByRadiusResponse &response_) const
 Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...
 
FilterByRadiusResponse filterByRadius (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double xCenter, const std::string &yColumnName, const double yCenter, const double radius, const std::map< std::string, std::string > &options) const
 Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...
 
FilterByRadiusResponsefilterByRadius (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double xCenter, const std::string &yColumnName, const double yCenter, const double radius, const std::map< std::string, std::string > &options, FilterByRadiusResponse &response_) const
 Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...
 
FilterByRadiusGeometryResponse filterByRadiusGeometry (const FilterByRadiusGeometryRequest &request_) const
 Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More...
 
FilterByRadiusGeometryResponsefilterByRadiusGeometry (const FilterByRadiusGeometryRequest &request_, FilterByRadiusGeometryResponse &response_) const
 Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More...
 
FilterByRadiusGeometryResponse filterByRadiusGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double xCenter, const double yCenter, const double radius, const std::map< std::string, std::string > &options) const
 Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More...
 
FilterByRadiusGeometryResponsefilterByRadiusGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double xCenter, const double yCenter, const double radius, const std::map< std::string, std::string > &options, FilterByRadiusGeometryResponse &response_) const
 Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. More...
 
FilterByRangeResponse filterByRange (const FilterByRangeRequest &request_) const
 Calculates which objects from a table have a column that is within the given bounds. More...
 
FilterByRangeResponsefilterByRange (const FilterByRangeRequest &request_, FilterByRangeResponse &response_) const
 Calculates which objects from a table have a column that is within the given bounds. More...
 
FilterByRangeResponse filterByRange (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double lowerBound, const double upperBound, const std::map< std::string, std::string > &options) const
 Calculates which objects from a table have a column that is within the given bounds. More...
 
FilterByRangeResponsefilterByRange (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double lowerBound, const double upperBound, const std::map< std::string, std::string > &options, FilterByRangeResponse &response_) const
 Calculates which objects from a table have a column that is within the given bounds. More...
 
FilterBySeriesResponse filterBySeries (const FilterBySeriesRequest &request_) const
 Filters objects matching all points of the given track (works only on track type data). More...
 
FilterBySeriesResponsefilterBySeries (const FilterBySeriesRequest &request_, FilterBySeriesResponse &response_) const
 Filters objects matching all points of the given track (works only on track type data). More...
 
FilterBySeriesResponse filterBySeries (const std::string &tableName, const std::string &viewName, const std::string &trackId, const std::vector< std::string > &targetTrackIds, const std::map< std::string, std::string > &options) const
 Filters objects matching all points of the given track (works only on track type data). More...
 
FilterBySeriesResponsefilterBySeries (const std::string &tableName, const std::string &viewName, const std::string &trackId, const std::vector< std::string > &targetTrackIds, const std::map< std::string, std::string > &options, FilterBySeriesResponse &response_) const
 Filters objects matching all points of the given track (works only on track type data). More...
 
FilterByStringResponse filterByString (const FilterByStringRequest &request_) const
 Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...
 
FilterByStringResponsefilterByString (const FilterByStringRequest &request_, FilterByStringResponse &response_) const
 Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...
 
FilterByStringResponse filterByString (const std::string &tableName, const std::string &viewName, const std::string &expression, const std::string &mode, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options) const
 Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...
 
FilterByStringResponsefilterByString (const std::string &tableName, const std::string &viewName, const std::string &expression, const std::string &mode, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options, FilterByStringResponse &response_) const
 Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...
 
FilterByTableResponse filterByTable (const FilterByTableRequest &request_) const
 Filters objects in one table based on objects in another table. More...
 
FilterByTableResponsefilterByTable (const FilterByTableRequest &request_, FilterByTableResponse &response_) const
 Filters objects in one table based on objects in another table. More...
 
FilterByTableResponse filterByTable (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &sourceTableName, const std::string &sourceTableColumnName, const std::map< std::string, std::string > &options) const
 Filters objects in one table based on objects in another table. More...
 
FilterByTableResponsefilterByTable (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &sourceTableName, const std::string &sourceTableColumnName, const std::map< std::string, std::string > &options, FilterByTableResponse &response_) const
 Filters objects in one table based on objects in another table. More...
 
FilterByValueResponse filterByValue (const FilterByValueRequest &request_) const
 Calculates which objects from a table has a particular value for a particular column. More...
 
FilterByValueResponsefilterByValue (const FilterByValueRequest &request_, FilterByValueResponse &response_) const
 Calculates which objects from a table has a particular value for a particular column. More...
 
FilterByValueResponse filterByValue (const std::string &tableName, const std::string &viewName, const bool isString, const double value, const std::string &valueStr, const std::string &columnName, const std::map< std::string, std::string > &options) const
 Calculates which objects from a table has a particular value for a particular column. More...
 
FilterByValueResponsefilterByValue (const std::string &tableName, const std::string &viewName, const bool isString, const double value, const std::string &valueStr, const std::string &columnName, const std::map< std::string, std::string > &options, FilterByValueResponse &response_) const
 Calculates which objects from a table has a particular value for a particular column. More...
 
GetJobResponse getJob (const GetJobRequest &request_) const
 
GetJobResponsegetJob (const GetJobRequest &request_, GetJobResponse &response_) const
 
GetJobResponse getJob (const int32_t jobId, const std::map< std::string, std::string > &options) const
 
GetJobResponsegetJob (const int32_t jobId, const std::map< std::string, std::string > &options, GetJobResponse &response_) const
 
RawGetRecordsResponse getRecordsRaw (const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
RawGetRecordsResponsegetRecordsRaw (const GetRecordsRequest &request_, RawGetRecordsResponse &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > getRecords (const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > & getRecords (const GetRecordsRequest &request_, GetRecordsResponse< TResponse > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > & getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< TResponse > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > getRecords (const ::avro::ValidSchema &schema_, const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > getRecords (const Type &type_, const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > & getRecords (const ::avro::ValidSchema &schema_, const GetRecordsRequest &request_, GetRecordsResponse< TResponse > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > & getRecords (const Type &type_, const GetRecordsRequest &request_, GetRecordsResponse< TResponse > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > getRecords (const ::avro::ValidSchema &schema_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > getRecords (const Type &type_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > & getRecords (const ::avro::ValidSchema &schema_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< TResponse > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<typename TResponse >
GetRecordsResponse< TResponse > & getRecords (const Type &type_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< TResponse > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
RawGetRecordsByColumnResponse getRecordsByColumnRaw (const GetRecordsByColumnRequest &request_) const
 For a given table, retrieves the values from the requested column(s). More...
 
RawGetRecordsByColumnResponsegetRecordsByColumnRaw (const GetRecordsByColumnRequest &request_, RawGetRecordsByColumnResponse &response_) const
 For a given table, retrieves the values from the requested column(s). More...
 
GetRecordsByColumnResponse getRecordsByColumn (const GetRecordsByColumnRequest &request_) const
 For a given table, retrieves the values from the requested column(s). More...
 
GetRecordsByColumnResponsegetRecordsByColumn (const GetRecordsByColumnRequest &request_, GetRecordsByColumnResponse &response_) const
 For a given table, retrieves the values from the requested column(s). More...
 
GetRecordsByColumnResponse getRecordsByColumn (const std::string &tableName, const std::vector< std::string > &columnNames, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 For a given table, retrieves the values from the requested column(s). More...
 
GetRecordsByColumnResponsegetRecordsByColumn (const std::string &tableName, const std::vector< std::string > &columnNames, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsByColumnResponse &response_) const
 For a given table, retrieves the values from the requested column(s). More...
 
RawGetRecordsBySeriesResponse getRecordsBySeriesRaw (const GetRecordsBySeriesRequest &request_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
RawGetRecordsBySeriesResponsegetRecordsBySeriesRaw (const GetRecordsBySeriesRequest &request_, RawGetRecordsBySeriesResponse &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > getRecordsBySeries (const GetRecordsBySeriesRequest &request_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > & getRecordsBySeries (const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< TResponse > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > & getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< TResponse > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > getRecordsBySeries (const ::avro::ValidSchema &schema_, const GetRecordsBySeriesRequest &request_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > getRecordsBySeries (const Type &type_, const GetRecordsBySeriesRequest &request_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > & getRecordsBySeries (const ::avro::ValidSchema &schema_, const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< TResponse > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > & getRecordsBySeries (const Type &type_, const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< TResponse > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > getRecordsBySeries (const ::avro::ValidSchema &schema_, const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > getRecordsBySeries (const Type &type_, const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > & getRecordsBySeries (const ::avro::ValidSchema &schema_, const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< TResponse > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<typename TResponse >
GetRecordsBySeriesResponse< TResponse > & getRecordsBySeries (const Type &type_, const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< TResponse > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
RawGetRecordsFromCollectionResponse getRecordsFromCollectionRaw (const GetRecordsFromCollectionRequest &request_) const
 Retrieves records from a collection. More...
 
RawGetRecordsFromCollectionResponsegetRecordsFromCollectionRaw (const GetRecordsFromCollectionRequest &request_, RawGetRecordsFromCollectionResponse &response_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > & getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< TResponse > &response_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > & getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< TResponse > &response_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > getRecordsFromCollection (const ::avro::ValidSchema &schema_, const GetRecordsFromCollectionRequest &request_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > getRecordsFromCollection (const Type &type_, const GetRecordsFromCollectionRequest &request_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > & getRecordsFromCollection (const ::avro::ValidSchema &schema_, const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< TResponse > &response_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > & getRecordsFromCollection (const Type &type_, const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< TResponse > &response_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > getRecordsFromCollection (const ::avro::ValidSchema &schema_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > getRecordsFromCollection (const Type &type_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > & getRecordsFromCollection (const ::avro::ValidSchema &schema_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< TResponse > &response_) const
 Retrieves records from a collection. More...
 
template<typename TResponse >
GetRecordsFromCollectionResponse< TResponse > & getRecordsFromCollection (const Type &type_, const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< TResponse > &response_) const
 Retrieves records from a collection. More...
 
GrantPermissionSystemResponse grantPermissionSystem (const GrantPermissionSystemRequest &request_) const
 Grants a system-level permission to a user or role. More...
 
GrantPermissionSystemResponsegrantPermissionSystem (const GrantPermissionSystemRequest &request_, GrantPermissionSystemResponse &response_) const
 Grants a system-level permission to a user or role. More...
 
GrantPermissionSystemResponse grantPermissionSystem (const std::string &name, const std::string &permission, const std::map< std::string, std::string > &options) const
 Grants a system-level permission to a user or role. More...
 
GrantPermissionSystemResponsegrantPermissionSystem (const std::string &name, const std::string &permission, const std::map< std::string, std::string > &options, GrantPermissionSystemResponse &response_) const
 Grants a system-level permission to a user or role. More...
 
GrantPermissionTableResponse grantPermissionTable (const GrantPermissionTableRequest &request_) const
 Grants a table-level permission to a user or role. More...
 
GrantPermissionTableResponsegrantPermissionTable (const GrantPermissionTableRequest &request_, GrantPermissionTableResponse &response_) const
 Grants a table-level permission to a user or role. More...
 
GrantPermissionTableResponse grantPermissionTable (const std::string &name, const std::string &permission, const std::string &tableName, const std::string &filterExpression, const std::map< std::string, std::string > &options) const
 Grants a table-level permission to a user or role. More...
 
GrantPermissionTableResponsegrantPermissionTable (const std::string &name, const std::string &permission, const std::string &tableName, const std::string &filterExpression, const std::map< std::string, std::string > &options, GrantPermissionTableResponse &response_) const
 Grants a table-level permission to a user or role. More...
 
GrantRoleResponse grantRole (const GrantRoleRequest &request_) const
 Grants membership in a role to a user or role. More...
 
GrantRoleResponsegrantRole (const GrantRoleRequest &request_, GrantRoleResponse &response_) const
 Grants membership in a role to a user or role. More...
 
GrantRoleResponse grantRole (const std::string &role, const std::string &member, const std::map< std::string, std::string > &options) const
 Grants membership in a role to a user or role. More...
 
GrantRoleResponsegrantRole (const std::string &role, const std::string &member, const std::map< std::string, std::string > &options, GrantRoleResponse &response_) const
 Grants membership in a role to a user or role. More...
 
HasProcResponse hasProc (const HasProcRequest &request_) const
 Checks the existence of a proc with the given name. More...
 
HasProcResponsehasProc (const HasProcRequest &request_, HasProcResponse &response_) const
 Checks the existence of a proc with the given name. More...
 
HasProcResponse hasProc (const std::string &procName, const std::map< std::string, std::string > &options) const
 Checks the existence of a proc with the given name. More...
 
HasProcResponsehasProc (const std::string &procName, const std::map< std::string, std::string > &options, HasProcResponse &response_) const
 Checks the existence of a proc with the given name. More...
 
HasTableResponse hasTable (const HasTableRequest &request_) const
 Checks for the existence of a table with the given name. More...
 
HasTableResponsehasTable (const HasTableRequest &request_, HasTableResponse &response_) const
 Checks for the existence of a table with the given name. More...
 
HasTableResponse hasTable (const std::string &tableName, const std::map< std::string, std::string > &options) const
 Checks for the existence of a table with the given name. More...
 
HasTableResponsehasTable (const std::string &tableName, const std::map< std::string, std::string > &options, HasTableResponse &response_) const
 Checks for the existence of a table with the given name. More...
 
HasTypeResponse hasType (const HasTypeRequest &request_) const
 Check for the existence of a type. More...
 
HasTypeResponsehasType (const HasTypeRequest &request_, HasTypeResponse &response_) const
 Check for the existence of a type. More...
 
HasTypeResponse hasType (const std::string &typeId, const std::map< std::string, std::string > &options) const
 Check for the existence of a type. More...
 
HasTypeResponsehasType (const std::string &typeId, const std::map< std::string, std::string > &options, HasTypeResponse &response_) const
 Check for the existence of a type. More...
 
InsertRecordsResponse insertRecordsRaw (const RawInsertRecordsRequest &request_) const
 Adds multiple records to the specified table. More...
 
InsertRecordsResponseinsertRecordsRaw (const RawInsertRecordsRequest &request_, InsertRecordsResponse &response_) const
 Adds multiple records to the specified table. More...
 
template<typename TRequest >
InsertRecordsResponse insertRecords (const InsertRecordsRequest< TRequest > &request_) const
 Adds multiple records to the specified table. More...
 
template<typename TRequest >
InsertRecordsResponseinsertRecords (const InsertRecordsRequest< TRequest > &request_, InsertRecordsResponse &response_) const
 Adds multiple records to the specified table. More...
 
template<typename TRequest >
InsertRecordsResponse insertRecords (const std::string &tableName, const std::vector< TRequest > &data, const std::map< std::string, std::string > &options) const
 Adds multiple records to the specified table. More...
 
template<typename TRequest >
InsertRecordsResponseinsertRecords (const std::string &tableName, const std::vector< TRequest > &data, const std::map< std::string, std::string > &options, InsertRecordsResponse &response_) const
 Adds multiple records to the specified table. More...
 
InsertRecordsRandomResponse insertRecordsRandom (const InsertRecordsRandomRequest &request_) const
 Generates a specified number of random records and adds them to the given table. More...
 
InsertRecordsRandomResponseinsertRecordsRandom (const InsertRecordsRandomRequest &request_, InsertRecordsRandomResponse &response_) const
 Generates a specified number of random records and adds them to the given table. More...
 
InsertRecordsRandomResponse insertRecordsRandom (const std::string &tableName, const int64_t count, const std::map< std::string, std::map< std::string, double > > &options) const
 Generates a specified number of random records and adds them to the given table. More...
 
InsertRecordsRandomResponseinsertRecordsRandom (const std::string &tableName, const int64_t count, const std::map< std::string, std::map< std::string, double > > &options, InsertRecordsRandomResponse &response_) const
 Generates a specified number of random records and adds them to the given table. More...
 
InsertSymbolResponse insertSymbol (const InsertSymbolRequest &request_) const
 Adds a symbol or icon (i.e. More...
 
InsertSymbolResponseinsertSymbol (const InsertSymbolRequest &request_, InsertSymbolResponse &response_) const
 Adds a symbol or icon (i.e. More...
 
InsertSymbolResponse insertSymbol (const std::string &symbolId, const std::string &symbolFormat, const std::vector< uint8_t > &symbolData, const std::map< std::string, std::string > &options) const
 Adds a symbol or icon (i.e. More...
 
InsertSymbolResponseinsertSymbol (const std::string &symbolId, const std::string &symbolFormat, const std::vector< uint8_t > &symbolData, const std::map< std::string, std::string > &options, InsertSymbolResponse &response_) const
 Adds a symbol or icon (i.e. More...
 
KillProcResponse killProc (const KillProcRequest &request_) const
 Kills a running proc instance. More...
 
KillProcResponsekillProc (const KillProcRequest &request_, KillProcResponse &response_) const
 Kills a running proc instance. More...
 
KillProcResponse killProc (const std::string &runId, const std::map< std::string, std::string > &options) const
 Kills a running proc instance. More...
 
KillProcResponsekillProc (const std::string &runId, const std::map< std::string, std::string > &options, KillProcResponse &response_) const
 Kills a running proc instance. More...
 
LockTableResponse lockTable (const LockTableRequest &request_) const
 Manages global access to a table's data. More...
 
LockTableResponselockTable (const LockTableRequest &request_, LockTableResponse &response_) const
 Manages global access to a table's data. More...
 
LockTableResponse lockTable (const std::string &tableName, const std::string &lockType, const std::map< std::string, std::string > &options) const
 Manages global access to a table's data. More...
 
LockTableResponselockTable (const std::string &tableName, const std::string &lockType, const std::map< std::string, std::string > &options, LockTableResponse &response_) const
 Manages global access to a table's data. More...
 
MergeRecordsResponse mergeRecords (const MergeRecordsRequest &request_) const
 Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps). More...
 
MergeRecordsResponsemergeRecords (const MergeRecordsRequest &request_, MergeRecordsResponse &response_) const
 Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps). More...
 
MergeRecordsResponse mergeRecords (const std::string &tableName, const std::vector< std::string > &sourceTableNames, const std::vector< std::map< std::string, std::string > > &fieldMaps, const std::map< std::string, std::string > &options) const
 Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps). More...
 
MergeRecordsResponsemergeRecords (const std::string &tableName, const std::vector< std::string > &sourceTableNames, const std::vector< std::map< std::string, std::string > > &fieldMaps, const std::map< std::string, std::string > &options, MergeRecordsResponse &response_) const
 Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps). More...
 
RevokePermissionSystemResponse revokePermissionSystem (const RevokePermissionSystemRequest &request_) const
 Revokes a system-level permission from a user or role. More...
 
RevokePermissionSystemResponserevokePermissionSystem (const RevokePermissionSystemRequest &request_, RevokePermissionSystemResponse &response_) const
 Revokes a system-level permission from a user or role. More...
 
RevokePermissionSystemResponse revokePermissionSystem (const std::string &name, const std::string &permission, const std::map< std::string, std::string > &options) const
 Revokes a system-level permission from a user or role. More...
 
RevokePermissionSystemResponserevokePermissionSystem (const std::string &name, const std::string &permission, const std::map< std::string, std::string > &options, RevokePermissionSystemResponse &response_) const
 Revokes a system-level permission from a user or role. More...
 
RevokePermissionTableResponse revokePermissionTable (const RevokePermissionTableRequest &request_) const
 Revokes a table-level permission from a user or role. More...
 
RevokePermissionTableResponserevokePermissionTable (const RevokePermissionTableRequest &request_, RevokePermissionTableResponse &response_) const
 Revokes a table-level permission from a user or role. More...
 
RevokePermissionTableResponse revokePermissionTable (const std::string &name, const std::string &permission, const std::string &tableName, const std::map< std::string, std::string > &options) const
 Revokes a table-level permission from a user or role. More...
 
RevokePermissionTableResponserevokePermissionTable (const std::string &name, const std::string &permission, const std::string &tableName, const std::map< std::string, std::string > &options, RevokePermissionTableResponse &response_) const
 Revokes a table-level permission from a user or role. More...
 
RevokeRoleResponse revokeRole (const RevokeRoleRequest &request_) const
 Revokes membership in a role from a user or role. More...
 
RevokeRoleResponserevokeRole (const RevokeRoleRequest &request_, RevokeRoleResponse &response_) const
 Revokes membership in a role from a user or role. More...
 
RevokeRoleResponse revokeRole (const std::string &role, const std::string &member, const std::map< std::string, std::string > &options) const
 Revokes membership in a role from a user or role. More...
 
RevokeRoleResponserevokeRole (const std::string &role, const std::string &member, const std::map< std::string, std::string > &options, RevokeRoleResponse &response_) const
 Revokes membership in a role from a user or role. More...
 
ShowProcResponse showProc (const ShowProcRequest &request_) const
 Shows information about a proc. More...
 
ShowProcResponseshowProc (const ShowProcRequest &request_, ShowProcResponse &response_) const
 Shows information about a proc. More...
 
ShowProcResponse showProc (const std::string &procName, const std::map< std::string, std::string > &options) const
 Shows information about a proc. More...
 
ShowProcResponseshowProc (const std::string &procName, const std::map< std::string, std::string > &options, ShowProcResponse &response_) const
 Shows information about a proc. More...
 
ShowProcStatusResponse showProcStatus (const ShowProcStatusRequest &request_) const
 Shows the statuses of running or completed proc instances. More...
 
ShowProcStatusResponseshowProcStatus (const ShowProcStatusRequest &request_, ShowProcStatusResponse &response_) const
 Shows the statuses of running or completed proc instances. More...
 
ShowProcStatusResponse showProcStatus (const std::string &runId, const std::map< std::string, std::string > &options) const
 Shows the statuses of running or completed proc instances. More...
 
ShowProcStatusResponseshowProcStatus (const std::string &runId, const std::map< std::string, std::string > &options, ShowProcStatusResponse &response_) const
 Shows the statuses of running or completed proc instances. More...
 
ShowSecurityResponse showSecurity (const ShowSecurityRequest &request_) const
 Shows security information relating to users and/or roles. More...
 
ShowSecurityResponseshowSecurity (const ShowSecurityRequest &request_, ShowSecurityResponse &response_) const
 Shows security information relating to users and/or roles. More...
 
ShowSecurityResponse showSecurity (const std::vector< std::string > &names, const std::map< std::string, std::string > &options) const
 Shows security information relating to users and/or roles. More...
 
ShowSecurityResponseshowSecurity (const std::vector< std::string > &names, const std::map< std::string, std::string > &options, ShowSecurityResponse &response_) const
 Shows security information relating to users and/or roles. More...
 
ShowSystemPropertiesResponse showSystemProperties (const ShowSystemPropertiesRequest &request_) const
 Returns server configuration and version related information to the caller. More...
 
ShowSystemPropertiesResponseshowSystemProperties (const ShowSystemPropertiesRequest &request_, ShowSystemPropertiesResponse &response_) const
 Returns server configuration and version related information to the caller. More...
 
ShowSystemPropertiesResponse showSystemProperties (const std::map< std::string, std::string > &options) const
 Returns server configuration and version related information to the caller. More...
 
ShowSystemPropertiesResponseshowSystemProperties (const std::map< std::string, std::string > &options, ShowSystemPropertiesResponse &response_) const
 Returns server configuration and version related information to the caller. More...
 
ShowSystemStatusResponse showSystemStatus (const ShowSystemStatusRequest &request_) const
 Provides server configuration and health related status to the caller. More...
 
ShowSystemStatusResponseshowSystemStatus (const ShowSystemStatusRequest &request_, ShowSystemStatusResponse &response_) const
 Provides server configuration and health related status to the caller. More...
 
ShowSystemStatusResponse showSystemStatus (const std::map< std::string, std::string > &options) const
 Provides server configuration and health related status to the caller. More...
 
ShowSystemStatusResponseshowSystemStatus (const std::map< std::string, std::string > &options, ShowSystemStatusResponse &response_) const
 Provides server configuration and health related status to the caller. More...
 
ShowSystemTimingResponse showSystemTiming (const ShowSystemTimingRequest &request_) const
 Returns the last 100 database requests along with the request timing and internal job id. More...
 
ShowSystemTimingResponseshowSystemTiming (const ShowSystemTimingRequest &request_, ShowSystemTimingResponse &response_) const
 Returns the last 100 database requests along with the request timing and internal job id. More...
 
ShowSystemTimingResponse showSystemTiming (const std::map< std::string, std::string > &options) const
 Returns the last 100 database requests along with the request timing and internal job id. More...
 
ShowSystemTimingResponseshowSystemTiming (const std::map< std::string, std::string > &options, ShowSystemTimingResponse &response_) const
 Returns the last 100 database requests along with the request timing and internal job id. More...
 
ShowTableResponse showTable (const ShowTableRequest &request_) const
 Retrieves detailed information about tables, views, and collections. More...
 
ShowTableResponseshowTable (const ShowTableRequest &request_, ShowTableResponse &response_) const
 Retrieves detailed information about tables, views, and collections. More...
 
ShowTableResponse showTable (const std::string &tableName, const std::map< std::string, std::string > &options) const
 Retrieves detailed information about tables, views, and collections. More...
 
ShowTableResponseshowTable (const std::string &tableName, const std::map< std::string, std::string > &options, ShowTableResponse &response_) const
 Retrieves detailed information about tables, views, and collections. More...
 
ShowTableMetadataResponse showTableMetadata (const ShowTableMetadataRequest &request_) const
 Retrieves the user provided metadata for the specified tables. More...
 
ShowTableMetadataResponseshowTableMetadata (const ShowTableMetadataRequest &request_, ShowTableMetadataResponse &response_) const
 Retrieves the user provided metadata for the specified tables. More...
 
ShowTableMetadataResponse showTableMetadata (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options) const
 Retrieves the user provided metadata for the specified tables. More...
 
ShowTableMetadataResponseshowTableMetadata (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options, ShowTableMetadataResponse &response_) const
 Retrieves the user provided metadata for the specified tables. More...
 
ShowTablesByTypeResponse showTablesByType (const ShowTablesByTypeRequest &request_) const
 Gets names of the tables whose type matches the given criteria. More...
 
ShowTablesByTypeResponseshowTablesByType (const ShowTablesByTypeRequest &request_, ShowTablesByTypeResponse &response_) const
 Gets names of the tables whose type matches the given criteria. More...
 
ShowTablesByTypeResponse showTablesByType (const std::string &typeId, const std::string &label, const std::map< std::string, std::string > &options) const
 Gets names of the tables whose type matches the given criteria. More...
 
ShowTablesByTypeResponseshowTablesByType (const std::string &typeId, const std::string &label, const std::map< std::string, std::string > &options, ShowTablesByTypeResponse &response_) const
 Gets names of the tables whose type matches the given criteria. More...
 
ShowTriggersResponse showTriggers (const ShowTriggersRequest &request_) const
 Retrieves information regarding the specified triggers or all existing triggers currently active. More...
 
ShowTriggersResponseshowTriggers (const ShowTriggersRequest &request_, ShowTriggersResponse &response_) const
 Retrieves information regarding the specified triggers or all existing triggers currently active. More...
 
ShowTriggersResponse showTriggers (const std::vector< std::string > &triggerIds, const std::map< std::string, std::string > &options) const
 Retrieves information regarding the specified triggers or all existing triggers currently active. More...
 
ShowTriggersResponseshowTriggers (const std::vector< std::string > &triggerIds, const std::map< std::string, std::string > &options, ShowTriggersResponse &response_) const
 Retrieves information regarding the specified triggers or all existing triggers currently active. More...
 
ShowTypesResponse showTypes (const ShowTypesRequest &request_) const
 Retrieves information for the specified data type ID or type label. More...
 
ShowTypesResponseshowTypes (const ShowTypesRequest &request_, ShowTypesResponse &response_) const
 Retrieves information for the specified data type ID or type label. More...
 
ShowTypesResponse showTypes (const std::string &typeId, const std::string &label, const std::map< std::string, std::string > &options) const
 Retrieves information for the specified data type ID or type label. More...
 
ShowTypesResponseshowTypes (const std::string &typeId, const std::string &label, const std::map< std::string, std::string > &options, ShowTypesResponse &response_) const
 Retrieves information for the specified data type ID or type label. More...
 
UpdateRecordsResponse updateRecordsRaw (const RawUpdateRecordsRequest &request_) const
 Runs multiple predicate-based updates in a single call. More...
 
UpdateRecordsResponseupdateRecordsRaw (const RawUpdateRecordsRequest &request_, UpdateRecordsResponse &response_) const
 Runs multiple predicate-based updates in a single call. More...
 
template<typename TRequest >
UpdateRecordsResponse updateRecords (const UpdateRecordsRequest< TRequest > &request_) const
 Runs multiple predicate-based updates in a single call. More...
 
template<typename TRequest >
UpdateRecordsResponseupdateRecords (const UpdateRecordsRequest< TRequest > &request_, UpdateRecordsResponse &response_) const
 Runs multiple predicate-based updates in a single call. More...
 
template<typename TRequest >
UpdateRecordsResponse updateRecords (const std::string &tableName, const std::vector< std::string > &expressions, const std::vector< std::map< std::string, boost::optional< std::string > > > &newValuesMaps, const std::vector< TRequest > &data, const std::map< std::string, std::string > &options) const
 Runs multiple predicate-based updates in a single call. More...
 
template<typename TRequest >
UpdateRecordsResponseupdateRecords (const std::string &tableName, const std::vector< std::string > &expressions, const std::vector< std::map< std::string, boost::optional< std::string > > > &newValuesMaps, const std::vector< TRequest > &data, const std::map< std::string, std::string > &options, UpdateRecordsResponse &response_) const
 Runs multiple predicate-based updates in a single call. More...
 
UpdateRecordsBySeriesResponse updateRecordsBySeries (const UpdateRecordsBySeriesRequest &request_) const
 Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName. More...
 
UpdateRecordsBySeriesResponseupdateRecordsBySeries (const UpdateRecordsBySeriesRequest &request_, UpdateRecordsBySeriesResponse &response_) const
 Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName. More...
 
UpdateRecordsBySeriesResponse updateRecordsBySeries (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) const
 Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName. More...
 
UpdateRecordsBySeriesResponseupdateRecordsBySeries (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, UpdateRecordsBySeriesResponse &response_) const
 Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName. More...
 
VisualizeImageChartResponse visualizeImageChart (const VisualizeImageChartRequest &request_) const
 Scatter plot is the only plot type currently supported. More...
 
VisualizeImageChartResponsevisualizeImageChart (const VisualizeImageChartRequest &request_, VisualizeImageChartResponse &response_) const
 Scatter plot is the only plot type currently supported. More...
 
VisualizeImageChartResponse visualizeImageChart (const std::string &tableName, const std::vector< std::string > &xColumnNames, const std::vector< std::string > &yColumnNames, const double minX, const double maxX, const double minY, const double maxY, const int32_t width, const int32_t height, const std::string &bgColor, const std::map< std::string, std::vector< std::string > > &styleOptions, const std::map< std::string, std::string > &options) const
 Scatter plot is the only plot type currently supported. More...
 
VisualizeImageChartResponsevisualizeImageChart (const std::string &tableName, const std::vector< std::string > &xColumnNames, const std::vector< std::string > &yColumnNames, const double minX, const double maxX, const double minY, const double maxY, const int32_t width, const int32_t height, const std::string &bgColor, const std::map< std::string, std::vector< std::string > > &styleOptions, const std::map< std::string, std::string > &options, VisualizeImageChartResponse &response_) const
 Scatter plot is the only plot type currently supported. More...
 
void addKnownType (const std::string &typeId, const avro::DecoderPtr &decoder)
 
template<typename T >
void addKnownType (const std::string &typeId)
 
template<typename T >
void addKnownType (const std::string &typeId, const std::string &schemaString)
 
template<typename T >
void addKnownType (const std::string &typeId, const ::avro::ValidSchema &schema)
 
void addKnownTypeFromTable (const std::string &tableName, const avro::DecoderPtr &decoder)
 
template<typename T >
void addKnownTypeFromTable (const std::string &tableName)
 
template<typename T >
void addKnownTypeFromTable (const std::string &tableName, const std::string &schemaString)
 
template<typename T >
void addKnownTypeFromTable (const std::string &tableName, const ::avro::ValidSchema &schema)
 
template<>
GetRecordsResponse< boost::any > getRecords (const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsResponse< boost::any > & getRecords (const GetRecordsRequest &request_, GetRecordsResponse< boost::any > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsResponse< boost::any > getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsResponse< boost::any > & getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< boost::any > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > getRecordsBySeries (const GetRecordsBySeriesRequest &request_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > & getRecordsBySeries (const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< boost::any > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > & getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< boost::any > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > & getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< boost::any > &response_) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > & getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< boost::any > &response_) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsResponse< boost::any > getRecords (const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsResponse< boost::any > & getRecords (const GetRecordsRequest &request_, GetRecordsResponse< boost::any > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsResponse< boost::any > getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsResponse< boost::any > & getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< boost::any > &response_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > getRecordsBySeries (const GetRecordsBySeriesRequest &request_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > & getRecordsBySeries (const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< boost::any > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsBySeriesResponse< boost::any > & getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< boost::any > &response_) const
 Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > & getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< boost::any > &response_) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
 Retrieves records from a collection. More...
 
template<>
GetRecordsFromCollectionResponse< boost::any > & getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< boost::any > &response_) const
 Retrieves records from a collection. More...
 

Static Public Member Functions

static std::string getApiVersion ()
 

Static Public Attributes

static const int64_t END_OF_SET = -9999
 

Detailed Description

Definition at line 55 of file GPUdb.hpp.

Constructor & Destructor Documentation

◆ GPUdb() [1/4]

gpudb::GPUdb::GPUdb ( const HttpUrl url,
const Options options = Options() 
)

◆ GPUdb() [2/4]

gpudb::GPUdb::GPUdb ( const std::string &  url,
const Options options = Options() 
)

◆ GPUdb() [3/4]

gpudb::GPUdb::GPUdb ( const std::vector< HttpUrl > &  urls,
const Options options = Options() 
)

◆ GPUdb() [4/4]

gpudb::GPUdb::GPUdb ( const std::vector< std::string > &  urls,
const Options options = Options() 
)

Member Function Documentation

◆ addKnownType() [1/4]

void gpudb::GPUdb::addKnownType ( const std::string &  typeId,
const avro::DecoderPtr &  decoder 
)

◆ addKnownType() [2/4]

template<typename T >
void gpudb::GPUdb::addKnownType ( const std::string &  typeId)
inline

Definition at line 235 of file GPUdb.hpp.

◆ addKnownType() [3/4]

template<typename T >
void gpudb::GPUdb::addKnownType ( const std::string &  typeId,
const std::string &  schemaString 
)
inline

Definition at line 241 of file GPUdb.hpp.

◆ addKnownType() [4/4]

template<typename T >
void gpudb::GPUdb::addKnownType ( const std::string &  typeId,
const ::avro::ValidSchema &  schema 
)
inline

Definition at line 247 of file GPUdb.hpp.

◆ addKnownTypeFromTable() [1/4]

void gpudb::GPUdb::addKnownTypeFromTable ( const std::string &  tableName,
const avro::DecoderPtr &  decoder 
)

◆ addKnownTypeFromTable() [2/4]

template<typename T >
void gpudb::GPUdb::addKnownTypeFromTable ( const std::string &  tableName)
inline

Definition at line 255 of file GPUdb.hpp.

◆ addKnownTypeFromTable() [3/4]

template<typename T >
void gpudb::GPUdb::addKnownTypeFromTable ( const std::string &  tableName,
const std::string &  schemaString 
)
inline

Definition at line 261 of file GPUdb.hpp.

◆ addKnownTypeFromTable() [4/4]

template<typename T >
void gpudb::GPUdb::addKnownTypeFromTable ( const std::string &  tableName,
const ::avro::ValidSchema &  schema 
)
inline

Definition at line 267 of file GPUdb.hpp.

◆ adminAlterJobs() [1/4]

AdminAlterJobsResponse gpudb::GPUdb::adminAlterJobs ( const AdminAlterJobsRequest request_) const

Perform the requested action on a list of one or more job(s).

Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminAlterJobs() [2/4]

AdminAlterJobsResponse& gpudb::GPUdb::adminAlterJobs ( const AdminAlterJobsRequest request_,
AdminAlterJobsResponse response_ 
) const

Perform the requested action on a list of one or more job(s).

Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminAlterJobs() [3/4]

AdminAlterJobsResponse gpudb::GPUdb::adminAlterJobs ( const std::vector< int32_t > &  jobIds,
const std::string &  action,
const std::map< std::string, std::string > &  options 
) const

Perform the requested action on a list of one or more job(s).

Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.

Parameters
jobIdsJobs to be modified.
actionAction to be performed on the jobs specified by job_ids.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminAlterJobs() [4/4]

AdminAlterJobsResponse& gpudb::GPUdb::adminAlterJobs ( const std::vector< int32_t > &  jobIds,
const std::string &  action,
const std::map< std::string, std::string > &  options,
AdminAlterJobsResponse response_ 
) const

Perform the requested action on a list of one or more job(s).

Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.

Parameters
jobIdsJobs to be modified.
actionAction to be performed on the jobs specified by job_ids.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminOffline() [1/4]

AdminOfflineResponse gpudb::GPUdb::adminOffline ( const AdminOfflineRequest request_) const

Take the system offline.

When the system is offline, no user operations can be performed with the exception of a system shutdown.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminOffline() [2/4]

AdminOfflineResponse& gpudb::GPUdb::adminOffline ( const AdminOfflineRequest request_,
AdminOfflineResponse response_ 
) const

Take the system offline.

When the system is offline, no user operations can be performed with the exception of a system shutdown.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminOffline() [3/4]

AdminOfflineResponse gpudb::GPUdb::adminOffline ( const bool  offline,
const std::map< std::string, std::string > &  options 
) const

Take the system offline.

When the system is offline, no user operations can be performed with the exception of a system shutdown.

Parameters
offlineSet to true if desired state is offline.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminOffline() [4/4]

AdminOfflineResponse& gpudb::GPUdb::adminOffline ( const bool  offline,
const std::map< std::string, std::string > &  options,
AdminOfflineResponse response_ 
) const

Take the system offline.

When the system is offline, no user operations can be performed with the exception of a system shutdown.

Parameters
offlineSet to true if desired state is offline.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShowAlerts() [1/4]

AdminShowAlertsResponse gpudb::GPUdb::adminShowAlerts ( const AdminShowAlertsRequest request_) const

Retrieves a list of the most recent alerts generated.

The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminShowAlerts() [2/4]

AdminShowAlertsResponse& gpudb::GPUdb::adminShowAlerts ( const AdminShowAlertsRequest request_,
AdminShowAlertsResponse response_ 
) const

Retrieves a list of the most recent alerts generated.

The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShowAlerts() [3/4]

AdminShowAlertsResponse gpudb::GPUdb::adminShowAlerts ( const int32_t  numAlerts,
const std::map< std::string, std::string > &  options 
) const

Retrieves a list of the most recent alerts generated.

The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Parameters
numAlertsNumber of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminShowAlerts() [4/4]

AdminShowAlertsResponse& gpudb::GPUdb::adminShowAlerts ( const int32_t  numAlerts,
const std::map< std::string, std::string > &  options,
AdminShowAlertsResponse response_ 
) const

Retrieves a list of the most recent alerts generated.

The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Parameters
numAlertsNumber of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShowJobs() [1/4]

AdminShowJobsResponse gpudb::GPUdb::adminShowJobs ( const AdminShowJobsRequest request_) const

Get a list of the current jobs in GPUdb.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminShowJobs() [2/4]

AdminShowJobsResponse& gpudb::GPUdb::adminShowJobs ( const AdminShowJobsRequest request_,
AdminShowJobsResponse response_ 
) const

Get a list of the current jobs in GPUdb.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShowJobs() [3/4]

AdminShowJobsResponse gpudb::GPUdb::adminShowJobs ( const std::map< std::string, std::string > &  options) const

Get a list of the current jobs in GPUdb.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminShowJobs() [4/4]

AdminShowJobsResponse& gpudb::GPUdb::adminShowJobs ( const std::map< std::string, std::string > &  options,
AdminShowJobsResponse response_ 
) const

Get a list of the current jobs in GPUdb.

Parameters
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShowShards() [1/4]

AdminShowShardsResponse gpudb::GPUdb::adminShowShards ( const AdminShowShardsRequest request_) const

Show the mapping of shards to the corresponding rank and tom.

The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminShowShards() [2/4]

AdminShowShardsResponse& gpudb::GPUdb::adminShowShards ( const AdminShowShardsRequest request_,
AdminShowShardsResponse response_ 
) const

Show the mapping of shards to the corresponding rank and tom.

The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShowShards() [3/4]

AdminShowShardsResponse gpudb::GPUdb::adminShowShards ( const std::map< std::string, std::string > &  options) const

Show the mapping of shards to the corresponding rank and tom.

The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminShowShards() [4/4]

AdminShowShardsResponse& gpudb::GPUdb::adminShowShards ( const std::map< std::string, std::string > &  options,
AdminShowShardsResponse response_ 
) const

Show the mapping of shards to the corresponding rank and tom.

The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.

Parameters
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShutdown() [1/4]

AdminShutdownResponse gpudb::GPUdb::adminShutdown ( const AdminShutdownRequest request_) const

Exits the database server application.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminShutdown() [2/4]

AdminShutdownResponse& gpudb::GPUdb::adminShutdown ( const AdminShutdownRequest request_,
AdminShutdownResponse response_ 
) const

Exits the database server application.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminShutdown() [3/4]

AdminShutdownResponse gpudb::GPUdb::adminShutdown ( const std::string &  exitType,
const std::string &  authorization,
const std::map< std::string, std::string > &  options 
) const

Exits the database server application.

Parameters
exitTypeReserved for future use. User can pass an empty string.
authorizationNo longer used. User can pass an empty string.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminShutdown() [4/4]

AdminShutdownResponse& gpudb::GPUdb::adminShutdown ( const std::string &  exitType,
const std::string &  authorization,
const std::map< std::string, std::string > &  options,
AdminShutdownResponse response_ 
) const

Exits the database server application.

Parameters
exitTypeReserved for future use. User can pass an empty string.
authorizationNo longer used. User can pass an empty string.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminVerifyDb() [1/4]

AdminVerifyDbResponse gpudb::GPUdb::adminVerifyDb ( const AdminVerifyDbRequest request_) const

Verify database is in a consistent state.

When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ adminVerifyDb() [2/4]

AdminVerifyDbResponse& gpudb::GPUdb::adminVerifyDb ( const AdminVerifyDbRequest request_,
AdminVerifyDbResponse response_ 
) const

Verify database is in a consistent state.

When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ adminVerifyDb() [3/4]

AdminVerifyDbResponse gpudb::GPUdb::adminVerifyDb ( const std::map< std::string, std::string > &  options) const

Verify database is in a consistent state.

When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ adminVerifyDb() [4/4]

AdminVerifyDbResponse& gpudb::GPUdb::adminVerifyDb ( const std::map< std::string, std::string > &  options,
AdminVerifyDbResponse response_ 
) const

Verify database is in a consistent state.

When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.

Parameters
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateConvexHull() [1/4]

AggregateConvexHullResponse gpudb::GPUdb::aggregateConvexHull ( const AggregateConvexHullRequest request_) const

Calculates and returns the convex hull for the values in a table specified by tableName.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateConvexHull() [2/4]

AggregateConvexHullResponse& gpudb::GPUdb::aggregateConvexHull ( const AggregateConvexHullRequest request_,
AggregateConvexHullResponse response_ 
) const

Calculates and returns the convex hull for the values in a table specified by tableName.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateConvexHull() [3/4]

AggregateConvexHullResponse gpudb::GPUdb::aggregateConvexHull ( const std::string &  tableName,
const std::string &  xColumnName,
const std::string &  yColumnName,
const std::map< std::string, std::string > &  options 
) const

Calculates and returns the convex hull for the values in a table specified by tableName.

Parameters
tableNameName of table on which the operation will be performed. Must be an existing table. It cannot be a collection.
xColumnNameName of the column containing the x coordinates of the points for the operation being performed.
yColumnNameName of the column containing the y coordinates of the points for the operation being performed.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateConvexHull() [4/4]

AggregateConvexHullResponse& gpudb::GPUdb::aggregateConvexHull ( const std::string &  tableName,
const std::string &  xColumnName,
const std::string &  yColumnName,
const std::map< std::string, std::string > &  options,
AggregateConvexHullResponse response_ 
) const

Calculates and returns the convex hull for the values in a table specified by tableName.

Parameters
tableNameName of table on which the operation will be performed. Must be an existing table. It cannot be a collection.
xColumnNameName of the column containing the x coordinates of the points for the operation being performed.
yColumnNameName of the column containing the y coordinates of the points for the operation being performed.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateGroupBy() [1/4]

AggregateGroupByResponse gpudb::GPUdb::aggregateGroupBy ( const AggregateGroupByRequest request_) const

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.

The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.

options can be used to customize behavior of this call e.g. filtering or sorting the results.

To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].

To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].

Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to having.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateGroupBy() [2/4]

AggregateGroupByResponse& gpudb::GPUdb::aggregateGroupBy ( const AggregateGroupByRequest request_,
AggregateGroupByResponse response_ 
) const

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.

The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.

options can be used to customize behavior of this call e.g. filtering or sorting the results.

To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].

To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].

Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to having.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateGroupBy() [3/4]

AggregateGroupByResponse gpudb::GPUdb::aggregateGroupBy ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.

The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.

options can be used to customize behavior of this call e.g. filtering or sorting the results.

To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].

To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].

Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to having.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table/view/collection.
columnNamesList of one or more column names, expressions, and aggregate expressions.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateGroupBy() [4/4]

AggregateGroupByResponse& gpudb::GPUdb::aggregateGroupBy ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
AggregateGroupByResponse response_ 
) const

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.

The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.

options can be used to customize behavior of this call e.g. filtering or sorting the results.

To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].

To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].

Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to having.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table/view/collection.
columnNamesList of one or more column names, expressions, and aggregate expressions.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateGroupByRaw() [1/2]

RawAggregateGroupByResponse gpudb::GPUdb::aggregateGroupByRaw ( const AggregateGroupByRequest request_) const

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.

The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.

options can be used to customize behavior of this call e.g. filtering or sorting the results.

To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].

To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].

Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to having.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateGroupByRaw() [2/2]

RawAggregateGroupByResponse& gpudb::GPUdb::aggregateGroupByRaw ( const AggregateGroupByRequest request_,
RawAggregateGroupByResponse response_ 
) const

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.

This is somewhat analogous to an SQL-style SELECT...GROUP BY.

For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.

Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.

The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.

options can be used to customize behavior of this call e.g. filtering or sorting the results.

To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].

To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].

Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.

Available grouping functions are Rollup, Cube, and Grouping Sets

This service also provides support for Pivot operations.

Filtering on aggregates is supported via expressions using aggregation functions supplied to having.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateHistogram() [1/4]

AggregateHistogramResponse gpudb::GPUdb::aggregateHistogram ( const AggregateHistogramRequest request_) const

Performs a histogram calculation given a table, a column, and an interval function.

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateHistogram() [2/4]

AggregateHistogramResponse& gpudb::GPUdb::aggregateHistogram ( const AggregateHistogramRequest request_,
AggregateHistogramResponse response_ 
) const

Performs a histogram calculation given a table, a column, and an interval function.

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateHistogram() [3/4]

AggregateHistogramResponse gpudb::GPUdb::aggregateHistogram ( const std::string &  tableName,
const std::string &  columnName,
const double  start,
const double  end,
const double  interval,
const std::map< std::string, std::string > &  options 
) const

Performs a histogram calculation given a table, a column, and an interval function.

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table or collection.
columnNameName of a column or an expression of one or more column names over which the histogram will be calculated.
startLower end value of the histogram interval, inclusive.
endUpper end value of the histogram interval, inclusive.
intervalThe size of each bin within the start and end parameters.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateHistogram() [4/4]

AggregateHistogramResponse& gpudb::GPUdb::aggregateHistogram ( const std::string &  tableName,
const std::string &  columnName,
const double  start,
const double  end,
const double  interval,
const std::map< std::string, std::string > &  options,
AggregateHistogramResponse response_ 
) const

Performs a histogram calculation given a table, a column, and an interval function.

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table or collection.
columnNameName of a column or an expression of one or more column names over which the histogram will be calculated.
startLower end value of the histogram interval, inclusive.
endUpper end value of the histogram interval, inclusive.
intervalThe size of each bin within the start and end parameters.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateKMeans() [1/4]

AggregateKMeansResponse gpudb::GPUdb::aggregateKMeans ( const AggregateKMeansRequest request_) const

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.

An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateKMeans() [2/4]

AggregateKMeansResponse& gpudb::GPUdb::aggregateKMeans ( const AggregateKMeansRequest request_,
AggregateKMeansResponse response_ 
) const

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.

An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateKMeans() [3/4]

AggregateKMeansResponse gpudb::GPUdb::aggregateKMeans ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const int32_t  k,
const double  tolerance,
const std::map< std::string, std::string > &  options 
) const

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.

An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table or collection.
columnNamesList of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
kThe number of mean points to be determined by the algorithm.
toleranceStop iterating when the distances between successive points is less than the given tolerance.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateKMeans() [4/4]

AggregateKMeansResponse& gpudb::GPUdb::aggregateKMeans ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const int32_t  k,
const double  tolerance,
const std::map< std::string, std::string > &  options,
AggregateKMeansResponse response_ 
) const

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.

An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table or collection.
columnNamesList of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
kThe number of mean points to be determined by the algorithm.
toleranceStop iterating when the distances between successive points is less than the given tolerance.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateMinMax() [1/4]

AggregateMinMaxResponse gpudb::GPUdb::aggregateMinMax ( const AggregateMinMaxRequest request_) const

Calculates and returns the minimum and maximum values of a particular column in a table.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateMinMax() [2/4]

AggregateMinMaxResponse& gpudb::GPUdb::aggregateMinMax ( const AggregateMinMaxRequest request_,
AggregateMinMaxResponse response_ 
) const

Calculates and returns the minimum and maximum values of a particular column in a table.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateMinMax() [3/4]

AggregateMinMaxResponse gpudb::GPUdb::aggregateMinMax ( const std::string &  tableName,
const std::string &  columnName,
const std::map< std::string, std::string > &  options 
) const

Calculates and returns the minimum and maximum values of a particular column in a table.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table.
columnNameName of a column or an expression of one or more column on which the min-max will be calculated.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateMinMax() [4/4]

AggregateMinMaxResponse& gpudb::GPUdb::aggregateMinMax ( const std::string &  tableName,
const std::string &  columnName,
const std::map< std::string, std::string > &  options,
AggregateMinMaxResponse response_ 
) const

Calculates and returns the minimum and maximum values of a particular column in a table.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table.
columnNameName of a column or an expression of one or more column on which the min-max will be calculated.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateMinMaxGeometry() [1/4]

AggregateMinMaxGeometryResponse gpudb::GPUdb::aggregateMinMaxGeometry ( const AggregateMinMaxGeometryRequest request_) const

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateMinMaxGeometry() [2/4]

AggregateMinMaxGeometryResponse& gpudb::GPUdb::aggregateMinMaxGeometry ( const AggregateMinMaxGeometryRequest request_,
AggregateMinMaxGeometryResponse response_ 
) const

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateMinMaxGeometry() [3/4]

AggregateMinMaxGeometryResponse gpudb::GPUdb::aggregateMinMaxGeometry ( const std::string &  tableName,
const std::string &  columnName,
const std::map< std::string, std::string > &  options 
) const

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table.
columnNameName of a geospatial geometry column on which the min-max will be calculated.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateMinMaxGeometry() [4/4]

AggregateMinMaxGeometryResponse& gpudb::GPUdb::aggregateMinMaxGeometry ( const std::string &  tableName,
const std::string &  columnName,
const std::map< std::string, std::string > &  options,
AggregateMinMaxGeometryResponse response_ 
) const

Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table.
columnNameName of a geospatial geometry column on which the min-max will be calculated.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateStatistics() [1/4]

AggregateStatisticsResponse gpudb::GPUdb::aggregateStatistics ( const AggregateStatisticsRequest request_) const

Calculates the requested statistics of the given column(s) in a given table.

The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.

Estimated cardinality is calculated by using the hyperloglog approximation technique.

Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').

A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.

The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.

Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).

The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateStatistics() [2/4]

AggregateStatisticsResponse& gpudb::GPUdb::aggregateStatistics ( const AggregateStatisticsRequest request_,
AggregateStatisticsResponse response_ 
) const

Calculates the requested statistics of the given column(s) in a given table.

The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.

Estimated cardinality is calculated by using the hyperloglog approximation technique.

Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').

A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.

The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.

Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).

The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateStatistics() [3/4]

AggregateStatisticsResponse gpudb::GPUdb::aggregateStatistics ( const std::string &  tableName,
const std::string &  columnName,
const std::string &  stats,
const std::map< std::string, std::string > &  options 
) const

Calculates the requested statistics of the given column(s) in a given table.

The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.

Estimated cardinality is calculated by using the hyperloglog approximation technique.

Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').

A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.

The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.

Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).

The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Parameters
tableNameName of the table on which the statistics operation will be performed.
columnNameName of the primary column for which the statistics are to be calculated.
statsComma separated list of the statistics to calculate, e.g. "sum,mean".
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateStatistics() [4/4]

AggregateStatisticsResponse& gpudb::GPUdb::aggregateStatistics ( const std::string &  tableName,
const std::string &  columnName,
const std::string &  stats,
const std::map< std::string, std::string > &  options,
AggregateStatisticsResponse response_ 
) const

Calculates the requested statistics of the given column(s) in a given table.

The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.

Estimated cardinality is calculated by using the hyperloglog approximation technique.

Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').

A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.

The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.

Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation–individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).

The response includes a list of key/value pairs of each statistic requested and its corresponding value.

Parameters
tableNameName of the table on which the statistics operation will be performed.
columnNameName of the primary column for which the statistics are to be calculated.
statsComma separated list of the statistics to calculate, e.g. "sum,mean".
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateStatisticsByRange() [1/4]

AggregateStatisticsByRangeResponse gpudb::GPUdb::aggregateStatisticsByRange ( const AggregateStatisticsByRangeRequest request_) const

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateStatisticsByRange() [2/4]

AggregateStatisticsByRangeResponse& gpudb::GPUdb::aggregateStatisticsByRange ( const AggregateStatisticsByRangeRequest request_,
AggregateStatisticsByRangeResponse response_ 
) const

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateStatisticsByRange() [3/4]

AggregateStatisticsByRangeResponse gpudb::GPUdb::aggregateStatisticsByRange ( const std::string &  tableName,
const std::string &  selectExpression,
const std::string &  columnName,
const std::string &  valueColumnName,
const std::string &  stats,
const double  start,
const double  end,
const double  interval,
const std::map< std::string, std::string > &  options 
) const

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
tableNameName of the table on which the ranged-statistics operation will be performed.
selectExpressionFor a non-empty expression statistics are calculated for those records for which the expression is true.
columnNameName of the binning-column used to divide the set samples into bins.
valueColumnNameName of the value-column for which statistics are to be computed.
statsA string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
startThe lower bound of the binning-column.
endThe upper bound of the binning-column.
intervalThe interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)).
optionsMap of optional parameters:
Returns
Response object containing the result of the operation.

◆ aggregateStatisticsByRange() [4/4]

AggregateStatisticsByRangeResponse& gpudb::GPUdb::aggregateStatisticsByRange ( const std::string &  tableName,
const std::string &  selectExpression,
const std::string &  columnName,
const std::string &  valueColumnName,
const std::string &  stats,
const double  start,
const double  end,
const double  interval,
const std::map< std::string, std::string > &  options,
AggregateStatisticsByRangeResponse response_ 
) const

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight_column to be specified in options. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range [min+n*interval,min+(n+1)*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is [min+(nbin-1)*interval,max]. In the second method, options bin_values specifies a list of binning column values. Binning-columns whose value matches the nth member of the bin_values list are placed in the nth bin. When a list is provided the binning-column must be of type string or int.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Parameters
tableNameName of the table on which the ranged-statistics operation will be performed.
selectExpressionFor a non-empty expression statistics are calculated for those records for which the expression is true.
columnNameName of the binning-column used to divide the set samples into bins.
valueColumnNameName of the value-column for which statistics are to be computed.
statsA string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
startThe lower bound of the binning-column.
endThe upper bound of the binning-column.
intervalThe interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval*i, start+interval*(i+1)).
optionsMap of optional parameters:
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateUnique() [1/4]

AggregateUniqueResponse gpudb::GPUdb::aggregateUnique ( const AggregateUniqueRequest request_) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName).

If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateUnique() [2/4]

AggregateUniqueResponse& gpudb::GPUdb::aggregateUnique ( const AggregateUniqueRequest request_,
AggregateUniqueResponse response_ 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName).

If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateUnique() [3/4]

AggregateUniqueResponse gpudb::GPUdb::aggregateUnique ( const std::string &  tableName,
const std::string &  columnName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName).

If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Parameters
tableNameName of an existing table/collection on which the operation will be performed.
columnNameName of the column or an expression containing one or more column names on which the unique function would be applied.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateUnique() [4/4]

AggregateUniqueResponse& gpudb::GPUdb::aggregateUnique ( const std::string &  tableName,
const std::string &  columnName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
AggregateUniqueResponse response_ 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName).

If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Parameters
tableNameName of an existing table/collection on which the operation will be performed.
columnNameName of the column or an expression containing one or more column names on which the unique function would be applied.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateUniqueRaw() [1/2]

RawAggregateUniqueResponse gpudb::GPUdb::aggregateUniqueRaw ( const AggregateUniqueRequest request_) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName).

If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateUniqueRaw() [2/2]

RawAggregateUniqueResponse& gpudb::GPUdb::aggregateUniqueRaw ( const AggregateUniqueRequest request_,
RawAggregateUniqueResponse response_ 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName).

If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateUnpivot() [1/4]

AggregateUnpivotResponse gpudb::GPUdb::aggregateUnpivot ( const AggregateUnpivotRequest request_) const

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateUnpivot() [2/4]

AggregateUnpivotResponse& gpudb::GPUdb::aggregateUnpivot ( const AggregateUnpivotRequest request_,
AggregateUnpivotResponse response_ 
) const

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateUnpivot() [3/4]

AggregateUnpivotResponse gpudb::GPUdb::aggregateUnpivot ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const std::string &  variableColumnName,
const std::string &  valueColumnName,
const std::vector< std::string > &  pivotedColumns,
const std::map< std::string, std::string > &  options 
) const

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table/view.
columnNamesList of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table.
variableColumnNameSpecifies the variable/parameter column name.
valueColumnNameSpecifies the value column name.
pivotedColumnsList of one or more values typically the column names of the input table. All the columns in the source table must have the same data type.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ aggregateUnpivot() [4/4]

AggregateUnpivotResponse& gpudb::GPUdb::aggregateUnpivot ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const std::string &  variableColumnName,
const std::string &  valueColumnName,
const std::vector< std::string > &  pivotedColumns,
const std::map< std::string, std::string > &  options,
AggregateUnpivotResponse response_ 
) const

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
tableNameName of the table on which the operation will be performed. Must be an existing table/view.
columnNamesList of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table.
variableColumnNameSpecifies the variable/parameter column name.
valueColumnNameSpecifies the value column name.
pivotedColumnsList of one or more values typically the column names of the input table. All the columns in the source table must have the same data type.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ aggregateUnpivotRaw() [1/2]

RawAggregateUnpivotResponse gpudb::GPUdb::aggregateUnpivotRaw ( const AggregateUnpivotRequest request_) const

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ aggregateUnpivotRaw() [2/2]

RawAggregateUnpivotResponse& gpudb::GPUdb::aggregateUnpivotRaw ( const AggregateUnpivotRequest request_,
RawAggregateUnpivotResponse response_ 
) const

Rotate the column values into rows values.

For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.

Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterSystemProperties() [1/4]

AlterSystemPropertiesResponse gpudb::GPUdb::alterSystemProperties ( const AlterSystemPropertiesRequest request_) const

The alterSystemProperties(const AlterSystemPropertiesRequest&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ alterSystemProperties() [2/4]

AlterSystemPropertiesResponse& gpudb::GPUdb::alterSystemProperties ( const AlterSystemPropertiesRequest request_,
AlterSystemPropertiesResponse response_ 
) const

The alterSystemProperties(const AlterSystemPropertiesRequest&,AlterSystemPropertiesResponse&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterSystemProperties() [3/4]

AlterSystemPropertiesResponse gpudb::GPUdb::alterSystemProperties ( const std::map< std::string, std::string > &  propertyUpdatesMap,
const std::map< std::string, std::string > &  options 
) const

The alterSystemProperties(const std::map<std::string, std::string>&,const std::map<std::string, std::string>&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Parameters
propertyUpdatesMapMap containing the properties of the system to be updated. Error if empty.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ alterSystemProperties() [4/4]

AlterSystemPropertiesResponse& gpudb::GPUdb::alterSystemProperties ( const std::map< std::string, std::string > &  propertyUpdatesMap,
const std::map< std::string, std::string > &  options,
AlterSystemPropertiesResponse response_ 
) const

The alterSystemProperties(const std::map<std::string, std::string>&,const std::map<std::string, std::string>&,AlterSystemPropertiesResponse&) const endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Parameters
propertyUpdatesMapMap containing the properties of the system to be updated. Error if empty.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterTable() [1/4]

AlterTableResponse gpudb::GPUdb::alterTable ( const AlterTableRequest request_) const

Apply various modifications to a table, view, or collection.

The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.

Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.

Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.

Allow homogeneous tables within a collection.

Manage a table's columns–a column can be added, removed, or have its type and properties modified.

Set or unset compression for a column.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ alterTable() [2/4]

AlterTableResponse& gpudb::GPUdb::alterTable ( const AlterTableRequest request_,
AlterTableResponse response_ 
) const

Apply various modifications to a table, view, or collection.

The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.

Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.

Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.

Allow homogeneous tables within a collection.

Manage a table's columns–a column can be added, removed, or have its type and properties modified.

Set or unset compression for a column.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterTable() [3/4]

AlterTableResponse gpudb::GPUdb::alterTable ( const std::string &  tableName,
const std::string &  action,
const std::string &  value,
const std::map< std::string, std::string > &  options 
) const

Apply various modifications to a table, view, or collection.

The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.

Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.

Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.

Allow homogeneous tables within a collection.

Manage a table's columns–a column can be added, removed, or have its type and properties modified.

Set or unset compression for a column.

Parameters
tableNameTable on which the operation will be performed. Must be an existing table, view, or collection.
actionModification operation to be applied
valueThe value of the modification. May be a column name, 'true' or 'false', a TTL, or the global access mode depending on action.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ alterTable() [4/4]

AlterTableResponse& gpudb::GPUdb::alterTable ( const std::string &  tableName,
const std::string &  action,
const std::string &  value,
const std::map< std::string, std::string > &  options,
AlterTableResponse response_ 
) const

Apply various modifications to a table, view, or collection.

The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.

Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.

Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.

Allow homogeneous tables within a collection.

Manage a table's columns–a column can be added, removed, or have its type and properties modified.

Set or unset compression for a column.

Parameters
tableNameTable on which the operation will be performed. Must be an existing table, view, or collection.
actionModification operation to be applied
valueThe value of the modification. May be a column name, 'true' or 'false', a TTL, or the global access mode depending on action.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterTableMetadata() [1/4]

AlterTableMetadataResponse gpudb::GPUdb::alterTableMetadata ( const AlterTableMetadataRequest request_) const

Updates (adds or changes) metadata for tables.

The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ alterTableMetadata() [2/4]

AlterTableMetadataResponse& gpudb::GPUdb::alterTableMetadata ( const AlterTableMetadataRequest request_,
AlterTableMetadataResponse response_ 
) const

Updates (adds or changes) metadata for tables.

The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterTableMetadata() [3/4]

AlterTableMetadataResponse gpudb::GPUdb::alterTableMetadata ( const std::vector< std::string > &  tableNames,
const std::map< std::string, std::string > &  metadataMap,
const std::map< std::string, std::string > &  options 
) const

Updates (adds or changes) metadata for tables.

The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

Parameters
tableNamesNames of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned.
metadataMapA map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ alterTableMetadata() [4/4]

AlterTableMetadataResponse& gpudb::GPUdb::alterTableMetadata ( const std::vector< std::string > &  tableNames,
const std::map< std::string, std::string > &  metadataMap,
const std::map< std::string, std::string > &  options,
AlterTableMetadataResponse response_ 
) const

Updates (adds or changes) metadata for tables.

The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

Parameters
tableNamesNames of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned.
metadataMapA map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterUser() [1/4]

AlterUserResponse gpudb::GPUdb::alterUser ( const AlterUserRequest request_) const

Alters a user.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ alterUser() [2/4]

AlterUserResponse& gpudb::GPUdb::alterUser ( const AlterUserRequest request_,
AlterUserResponse response_ 
) const

Alters a user.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ alterUser() [3/4]

AlterUserResponse gpudb::GPUdb::alterUser ( const std::string &  name,
const std::string &  action,
const std::string &  value,
const std::map< std::string, std::string > &  options 
) const

Alters a user.

Parameters
nameName of the user to be altered. Must be an existing user.
actionModification operation to be applied to the user.
valueThe value of the modification, depending on action.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ alterUser() [4/4]

AlterUserResponse& gpudb::GPUdb::alterUser ( const std::string &  name,
const std::string &  action,
const std::string &  value,
const std::map< std::string, std::string > &  options,
AlterUserResponse response_ 
) const

Alters a user.

Parameters
nameName of the user to be altered. Must be an existing user.
actionModification operation to be applied to the user.
valueThe value of the modification, depending on action.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ appendRecords() [1/4]

AppendRecordsResponse gpudb::GPUdb::appendRecords ( const AppendRecordsRequest request_) const

Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).

The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ appendRecords() [2/4]

AppendRecordsResponse& gpudb::GPUdb::appendRecords ( const AppendRecordsRequest request_,
AppendRecordsResponse response_ 
) const

Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).

The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ appendRecords() [3/4]

AppendRecordsResponse gpudb::GPUdb::appendRecords ( const std::string &  tableName,
const std::string &  sourceTableName,
const std::map< std::string, std::string > &  fieldMap,
const std::map< std::string, std::string > &  options 
) const

Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).

The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.

Parameters
tableNameThe table name for the records to be appended. Must be an existing table.
sourceTableNameThe source table name to get records from. Must be an existing table name.
fieldMapContains the mapping of column names from the target table (specified by tableName) as the keys, and corresponding column names or expressions (e.g., 'col_name+1') from the source table (specified by sourceTableName). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
optionsOptional parameters.
  • gpudb::append_records_offset: A positive integer indicating the number of initial results to skip from source table (specified by sourceTableName). Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.
  • gpudb::append_records_limit: A positive integer indicating the maximum number of results to be returned from source table (specified by sourceTableName). Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
  • gpudb::append_records_expression: Optional filter expression to apply to the source table (specified by sourceTableName). Empty by default. The default value is ''.
  • gpudb::append_records_order_by: Comma-separated list of the columns and expressions to be sorted by from the source table (specified by sourceTableName); e.g. 'timestamp asc, x desc'. The order_by columns do not have to be present in fieldMap. The default value is ''.
  • gpudb::append_records_update_on_existing_pk: Specifies the record collision policy for inserting the source table records (specified by sourceTableName) into the target table (specified by tableName) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. The default value is gpudb::append_records_false.
  • gpudb::append_records_truncate_strings: If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. The default value is gpudb::append_records_false.
Returns
Response object containing the result of the operation.

◆ appendRecords() [4/4]

AppendRecordsResponse& gpudb::GPUdb::appendRecords ( const std::string &  tableName,
const std::string &  sourceTableName,
const std::map< std::string, std::string > &  fieldMap,
const std::map< std::string, std::string > &  options,
AppendRecordsResponse response_ 
) const

Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).

The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.

Parameters
tableNameThe table name for the records to be appended. Must be an existing table.
sourceTableNameThe source table name to get records from. Must be an existing table name.
fieldMapContains the mapping of column names from the target table (specified by tableName) as the keys, and corresponding column names or expressions (e.g., 'col_name+1') from the source table (specified by sourceTableName). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
optionsOptional parameters.
  • gpudb::append_records_offset: A positive integer indicating the number of initial results to skip from source table (specified by sourceTableName). Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.
  • gpudb::append_records_limit: A positive integer indicating the maximum number of results to be returned from source table (specified by sourceTableName). Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
  • gpudb::append_records_expression: Optional filter expression to apply to the source table (specified by sourceTableName). Empty by default. The default value is ''.
  • gpudb::append_records_order_by: Comma-separated list of the columns and expressions to be sorted by from the source table (specified by sourceTableName); e.g. 'timestamp asc, x desc'. The order_by columns do not have to be present in fieldMap. The default value is ''.
  • gpudb::append_records_update_on_existing_pk: Specifies the record collision policy for inserting the source table records (specified by sourceTableName) into the target table (specified by tableName) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. The default value is gpudb::append_records_false.
  • gpudb::append_records_truncate_strings: If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. The default value is gpudb::append_records_false.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ clearTable() [1/4]

ClearTableResponse gpudb::GPUdb::clearTable ( const ClearTableRequest request_) const

Clears (drops) one or all tables in the database cluster.

The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ clearTable() [2/4]

ClearTableResponse& gpudb::GPUdb::clearTable ( const ClearTableRequest request_,
ClearTableResponse response_ 
) const

Clears (drops) one or all tables in the database cluster.

The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ clearTable() [3/4]

ClearTableResponse gpudb::GPUdb::clearTable ( const std::string &  tableName,
const std::string &  authorization,
const std::map< std::string, std::string > &  options 
) const

Clears (drops) one or all tables in the database cluster.

The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.

Parameters
tableNameName of the table to be cleared. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'.
authorizationNo longer used. User can pass an empty string.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ clearTable() [4/4]

ClearTableResponse& gpudb::GPUdb::clearTable ( const std::string &  tableName,
const std::string &  authorization,
const std::map< std::string, std::string > &  options,
ClearTableResponse response_ 
) const

Clears (drops) one or all tables in the database cluster.

The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.

Parameters
tableNameName of the table to be cleared. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'.
authorizationNo longer used. User can pass an empty string.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ clearTableMonitor() [1/4]

ClearTableMonitorResponse gpudb::GPUdb::clearTableMonitor ( const ClearTableMonitorRequest request_) const

Deactivates a table monitor previously created with createTableMonitor(const CreateTableMonitorRequest&) const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ clearTableMonitor() [2/4]

ClearTableMonitorResponse& gpudb::GPUdb::clearTableMonitor ( const ClearTableMonitorRequest request_,
ClearTableMonitorResponse response_ 
) const

Deactivates a table monitor previously created with createTableMonitor(const CreateTableMonitorRequest&,CreateTableMonitorResponse&) const.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ clearTableMonitor() [3/4]

ClearTableMonitorResponse gpudb::GPUdb::clearTableMonitor ( const std::string &  topicId,
const std::map< std::string, std::string > &  options 
) const

Deactivates a table monitor previously created with createTableMonitor(const std::string&,const std::map<std::string, std::string>&) const.

Parameters
topicIdThe topic ID returned by /create/tablemonitor.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ clearTableMonitor() [4/4]

ClearTableMonitorResponse& gpudb::GPUdb::clearTableMonitor ( const std::string &  topicId,
const std::map< std::string, std::string > &  options,
ClearTableMonitorResponse response_ 
) const

Deactivates a table monitor previously created with createTableMonitor(const std::string&,const std::map<std::string, std::string>&,CreateTableMonitorResponse&) const.

Parameters
topicIdThe topic ID returned by /create/tablemonitor.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ clearTrigger() [1/4]

ClearTriggerResponse gpudb::GPUdb::clearTrigger ( const ClearTriggerRequest request_) const

Clears or cancels the trigger identified by the specified handle.

The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ clearTrigger() [2/4]

ClearTriggerResponse& gpudb::GPUdb::clearTrigger ( const ClearTriggerRequest request_,
ClearTriggerResponse response_ 
) const

Clears or cancels the trigger identified by the specified handle.

The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ clearTrigger() [3/4]

ClearTriggerResponse gpudb::GPUdb::clearTrigger ( const std::string &  triggerId,
const std::map< std::string, std::string > &  options 
) const

Clears or cancels the trigger identified by the specified handle.

The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.

Parameters
triggerIdID for the trigger to be deactivated.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ clearTrigger() [4/4]

ClearTriggerResponse& gpudb::GPUdb::clearTrigger ( const std::string &  triggerId,
const std::map< std::string, std::string > &  options,
ClearTriggerResponse response_ 
) const

Clears or cancels the trigger identified by the specified handle.

The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.

Parameters
triggerIdID for the trigger to be deactivated.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createJob() [1/4]

CreateJobResponse gpudb::GPUdb::createJob ( const CreateJobRequest request_) const

Create a job which will run asynchronously.

The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob(const GetJobRequest&) const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createJob() [2/4]

CreateJobResponse& gpudb::GPUdb::createJob ( const CreateJobRequest request_,
CreateJobResponse response_ 
) const

Create a job which will run asynchronously.

The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob(const GetJobRequest&,GetJobResponse&) const.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createJob() [3/4]

CreateJobResponse gpudb::GPUdb::createJob ( const std::string &  endpoint,
const std::string &  requestEncoding,
const std::vector< uint8_t > &  data,
const std::string &  dataStr,
const std::map< std::string, std::string > &  options 
) const

Create a job which will run asynchronously.

The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob(const int32_t,const std::map<std::string, std::string>&) const.

Parameters
endpointIndicates which endpoint to execute, e.g. '/alter/table'.
requestEncodingThe encoding of the request payload for the job. The default value is gpudb::create_job_binary.
dataBinary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be binary or snappy.
dataStrJSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be json.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createJob() [4/4]

CreateJobResponse& gpudb::GPUdb::createJob ( const std::string &  endpoint,
const std::string &  requestEncoding,
const std::vector< uint8_t > &  data,
const std::string &  dataStr,
const std::map< std::string, std::string > &  options,
CreateJobResponse response_ 
) const

Create a job which will run asynchronously.

The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob(const int32_t,const std::map<std::string, std::string>&,GetJobResponse&) const.

Parameters
endpointIndicates which endpoint to execute, e.g. '/alter/table'.
requestEncodingThe encoding of the request payload for the job. The default value is gpudb::create_job_binary.
dataBinary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be binary or snappy.
dataStrJSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be json.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createJoinTable() [1/4]

CreateJoinTableResponse gpudb::GPUdb::createJoinTable ( const CreateJoinTableRequest request_) const

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createJoinTable() [2/4]

CreateJoinTableResponse& gpudb::GPUdb::createJoinTable ( const CreateJoinTableRequest request_,
CreateJoinTableResponse response_ 
) const

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createJoinTable() [3/4]

CreateJoinTableResponse gpudb::GPUdb::createJoinTable ( const std::string &  joinTableName,
const std::vector< std::string > &  tableNames,
const std::vector< std::string > &  columnNames,
const std::vector< std::string > &  expressions,
const std::map< std::string, std::string > &  options 
) const

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Parameters
joinTableNameName of the join table to be created. Has the same naming restrictions as tables.
tableNamesThe list of table names composing the join. Corresponds to a SQL statement FROM clause.
columnNamesList of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.
expressionsAn optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createJoinTable() [4/4]

CreateJoinTableResponse& gpudb::GPUdb::createJoinTable ( const std::string &  joinTableName,
const std::vector< std::string > &  tableNames,
const std::vector< std::string > &  columnNames,
const std::vector< std::string > &  expressions,
const std::map< std::string, std::string > &  options,
CreateJoinTableResponse response_ 
) const

Creates a table that is the result of a SQL JOIN.

For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Parameters
joinTableNameName of the join table to be created. Has the same naming restrictions as tables.
tableNamesThe list of table names composing the join. Corresponds to a SQL statement FROM clause.
columnNamesList of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.
expressionsAn optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createMaterializedView() [1/4]

CreateMaterializedViewResponse gpudb::GPUdb::createMaterializedView ( const CreateMaterializedViewRequest request_) const

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createMaterializedView() [2/4]

CreateMaterializedViewResponse& gpudb::GPUdb::createMaterializedView ( const CreateMaterializedViewRequest request_,
CreateMaterializedViewResponse response_ 
) const

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createMaterializedView() [3/4]

CreateMaterializedViewResponse gpudb::GPUdb::createMaterializedView ( const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Parameters
tableNameName of the table to be created that is the top-level table of the materialized view.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createMaterializedView() [4/4]

CreateMaterializedViewResponse& gpudb::GPUdb::createMaterializedView ( const std::string &  tableName,
const std::map< std::string, std::string > &  options,
CreateMaterializedViewResponse response_ 
) const

Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.

For materialized view details and examples, see Materialized Views.

The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.

Parameters
tableNameName of the table to be created that is the top-level table of the materialized view.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createProc() [1/4]

CreateProcResponse gpudb::GPUdb::createProc ( const CreateProcRequest request_) const

Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.

For details on UDFs, see: User-Defined Functions

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createProc() [2/4]

CreateProcResponse& gpudb::GPUdb::createProc ( const CreateProcRequest request_,
CreateProcResponse response_ 
) const

Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.

For details on UDFs, see: User-Defined Functions

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createProc() [3/4]

CreateProcResponse gpudb::GPUdb::createProc ( const std::string &  procName,
const std::string &  executionMode,
const std::map< std::string, std::vector< uint8_t > > &  files,
const std::string &  command,
const std::vector< std::string > &  args,
const std::map< std::string, std::string > &  options 
) const

Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.

For details on UDFs, see: User-Defined Functions

Parameters
procNameName of the proc to be created. Must not be the name of a currently existing proc.
executionModeThe execution mode of the proc.
  • gpudb::create_proc_distributed: Input table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data.
  • gpudb::create_proc_nondistributed: The proc command will be invoked only once per execution, and will not have access to any input or output table data.
The default value is gpudb::create_proc_distributed.
filesA map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc.
commandThe command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc files and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in files, that file will be invoked.
argsAn array of command-line arguments that will be passed to command when the proc is executed.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createProc() [4/4]

CreateProcResponse& gpudb::GPUdb::createProc ( const std::string &  procName,
const std::string &  executionMode,
const std::map< std::string, std::vector< uint8_t > > &  files,
const std::string &  command,
const std::vector< std::string > &  args,
const std::map< std::string, std::string > &  options,
CreateProcResponse response_ 
) const

Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.

For details on UDFs, see: User-Defined Functions

Parameters
procNameName of the proc to be created. Must not be the name of a currently existing proc.
executionModeThe execution mode of the proc.
  • gpudb::create_proc_distributed: Input table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data.
  • gpudb::create_proc_nondistributed: The proc command will be invoked only once per execution, and will not have access to any input or output table data.
The default value is gpudb::create_proc_distributed.
filesA map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc.
commandThe command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc files and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in files, that file will be invoked.
argsAn array of command-line arguments that will be passed to command when the proc is executed.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createProjection() [1/4]

CreateProjectionResponse gpudb::GPUdb::createProjection ( const CreateProjectionRequest request_) const

Creates a new projection of an existing table.

A projection represents a subset of the columns (potentially including derived columns) of a table.

For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumnRaw(const GetRecordsByColumnRequest&) const.

A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createProjection() [2/4]

CreateProjectionResponse& gpudb::GPUdb::createProjection ( const CreateProjectionRequest request_,
CreateProjectionResponse response_ 
) const

Creates a new projection of an existing table.

A projection represents a subset of the columns (potentially including derived columns) of a table.

For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumnRaw(const GetRecordsByColumnRequest&,RawGetRecordsByColumnResponse&) const.

A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createProjection() [3/4]

CreateProjectionResponse gpudb::GPUdb::createProjection ( const std::string &  tableName,
const std::string &  projectionName,
const std::vector< std::string > &  columnNames,
const std::map< std::string, std::string > &  options 
) const

Creates a new projection of an existing table.

A projection represents a subset of the columns (potentially including derived columns) of a table.

For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumnRaw(const GetRecordsByColumnRequest&) const.

A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.

Parameters
tableNameName of the existing table on which the projection is to be applied.
projectionNameName of the projection to be created. Has the same naming restrictions as tables.
columnNamesList of columns from tableName to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column_name as alias'.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createProjection() [4/4]

CreateProjectionResponse& gpudb::GPUdb::createProjection ( const std::string &  tableName,
const std::string &  projectionName,
const std::vector< std::string > &  columnNames,
const std::map< std::string, std::string > &  options,
CreateProjectionResponse response_ 
) const

Creates a new projection of an existing table.

A projection represents a subset of the columns (potentially including derived columns) of a table.

For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumnRaw(const GetRecordsByColumnRequest&) const.

A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.

Parameters
tableNameName of the existing table on which the projection is to be applied.
projectionNameName of the projection to be created. Has the same naming restrictions as tables.
columnNamesList of columns from tableName to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column_name as alias'.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createRole() [1/4]

CreateRoleResponse gpudb::GPUdb::createRole ( const CreateRoleRequest request_) const

Creates a new role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createRole() [2/4]

CreateRoleResponse& gpudb::GPUdb::createRole ( const CreateRoleRequest request_,
CreateRoleResponse response_ 
) const

Creates a new role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createRole() [3/4]

CreateRoleResponse gpudb::GPUdb::createRole ( const std::string &  name,
const std::map< std::string, std::string > &  options 
) const

Creates a new role.

Parameters
nameName of the role to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createRole() [4/4]

CreateRoleResponse& gpudb::GPUdb::createRole ( const std::string &  name,
const std::map< std::string, std::string > &  options,
CreateRoleResponse response_ 
) const

Creates a new role.

Parameters
nameName of the role to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTable() [1/4]

CreateTableResponse gpudb::GPUdb::createTable ( const CreateTableRequest request_) const

Creates a new table or collection.

If a new table is being created, the type of the table is given by typeId, which must the be the ID of a currently registered type (i.e. one created via createType(const CreateTypeRequest&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.

To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createTable() [2/4]

CreateTableResponse& gpudb::GPUdb::createTable ( const CreateTableRequest request_,
CreateTableResponse response_ 
) const

Creates a new table or collection.

If a new table is being created, the type of the table is given by typeId, which must the be the ID of a currently registered type (i.e. one created via createType(const CreateTypeRequest&,CreateTypeResponse&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.

To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTable() [3/4]

CreateTableResponse gpudb::GPUdb::createTable ( const std::string &  tableName,
const std::string &  typeId,
const std::map< std::string, std::string > &  options 
) const

Creates a new table or collection.

If a new table is being created, the type of the table is given by typeId, which must the be the ID of a currently registered type (i.e. one created via createType(const std::string&,const std::string&,const std::map<std::string, std::vector<std::string> >&,const std::map<std::string, std::string>&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.

To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.

Parameters
tableNameName of the table to be created. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions.
typeIdID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createTable() [4/4]

CreateTableResponse& gpudb::GPUdb::createTable ( const std::string &  tableName,
const std::string &  typeId,
const std::map< std::string, std::string > &  options,
CreateTableResponse response_ 
) const

Creates a new table or collection.

If a new table is being created, the type of the table is given by typeId, which must the be the ID of a currently registered type (i.e. one created via createType(const std::string&,const std::string&,const std::map<std::string, std::vector<std::string> >&,const std::map<std::string, std::string>&,CreateTypeResponse&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist, it will be created.

To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.

Parameters
tableNameName of the table to be created. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions.
typeIdID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTableMonitor() [1/4]

CreateTableMonitorResponse gpudb::GPUdb::createTableMonitor ( const CreateTableMonitorRequest request_) const

Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor(const ClearTableMonitorRequest&) const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createTableMonitor() [2/4]

CreateTableMonitorResponse& gpudb::GPUdb::createTableMonitor ( const CreateTableMonitorRequest request_,
CreateTableMonitorResponse response_ 
) const

Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor(const ClearTableMonitorRequest&,ClearTableMonitorResponse&) const.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTableMonitor() [3/4]

CreateTableMonitorResponse gpudb::GPUdb::createTableMonitor ( const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor(const std::string&,const std::map<std::string, std::string>&) const.

Parameters
tableNameName of the table to monitor. Must not refer to a collection.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createTableMonitor() [4/4]

CreateTableMonitorResponse& gpudb::GPUdb::createTableMonitor ( const std::string &  tableName,
const std::map< std::string, std::string > &  options,
CreateTableMonitorResponse response_ 
) const

Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor(const std::string&,const std::map<std::string, std::string>&,ClearTableMonitorResponse&) const.

Parameters
tableNameName of the table to monitor. Must not refer to a collection.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTriggerByArea() [1/4]

CreateTriggerByAreaResponse gpudb::GPUdb::createTriggerByArea ( const CreateTriggerByAreaRequest request_) const

Sets up an area trigger mechanism for two column_names for one or more tables.

(This function is essentially the two-dimensional version of createTriggerByRange(const CreateTriggerByRangeRequest&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const ShowSystemStatusRequest&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createTriggerByArea() [2/4]

CreateTriggerByAreaResponse& gpudb::GPUdb::createTriggerByArea ( const CreateTriggerByAreaRequest request_,
CreateTriggerByAreaResponse response_ 
) const

Sets up an area trigger mechanism for two column_names for one or more tables.

(This function is essentially the two-dimensional version of createTriggerByRange(const CreateTriggerByRangeRequest&,CreateTriggerByRangeResponse&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&,InsertRecordsResponse&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const ShowSystemStatusRequest&,ShowSystemStatusResponse&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&,ClearTriggerResponse&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTriggerByArea() [3/4]

CreateTriggerByAreaResponse gpudb::GPUdb::createTriggerByArea ( const std::string &  requestId,
const std::vector< std::string > &  tableNames,
const std::string &  xColumnName,
const std::vector< double > &  xVector,
const std::string &  yColumnName,
const std::vector< double > &  yVector,
const std::map< std::string, std::string > &  options 
) const

Sets up an area trigger mechanism for two column_names for one or more tables.

(This function is essentially the two-dimensional version of createTriggerByRange(const std::string&,const std::vector<std::string>&,const std::string&,const double,const double,const std::map<std::string, std::string>&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const std::map<std::string, std::string>&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const std::string&,const std::map<std::string, std::string>&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
requestIdUser-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
tableNamesNames of the tables on which the trigger will be activated and maintained.
xColumnNameName of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
xVectorThe respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
yColumnNameName of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
yVectorThe respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createTriggerByArea() [4/4]

CreateTriggerByAreaResponse& gpudb::GPUdb::createTriggerByArea ( const std::string &  requestId,
const std::vector< std::string > &  tableNames,
const std::string &  xColumnName,
const std::vector< double > &  xVector,
const std::string &  yColumnName,
const std::vector< double > &  yVector,
const std::map< std::string, std::string > &  options,
CreateTriggerByAreaResponse response_ 
) const

Sets up an area trigger mechanism for two column_names for one or more tables.

(This function is essentially the two-dimensional version of createTriggerByRange(const std::string&,const std::vector<std::string>&,const std::string&,const double,const double,const std::map<std::string, std::string>&,CreateTriggerByRangeResponse&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const std::map<std::string, std::string>&,ShowSystemStatusResponse&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const std::string&,const std::map<std::string, std::string>&,ClearTriggerResponse&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
requestIdUser-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
tableNamesNames of the tables on which the trigger will be activated and maintained.
xColumnNameName of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
xVectorThe respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
yColumnNameName of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
yVectorThe respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTriggerByRange() [1/4]

CreateTriggerByRangeResponse gpudb::GPUdb::createTriggerByRange ( const CreateTriggerByRangeRequest request_) const

Sets up a simple range trigger for a column_name for one or more tables.

Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const ShowSystemStatusRequest&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createTriggerByRange() [2/4]

CreateTriggerByRangeResponse& gpudb::GPUdb::createTriggerByRange ( const CreateTriggerByRangeRequest request_,
CreateTriggerByRangeResponse response_ 
) const

Sets up a simple range trigger for a column_name for one or more tables.

Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&,InsertRecordsResponse&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const ShowSystemStatusRequest&,ShowSystemStatusResponse&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&,ClearTriggerResponse&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createTriggerByRange() [3/4]

CreateTriggerByRangeResponse gpudb::GPUdb::createTriggerByRange ( const std::string &  requestId,
const std::vector< std::string > &  tableNames,
const std::string &  columnName,
const double  min,
const double  max,
const std::map< std::string, std::string > &  options 
) const

Sets up a simple range trigger for a column_name for one or more tables.

Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const std::map<std::string, std::string>&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const std::string&,const std::map<std::string, std::string>&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
requestIdUser-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
tableNamesTables on which the trigger will be active.
columnNameName of a numeric column_name on which the trigger is activated.
minThe lower bound (inclusive) for the trigger range.
maxThe upper bound (inclusive) for the trigger range.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createTriggerByRange() [4/4]

CreateTriggerByRangeResponse& gpudb::GPUdb::createTriggerByRange ( const std::string &  requestId,
const std::vector< std::string > &  tableNames,
const std::string &  columnName,
const double  min,
const double  max,
const std::map< std::string, std::string > &  options,
CreateTriggerByRangeResponse response_ 
) const

Sets up a simple range trigger for a column_name for one or more tables.

Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus(const std::map<std::string, std::string>&,ShowSystemStatusResponse&) const) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const std::string&,const std::map<std::string, std::string>&,ClearTriggerResponse&) const endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Parameters
requestIdUser-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
tableNamesTables on which the trigger will be active.
columnNameName of a numeric column_name on which the trigger is activated.
minThe lower bound (inclusive) for the trigger range.
maxThe upper bound (inclusive) for the trigger range.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createType() [1/4]

CreateTypeResponse gpudb::GPUdb::createType ( const CreateTypeRequest request_) const

Creates a new type describing the layout or schema of a table.

The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.

A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

Example of a type definition with some of the parameters::

{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }

Properties::

{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createType() [2/4]

CreateTypeResponse& gpudb::GPUdb::createType ( const CreateTypeRequest request_,
CreateTypeResponse response_ 
) const

Creates a new type describing the layout or schema of a table.

The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.

A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

Example of a type definition with some of the parameters::

{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }

Properties::

{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createType() [3/4]

CreateTypeResponse gpudb::GPUdb::createType ( const std::string &  typeDefinition,
const std::string &  label,
const std::map< std::string, std::vector< std::string > > &  properties,
const std::map< std::string, std::string > &  options 
) const

Creates a new type describing the layout or schema of a table.

The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.

A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

Example of a type definition with some of the parameters::

{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }

Properties::

{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Parameters
typeDefinitiona JSON string describing the columns of the type to be registered.
labelA user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
propertiesEach key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type).
  • gpudb::create_type_data: Default property for all numeric and string type columns; makes the column available for GPU queries.
  • gpudb::create_type_text_search: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of data and store_only.
  • gpudb::create_type_store_only: Persist the column value but do not make it available to queries (e.g. /filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage.
  • gpudb::create_type_disk_optimized: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like /filter, /filter/bylist, and /filter/byvalue work as usual but /aggregate/unique, /aggregate/groupby and /get/records/bycolumn are not allowed on columns with this property.
  • gpudb::create_type_timestamp: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900.
  • gpudb::create_type_decimal: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property.
  • gpudb::create_type_date: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property.
  • gpudb::create_type_time: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property.
  • gpudb::create_type_datetime: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property.
  • gpudb::create_type_char1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character.
  • gpudb::create_type_char2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
  • gpudb::create_type_char4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
  • gpudb::create_type_char8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
  • gpudb::create_type_char16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
  • gpudb::create_type_char32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
  • gpudb::create_type_char64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
  • gpudb::create_type_char128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
  • gpudb::create_type_char256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
  • gpudb::create_type_int8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
  • gpudb::create_type_int16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
  • gpudb::create_type_ipv4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255.
  • gpudb::create_type_wkt: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format.
  • gpudb::create_type_primary_key: This property indicates that this column will be part of (or the entire) primary key.
  • gpudb::create_type_shard_key: This property indicates that this column will be part of (or the entire) shard key.
  • gpudb::create_type_nullable: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in typeDefinition. For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record.
  • gpudb::create_type_dict: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with string columns marked with a charN or date property or with int or long columns. This property is appropriate for columns where the cardinality (the number of unique values) is expected to be low, and can save a large amount of memory.
  • gpudb::create_type_init_with_now: For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createType() [4/4]

CreateTypeResponse& gpudb::GPUdb::createType ( const std::string &  typeDefinition,
const std::string &  label,
const std::map< std::string, std::vector< std::string > > &  properties,
const std::map< std::string, std::string > &  options,
CreateTypeResponse response_ 
) const

Creates a new type describing the layout or schema of a table.

The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive–i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.

A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

Example of a type definition with some of the parameters::

{"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }

Properties::

{"group_id":["store_only"], "msg_id":["store_only","text_search"] }

Parameters
typeDefinitiona JSON string describing the columns of the type to be registered.
labelA user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
propertiesEach key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type).
  • gpudb::create_type_data: Default property for all numeric and string type columns; makes the column available for GPU queries.
  • gpudb::create_type_text_search: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of data and store_only.
  • gpudb::create_type_store_only: Persist the column value but do not make it available to queries (e.g. /filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage.
  • gpudb::create_type_disk_optimized: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like /filter, /filter/bylist, and /filter/byvalue work as usual but /aggregate/unique, /aggregate/groupby and /get/records/bycolumn are not allowed on columns with this property.
  • gpudb::create_type_timestamp: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900.
  • gpudb::create_type_decimal: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property.
  • gpudb::create_type_date: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property.
  • gpudb::create_type_time: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property.
  • gpudb::create_type_datetime: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property.
  • gpudb::create_type_char1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character.
  • gpudb::create_type_char2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
  • gpudb::create_type_char4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
  • gpudb::create_type_char8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
  • gpudb::create_type_char16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
  • gpudb::create_type_char32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
  • gpudb::create_type_char64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
  • gpudb::create_type_char128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
  • gpudb::create_type_char256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
  • gpudb::create_type_int8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
  • gpudb::create_type_int16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
  • gpudb::create_type_ipv4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255.
  • gpudb::create_type_wkt: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format.
  • gpudb::create_type_primary_key: This property indicates that this column will be part of (or the entire) primary key.
  • gpudb::create_type_shard_key: This property indicates that this column will be part of (or the entire) shard key.
  • gpudb::create_type_nullable: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in typeDefinition. For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record.
  • gpudb::create_type_dict: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with string columns marked with a charN or date property or with int or long columns. This property is appropriate for columns where the cardinality (the number of unique values) is expected to be low, and can save a large amount of memory.
  • gpudb::create_type_init_with_now: For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createUnion() [1/4]

CreateUnionResponse gpudb::GPUdb::createUnion ( const CreateUnionRequest request_) const

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.

Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createUnion() [2/4]

CreateUnionResponse& gpudb::GPUdb::createUnion ( const CreateUnionRequest request_,
CreateUnionResponse response_ 
) const

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.

Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createUnion() [3/4]

CreateUnionResponse gpudb::GPUdb::createUnion ( const std::string &  tableName,
const std::vector< std::string > &  tableNames,
const std::vector< std::vector< std::string > > &  inputColumnNames,
const std::vector< std::string > &  outputColumnNames,
const std::map< std::string, std::string > &  options 
) const

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.

Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.

Parameters
tableNameName of the table to be created. Has the same naming restrictions as tables.
tableNamesThe list of table names to merge. Must contain the names of one or more existing tables.
inputColumnNamesThe list of columns from each of the corresponding input tables.
outputColumnNamesThe list of names of the columns to be stored in the output table.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createUnion() [4/4]

CreateUnionResponse& gpudb::GPUdb::createUnion ( const std::string &  tableName,
const std::vector< std::string > &  tableNames,
const std::vector< std::vector< std::string > > &  inputColumnNames,
const std::vector< std::string > &  outputColumnNames,
const std::map< std::string, std::string > &  options,
CreateUnionResponse response_ 
) const

Merges data from one or more tables with comparable data types into a new table.

The following merges are supported:

UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.

INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.

EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.

MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.

Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.

Parameters
tableNameName of the table to be created. Has the same naming restrictions as tables.
tableNamesThe list of table names to merge. Must contain the names of one or more existing tables.
inputColumnNamesThe list of columns from each of the corresponding input tables.
outputColumnNamesThe list of names of the columns to be stored in the output table.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createUserExternal() [1/4]

CreateUserExternalResponse gpudb::GPUdb::createUserExternal ( const CreateUserExternalRequest request_) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createUserExternal() [2/4]

CreateUserExternalResponse& gpudb::GPUdb::createUserExternal ( const CreateUserExternalRequest request_,
CreateUserExternalResponse response_ 
) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createUserExternal() [3/4]

CreateUserExternalResponse gpudb::GPUdb::createUserExternal ( const std::string &  name,
const std::map< std::string, std::string > &  options 
) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Parameters
nameName of the user to be created. Must exactly match the user's name in the external LDAP, prefixed with a . Must not be the same name as an existing user.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createUserExternal() [4/4]

CreateUserExternalResponse& gpudb::GPUdb::createUserExternal ( const std::string &  name,
const std::map< std::string, std::string > &  options,
CreateUserExternalResponse response_ 
) const

Creates a new external user (a user whose credentials are managed by an external LDAP).

Parameters
nameName of the user to be created. Must exactly match the user's name in the external LDAP, prefixed with a . Must not be the same name as an existing user.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createUserInternal() [1/4]

CreateUserInternalResponse gpudb::GPUdb::createUserInternal ( const CreateUserInternalRequest request_) const

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ createUserInternal() [2/4]

CreateUserInternalResponse& gpudb::GPUdb::createUserInternal ( const CreateUserInternalRequest request_,
CreateUserInternalResponse response_ 
) const

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ createUserInternal() [3/4]

CreateUserInternalResponse gpudb::GPUdb::createUserInternal ( const std::string &  name,
const std::string &  password,
const std::map< std::string, std::string > &  options 
) const

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters
nameName of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
passwordInitial password of the user to be created. May be an empty string for no password.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ createUserInternal() [4/4]

CreateUserInternalResponse& gpudb::GPUdb::createUserInternal ( const std::string &  name,
const std::string &  password,
const std::map< std::string, std::string > &  options,
CreateUserInternalResponse response_ 
) const

Creates a new internal user (a user whose credentials are managed by the database system).

Parameters
nameName of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
passwordInitial password of the user to be created. May be an empty string for no password.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteProc() [1/4]

DeleteProcResponse gpudb::GPUdb::deleteProc ( const DeleteProcRequest request_) const

Deletes a proc.

Any currently running instances of the proc will be killed.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ deleteProc() [2/4]

DeleteProcResponse& gpudb::GPUdb::deleteProc ( const DeleteProcRequest request_,
DeleteProcResponse response_ 
) const

Deletes a proc.

Any currently running instances of the proc will be killed.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteProc() [3/4]

DeleteProcResponse gpudb::GPUdb::deleteProc ( const std::string &  procName,
const std::map< std::string, std::string > &  options 
) const

Deletes a proc.

Any currently running instances of the proc will be killed.

Parameters
procNameName of the proc to be deleted. Must be the name of a currently existing proc.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ deleteProc() [4/4]

DeleteProcResponse& gpudb::GPUdb::deleteProc ( const std::string &  procName,
const std::map< std::string, std::string > &  options,
DeleteProcResponse response_ 
) const

Deletes a proc.

Any currently running instances of the proc will be killed.

Parameters
procNameName of the proc to be deleted. Must be the name of a currently existing proc.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteRecords() [1/4]

DeleteRecordsResponse gpudb::GPUdb::deleteRecords ( const DeleteRecordsRequest request_) const

Deletes record(s) matching the provided criteria from the given table.

The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ deleteRecords() [2/4]

DeleteRecordsResponse& gpudb::GPUdb::deleteRecords ( const DeleteRecordsRequest request_,
DeleteRecordsResponse response_ 
) const

Deletes record(s) matching the provided criteria from the given table.

The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteRecords() [3/4]

DeleteRecordsResponse gpudb::GPUdb::deleteRecords ( const std::string &  tableName,
const std::vector< std::string > &  expressions,
const std::map< std::string, std::string > &  options 
) const

Deletes record(s) matching the provided criteria from the given table.

The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Parameters
tableNameName of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
expressionsA list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions is mutually exclusive to specifying record_id in the options.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ deleteRecords() [4/4]

DeleteRecordsResponse& gpudb::GPUdb::deleteRecords ( const std::string &  tableName,
const std::vector< std::string > &  expressions,
const std::map< std::string, std::string > &  options,
DeleteRecordsResponse response_ 
) const

Deletes record(s) matching the provided criteria from the given table.

The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.

Parameters
tableNameName of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
expressionsA list of the actual predicates, one for each select; format should follow the guidelines provided here. Specifying one or more expressions is mutually exclusive to specifying record_id in the options.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteRole() [1/4]

DeleteRoleResponse gpudb::GPUdb::deleteRole ( const DeleteRoleRequest request_) const

Deletes an existing role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ deleteRole() [2/4]

DeleteRoleResponse& gpudb::GPUdb::deleteRole ( const DeleteRoleRequest request_,
DeleteRoleResponse response_ 
) const

Deletes an existing role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteRole() [3/4]

DeleteRoleResponse gpudb::GPUdb::deleteRole ( const std::string &  name,
const std::map< std::string, std::string > &  options 
) const

Deletes an existing role.

Parameters
nameName of the role to be deleted. Must be an existing role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ deleteRole() [4/4]

DeleteRoleResponse& gpudb::GPUdb::deleteRole ( const std::string &  name,
const std::map< std::string, std::string > &  options,
DeleteRoleResponse response_ 
) const

Deletes an existing role.

Parameters
nameName of the role to be deleted. Must be an existing role.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteUser() [1/4]

DeleteUserResponse gpudb::GPUdb::deleteUser ( const DeleteUserRequest request_) const

Deletes an existing user.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ deleteUser() [2/4]

DeleteUserResponse& gpudb::GPUdb::deleteUser ( const DeleteUserRequest request_,
DeleteUserResponse response_ 
) const

Deletes an existing user.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ deleteUser() [3/4]

DeleteUserResponse gpudb::GPUdb::deleteUser ( const std::string &  name,
const std::map< std::string, std::string > &  options 
) const

Deletes an existing user.

Parameters
nameName of the user to be deleted. Must be an existing user.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ deleteUser() [4/4]

DeleteUserResponse& gpudb::GPUdb::deleteUser ( const std::string &  name,
const std::map< std::string, std::string > &  options,
DeleteUserResponse response_ 
) const

Deletes an existing user.

Parameters
nameName of the user to be deleted. Must be an existing user.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ executeProc() [1/4]

ExecuteProcResponse gpudb::GPUdb::executeProc ( const ExecuteProcRequest request_) const

Executes a proc.

This endpoint is asynchronous and does not wait for the proc to complete before returning.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ executeProc() [2/4]

ExecuteProcResponse& gpudb::GPUdb::executeProc ( const ExecuteProcRequest request_,
ExecuteProcResponse response_ 
) const

Executes a proc.

This endpoint is asynchronous and does not wait for the proc to complete before returning.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ executeProc() [3/4]

ExecuteProcResponse gpudb::GPUdb::executeProc ( const std::string &  procName,
const std::map< std::string, std::string > &  params,
const std::map< std::string, std::vector< uint8_t > > &  binParams,
const std::vector< std::string > &  inputTableNames,
const std::map< std::string, std::vector< std::string > > &  inputColumnNames,
const std::vector< std::string > &  outputTableNames,
const std::map< std::string, std::string > &  options 
) const

Executes a proc.

This endpoint is asynchronous and does not wait for the proc to complete before returning.

Parameters
procNameName of the proc to execute. Must be the name of a currently existing proc.
paramsA map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
binParamsA map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
inputTableNamesNames of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table. If no table names are specified, no data will be passed to the proc.
inputColumnNamesMap of table names from inputTableNames to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from inputTableNames is not included, all columns from that table will be passed to the proc.
outputTableNamesNames of the tables to which output data from the proc will be written. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from inputTableNames, excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc.
optionsOptional parameters.
  • gpudb::execute_proc_cache_input: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to /execute/proc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the /show/proc/status option of /show/proc/status and all proc instances using the cached data have completed. The default value is ''.
  • gpudb::execute_proc_use_cached_input: A comma-delimited list of run IDs (as returned from prior calls to /execute/proc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in inputTableNames, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.
  • gpudb::execute_proc_kifs_input_dirs: A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. (All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''.
Returns
Response object containing the result of the operation.

◆ executeProc() [4/4]

ExecuteProcResponse& gpudb::GPUdb::executeProc ( const std::string &  procName,
const std::map< std::string, std::string > &  params,
const std::map< std::string, std::vector< uint8_t > > &  binParams,
const std::vector< std::string > &  inputTableNames,
const std::map< std::string, std::vector< std::string > > &  inputColumnNames,
const std::vector< std::string > &  outputTableNames,
const std::map< std::string, std::string > &  options,
ExecuteProcResponse response_ 
) const

Executes a proc.

This endpoint is asynchronous and does not wait for the proc to complete before returning.

Parameters
procNameName of the proc to execute. Must be the name of a currently existing proc.
paramsA map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
binParamsA map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
inputTableNamesNames of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table. If no table names are specified, no data will be passed to the proc.
inputColumnNamesMap of table names from inputTableNames to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from inputTableNames is not included, all columns from that table will be passed to the proc.
outputTableNamesNames of the tables to which output data from the proc will be written. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from inputTableNames, excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc.
optionsOptional parameters.
  • gpudb::execute_proc_cache_input: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to /execute/proc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the /show/proc/status option of /show/proc/status and all proc instances using the cached data have completed. The default value is ''.
  • gpudb::execute_proc_use_cached_input: A comma-delimited list of run IDs (as returned from prior calls to /execute/proc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in inputTableNames, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.
  • gpudb::execute_proc_kifs_input_dirs: A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. (All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filter() [1/4]

FilterResponse gpudb::GPUdb::filter ( const FilterRequest request_) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filter() [2/4]

FilterResponse& gpudb::GPUdb::filter ( const FilterRequest request_,
FilterResponse response_ 
) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filter() [3/4]

FilterResponse gpudb::GPUdb::filter ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  expression,
const std::map< std::string, std::string > &  options 
) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
tableNameName of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
expressionThe select expression to filter the specified table. For details see Expressions.
optionsOptional parameters.
  • gpudb::filter_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
  • gpudb::filter_view_id: view this filtered-view is part of. The default value is ''.
  • gpudb::filter_ttl: Sets the TTL of the view specified in viewName.
Returns
Response object containing the result of the operation.

◆ filter() [4/4]

FilterResponse& gpudb::GPUdb::filter ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  expression,
const std::map< std::string, std::string > &  options,
FilterResponse response_ 
) const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see Expressions.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters
tableNameName of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
expressionThe select expression to filter the specified table. For details see Expressions.
optionsOptional parameters.
  • gpudb::filter_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
  • gpudb::filter_view_id: view this filtered-view is part of. The default value is ''.
  • gpudb::filter_ttl: Sets the TTL of the view specified in viewName.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByArea() [1/4]

FilterByAreaResponse gpudb::GPUdb::filterByArea ( const FilterByAreaRequest request_) const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByArea() [2/4]

FilterByAreaResponse& gpudb::GPUdb::filterByArea ( const FilterByAreaRequest request_,
FilterByAreaResponse response_ 
) const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByArea() [3/4]

FilterByAreaResponse gpudb::GPUdb::filterByArea ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  xColumnName,
const std::vector< double > &  xVector,
const std::string &  yColumnName,
const std::vector< double > &  yVector,
const std::map< std::string, std::string > &  options 
) const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
tableNameName of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
xColumnNameName of the column containing the x values to be filtered.
xVectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
yColumnNameName of the column containing the y values to be filtered.
yVectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional parameters.
  • gpudb::filter_by_area_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByArea() [4/4]

FilterByAreaResponse& gpudb::GPUdb::filterByArea ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  xColumnName,
const std::vector< double > &  xVector,
const std::string &  yColumnName,
const std::vector< double > &  yVector,
const std::map< std::string, std::string > &  options,
FilterByAreaResponse response_ 
) const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
tableNameName of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
xColumnNameName of the column containing the x values to be filtered.
xVectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
yColumnNameName of the column containing the y values to be filtered.
yVectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional parameters.
  • gpudb::filter_by_area_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByAreaGeometry() [1/4]

FilterByAreaGeometryResponse gpudb::GPUdb::filterByAreaGeometry ( const FilterByAreaGeometryRequest request_) const

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByAreaGeometry() [2/4]

FilterByAreaGeometryResponse& gpudb::GPUdb::filterByAreaGeometry ( const FilterByAreaGeometryRequest request_,
FilterByAreaGeometryResponse response_ 
) const

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByAreaGeometry() [3/4]

FilterByAreaGeometryResponse gpudb::GPUdb::filterByAreaGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::vector< double > &  xVector,
const std::vector< double > &  yVector,
const std::map< std::string, std::string > &  options 
) const

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
tableNameName of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
columnNameName of the geospatial geometry column to be filtered.
xVectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
yVectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional parameters.
  • gpudb::filter_by_area_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByAreaGeometry() [4/4]

FilterByAreaGeometryResponse& gpudb::GPUdb::filterByAreaGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::vector< double > &  xVector,
const std::vector< double > &  yVector,
const std::map< std::string, std::string > &  options,
FilterByAreaGeometryResponse response_ 
) const

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).

The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters
tableNameName of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
columnNameName of the geospatial geometry column to be filtered.
xVectorList of x coordinates of the vertices of the polygon representing the area to be filtered.
yVectorList of y coordinates of the vertices of the polygon representing the area to be filtered.
optionsOptional parameters.
  • gpudb::filter_by_area_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByBox() [1/4]

FilterByBoxResponse gpudb::GPUdb::filterByBox ( const FilterByBoxRequest request_) const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByBox() [2/4]

FilterByBoxResponse& gpudb::GPUdb::filterByBox ( const FilterByBoxRequest request_,
FilterByBoxResponse response_ 
) const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByBox() [3/4]

FilterByBoxResponse gpudb::GPUdb::filterByBox ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  xColumnName,
const double  minX,
const double  maxX,
const std::string &  yColumnName,
const double  minY,
const double  maxY,
const std::map< std::string, std::string > &  options 
) const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
tableNameName of the table on which the bounding box operation will be performed. Must be an existing table.
viewNameOptional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables.
xColumnNameName of the column on which to perform the bounding box query. Must be a valid numeric column.
minXLower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
maxXUpper bound for xColumnName. Must be greater than or equal to minX.
yColumnNameName of a column on which to perform the bounding box query. Must be a valid numeric column.
minYLower bound for yColumnName. Must be less than or equal to maxY.
maxYUpper bound for yColumnName. Must be greater than or equal to minY.
optionsOptional parameters.
  • gpudb::filter_by_box_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByBox() [4/4]

FilterByBoxResponse& gpudb::GPUdb::filterByBox ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  xColumnName,
const double  minX,
const double  maxX,
const std::string &  yColumnName,
const double  minY,
const double  maxY,
const std::map< std::string, std::string > &  options,
FilterByBoxResponse response_ 
) const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
tableNameName of the table on which the bounding box operation will be performed. Must be an existing table.
viewNameOptional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables.
xColumnNameName of the column on which to perform the bounding box query. Must be a valid numeric column.
minXLower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
maxXUpper bound for xColumnName. Must be greater than or equal to minX.
yColumnNameName of a column on which to perform the bounding box query. Must be a valid numeric column.
minYLower bound for yColumnName. Must be less than or equal to maxY.
maxYUpper bound for yColumnName. Must be greater than or equal to minY.
optionsOptional parameters.
  • gpudb::filter_by_box_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByBoxGeometry() [1/4]

FilterByBoxGeometryResponse gpudb::GPUdb::filterByBoxGeometry ( const FilterByBoxGeometryRequest request_) const

Calculates which geospatial geometry objects from a table intersect a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByBoxGeometry() [2/4]

FilterByBoxGeometryResponse& gpudb::GPUdb::filterByBoxGeometry ( const FilterByBoxGeometryRequest request_,
FilterByBoxGeometryResponse response_ 
) const

Calculates which geospatial geometry objects from a table intersect a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByBoxGeometry() [3/4]

FilterByBoxGeometryResponse gpudb::GPUdb::filterByBoxGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const double  minX,
const double  maxX,
const double  minY,
const double  maxY,
const std::map< std::string, std::string > &  options 
) const

Calculates which geospatial geometry objects from a table intersect a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
tableNameName of the table on which the bounding box operation will be performed. Must be an existing table.
viewNameOptional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view.
columnNameName of the geospatial geometry column to be filtered.
minXLower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.
maxXUpper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.
minYLower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.
maxYUpper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.
optionsOptional parameters.
  • gpudb::filter_by_box_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByBoxGeometry() [4/4]

FilterByBoxGeometryResponse& gpudb::GPUdb::filterByBoxGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const double  minX,
const double  maxX,
const double  minY,
const double  maxY,
const std::map< std::string, std::string > &  options,
FilterByBoxGeometryResponse response_ 
) const

Calculates which geospatial geometry objects from a table intersect a rectangular box.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters
tableNameName of the table on which the bounding box operation will be performed. Must be an existing table.
viewNameOptional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view.
columnNameName of the geospatial geometry column to be filtered.
minXLower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.
maxXUpper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.
minYLower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.
maxYUpper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.
optionsOptional parameters.
  • gpudb::filter_by_box_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByGeometry() [1/4]

FilterByGeometryResponse gpudb::GPUdb::filterByGeometry ( const FilterByGeometryRequest request_) const

Applies a geometry filter against a geospatial geometry column in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByGeometry() [2/4]

FilterByGeometryResponse& gpudb::GPUdb::filterByGeometry ( const FilterByGeometryRequest request_,
FilterByGeometryResponse response_ 
) const

Applies a geometry filter against a geospatial geometry column in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByGeometry() [3/4]

FilterByGeometryResponse gpudb::GPUdb::filterByGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::string &  inputWkt,
const std::string &  operation,
const std::map< std::string, std::string > &  options 
) const

Applies a geometry filter against a geospatial geometry column in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters
tableNameName of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnNameName of the column to be used in the filter. Must be a geospatial geometry column.
inputWktA geometry in WKT format that will be used to filter the objects in tableName.
operationThe geometric filtering operation to perform
optionsOptional parameters.
  • gpudb::filter_by_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByGeometry() [4/4]

FilterByGeometryResponse& gpudb::GPUdb::filterByGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::string &  inputWkt,
const std::string &  operation,
const std::map< std::string, std::string > &  options,
FilterByGeometryResponse response_ 
) const

Applies a geometry filter against a geospatial geometry column in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters
tableNameName of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnNameName of the column to be used in the filter. Must be a geospatial geometry column.
inputWktA geometry in WKT format that will be used to filter the objects in tableName.
operationThe geometric filtering operation to perform
optionsOptional parameters.
  • gpudb::filter_by_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByList() [1/4]

FilterByListResponse gpudb::GPUdb::filterByList ( const FilterByListRequest request_) const

Calculates which records from a table have values in the given list for the corresponding column.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByList() [2/4]

FilterByListResponse& gpudb::GPUdb::filterByList ( const FilterByListRequest request_,
FilterByListResponse response_ 
) const

Calculates which records from a table have values in the given list for the corresponding column.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByList() [3/4]

FilterByListResponse gpudb::GPUdb::filterByList ( const std::string &  tableName,
const std::string &  viewName,
const std::map< std::string, std::vector< std::string > > &  columnValuesMap,
const std::map< std::string, std::string > &  options 
) const

Calculates which records from a table have values in the given list for the corresponding column.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Parameters
tableNameName of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnValuesMapList of values for the corresponding column in the table
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ filterByList() [4/4]

FilterByListResponse& gpudb::GPUdb::filterByList ( const std::string &  tableName,
const std::string &  viewName,
const std::map< std::string, std::vector< std::string > > &  columnValuesMap,
const std::map< std::string, std::string > &  options,
FilterByListResponse response_ 
) const

Calculates which records from a table have values in the given list for the corresponding column.

The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Parameters
tableNameName of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnValuesMapList of values for the corresponding column in the table
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByRadius() [1/4]

FilterByRadiusResponse gpudb::GPUdb::filterByRadius ( const FilterByRadiusRequest request_) const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByRadius() [2/4]

FilterByRadiusResponse& gpudb::GPUdb::filterByRadius ( const FilterByRadiusRequest request_,
FilterByRadiusResponse response_ 
) const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByRadius() [3/4]

FilterByRadiusResponse gpudb::GPUdb::filterByRadius ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  xColumnName,
const double  xCenter,
const std::string &  yColumnName,
const double  yCenter,
const double  radius,
const std::map< std::string, std::string > &  options 
) const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Parameters
tableNameName of the table on which the filter by radius operation will be performed. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
xColumnNameName of the column to be used for the x-coordinate (the longitude) of the center.
xCenterValue of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
yColumnNameName of the column to be used for the y-coordinate-the latitude-of the center.
yCenterValue of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radiusThe radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
optionsOptional parameters.
  • gpudb::filter_by_radius_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByRadius() [4/4]

FilterByRadiusResponse& gpudb::GPUdb::filterByRadius ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  xColumnName,
const double  xCenter,
const std::string &  yColumnName,
const double  yCenter,
const double  radius,
const std::map< std::string, std::string > &  options,
FilterByRadiusResponse response_ 
) const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.

Parameters
tableNameName of the table on which the filter by radius operation will be performed. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
xColumnNameName of the column to be used for the x-coordinate (the longitude) of the center.
xCenterValue of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
yColumnNameName of the column to be used for the y-coordinate-the latitude-of the center.
yCenterValue of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radiusThe radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
optionsOptional parameters.
  • gpudb::filter_by_radius_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByRadiusGeometry() [1/4]

FilterByRadiusGeometryResponse gpudb::GPUdb::filterByRadiusGeometry ( const FilterByRadiusGeometryRequest request_) const

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByRadiusGeometry() [2/4]

FilterByRadiusGeometryResponse& gpudb::GPUdb::filterByRadiusGeometry ( const FilterByRadiusGeometryRequest request_,
FilterByRadiusGeometryResponse response_ 
) const

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByRadiusGeometry() [3/4]

FilterByRadiusGeometryResponse gpudb::GPUdb::filterByRadiusGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const double  xCenter,
const double  yCenter,
const double  radius,
const std::map< std::string, std::string > &  options 
) const

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

Parameters
tableNameName of the table on which the filter by radius operation will be performed. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
columnNameName of the geospatial geometry column to be filtered.
xCenterValue of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
yCenterValue of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radiusThe radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
optionsOptional parameters.
  • gpudb::filter_by_radius_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByRadiusGeometry() [4/4]

FilterByRadiusGeometryResponse& gpudb::GPUdb::filterByRadiusGeometry ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const double  xCenter,
const double  yCenter,
const double  radius,
const std::map< std::string, std::string > &  options,
FilterByRadiusGeometryResponse response_ 
) const

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

Parameters
tableNameName of the table on which the filter by radius operation will be performed. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
columnNameName of the geospatial geometry column to be filtered.
xCenterValue of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
yCenterValue of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radiusThe radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
optionsOptional parameters.
  • gpudb::filter_by_radius_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByRange() [1/4]

FilterByRangeResponse gpudb::GPUdb::filterByRange ( const FilterByRangeRequest request_) const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByRange() [2/4]

FilterByRangeResponse& gpudb::GPUdb::filterByRange ( const FilterByRangeRequest request_,
FilterByRangeResponse response_ 
) const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByRange() [3/4]

FilterByRangeResponse gpudb::GPUdb::filterByRange ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const double  lowerBound,
const double  upperBound,
const std::map< std::string, std::string > &  options 
) const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters
tableNameName of the table on which the filter by range operation will be performed. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnNameName of a column on which the operation would be applied.
lowerBoundValue of the lower bound (inclusive).
upperBoundValue of the upper bound (inclusive).
optionsOptional parameters.
  • gpudb::filter_by_range_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByRange() [4/4]

FilterByRangeResponse& gpudb::GPUdb::filterByRange ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const double  lowerBound,
const double  upperBound,
const std::map< std::string, std::string > &  options,
FilterByRangeResponse response_ 
) const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters
tableNameName of the table on which the filter by range operation will be performed. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnNameName of a column on which the operation would be applied.
lowerBoundValue of the lower bound (inclusive).
upperBoundValue of the upper bound (inclusive).
optionsOptional parameters.
  • gpudb::filter_by_range_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterBySeries() [1/4]

FilterBySeriesResponse gpudb::GPUdb::filterBySeries ( const FilterBySeriesRequest request_) const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterBySeries() [2/4]

FilterBySeriesResponse& gpudb::GPUdb::filterBySeries ( const FilterBySeriesRequest request_,
FilterBySeriesResponse response_ 
) const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterBySeries() [3/4]

FilterBySeriesResponse gpudb::GPUdb::filterBySeries ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  trackId,
const std::vector< std::string > &  targetTrackIds,
const std::map< std::string, std::string > &  options 
) const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Parameters
tableNameName of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
trackIdThe ID of the track which will act as the filtering points. Must be an existing track within the given table.
targetTrackIdsUp to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ filterBySeries() [4/4]

FilterBySeriesResponse& gpudb::GPUdb::filterBySeries ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  trackId,
const std::vector< std::string > &  targetTrackIds,
const std::map< std::string, std::string > &  options,
FilterBySeriesResponse response_ 
) const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.

Parameters
tableNameName of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
trackIdThe ID of the track which will act as the filtering points. Must be an existing track within the given table.
targetTrackIdsUp to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByString() [1/4]

FilterByStringResponse gpudb::GPUdb::filterByString ( const FilterByStringRequest request_) const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByString() [2/4]

FilterByStringResponse& gpudb::GPUdb::filterByString ( const FilterByStringRequest request_,
FilterByStringResponse response_ 
) const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByString() [3/4]

FilterByStringResponse gpudb::GPUdb::filterByString ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  expression,
const std::string &  mode,
const std::vector< std::string > &  columnNames,
const std::map< std::string, std::string > &  options 
) const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.

Parameters
tableNameName of the table on which the filter operation will be performed. Must be an existing table, collection or view.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
expressionThe expression with which to filter the table.
modeThe string filtering mode to apply. See below for details.
  • gpudb::filter_by_string_search: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
  • gpudb::filter_by_string_equals: Exact whole-string match (accelerated).
  • gpudb::filter_by_string_contains: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • gpudb::filter_by_string_starts_with: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • gpudb::filter_by_string_regex: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
columnNamesList of columns on which to apply the filter. Ignored for 'search' mode.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ filterByString() [4/4]

FilterByStringResponse& gpudb::GPUdb::filterByString ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  expression,
const std::string &  mode,
const std::vector< std::string > &  columnNames,
const std::map< std::string, std::string > &  options,
FilterByStringResponse response_ 
) const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.

Parameters
tableNameName of the table on which the filter operation will be performed. Must be an existing table, collection or view.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
expressionThe expression with which to filter the table.
modeThe string filtering mode to apply. See below for details.
  • gpudb::filter_by_string_search: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
  • gpudb::filter_by_string_equals: Exact whole-string match (accelerated).
  • gpudb::filter_by_string_contains: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • gpudb::filter_by_string_starts_with: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
  • gpudb::filter_by_string_regex: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
columnNamesList of columns on which to apply the filter. Ignored for 'search' mode.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByTable() [1/4]

FilterByTableResponse gpudb::GPUdb::filterByTable ( const FilterByTableRequest request_) const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByTable() [2/4]

FilterByTableResponse& gpudb::GPUdb::filterByTable ( const FilterByTableRequest request_,
FilterByTableResponse response_ 
) const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByTable() [3/4]

FilterByTableResponse gpudb::GPUdb::filterByTable ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::string &  sourceTableName,
const std::string &  sourceTableColumnName,
const std::map< std::string, std::string > &  options 
) const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Parameters
tableNameName of the table whose data will be filtered. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnNameName of the column by whose value the data will be filtered from the table designated by tableName.
sourceTableNameName of the table whose data will be compared against in the table called tableName. Must be an existing table.
sourceTableColumnNameName of the column in the sourceTableName whose values will be used as the filter for table tableName. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the columnName.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ filterByTable() [4/4]

FilterByTableResponse& gpudb::GPUdb::filterByTable ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::string &  sourceTableName,
const std::string &  sourceTableColumnName,
const std::map< std::string, std::string > &  options,
FilterByTableResponse response_ 
) const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Parameters
tableNameName of the table whose data will be filtered. Must be an existing table.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
columnNameName of the column by whose value the data will be filtered from the table designated by tableName.
sourceTableNameName of the table whose data will be compared against in the table called tableName. Must be an existing table.
sourceTableColumnNameName of the column in the sourceTableName whose values will be used as the filter for table tableName. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the columnName.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByValue() [1/4]

FilterByValueResponse gpudb::GPUdb::filterByValue ( const FilterByValueRequest request_) const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ filterByValue() [2/4]

FilterByValueResponse& gpudb::GPUdb::filterByValue ( const FilterByValueRequest request_,
FilterByValueResponse response_ 
) const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ filterByValue() [3/4]

FilterByValueResponse gpudb::GPUdb::filterByValue ( const std::string &  tableName,
const std::string &  viewName,
const bool  isString,
const double  value,
const std::string &  valueStr,
const std::string &  columnName,
const std::map< std::string, std::string > &  options 
) const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Parameters
tableNameName of an existing table on which to perform the calculation.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
isStringIndicates whether the value being searched for is string or numeric.
valueThe value to search for.
valueStrThe string value to search for.
columnNameName of a column on which the filter by value would be applied.
optionsOptional parameters.
  • gpudb::filter_by_value_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Returns
Response object containing the result of the operation.

◆ filterByValue() [4/4]

FilterByValueResponse& gpudb::GPUdb::filterByValue ( const std::string &  tableName,
const std::string &  viewName,
const bool  isString,
const double  value,
const std::string &  valueStr,
const std::string &  columnName,
const std::map< std::string, std::string > &  options,
FilterByValueResponse response_ 
) const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Parameters
tableNameName of an existing table on which to perform the calculation.
viewNameIf provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
isStringIndicates whether the value being searched for is string or numeric.
valueThe value to search for.
valueStrThe string value to search for.
columnNameName of a column on which the filter by value would be applied.
optionsOptional parameters.
  • gpudb::filter_by_value_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getApiVersion()

static std::string gpudb::GPUdb::getApiVersion ( )
inlinestatic

Definition at line 110 of file GPUdb.hpp.

◆ getExecutor()

avro::ExecutorPtr gpudb::GPUdb::getExecutor ( ) const

◆ getHmUrl()

const HttpUrl& gpudb::GPUdb::getHmUrl ( ) const

◆ getHmUrls()

const std::vector<HttpUrl>& gpudb::GPUdb::getHmUrls ( ) const

◆ getHttpHeaders()

const std::map<std::string, std::string>& gpudb::GPUdb::getHttpHeaders ( ) const

◆ getJob() [1/4]

GetJobResponse gpudb::GPUdb::getJob ( const GetJobRequest request_) const
Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getJob() [2/4]

GetJobResponse& gpudb::GPUdb::getJob ( const GetJobRequest request_,
GetJobResponse response_ 
) const
Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getJob() [3/4]

GetJobResponse gpudb::GPUdb::getJob ( const int32_t  jobId,
const std::map< std::string, std::string > &  options 
) const
Parameters
jobIdA unique identifier for the job whose status and result is to be fetched.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ getJob() [4/4]

GetJobResponse& gpudb::GPUdb::getJob ( const int32_t  jobId,
const std::map< std::string, std::string > &  options,
GetJobResponse response_ 
) const
Parameters
jobIdA unique identifier for the job whose status and result is to be fetched.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getPassword()

const std::string& gpudb::GPUdb::getPassword ( ) const

◆ getRecords() [1/20]

template<>
GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords ( const GetRecordsRequest request_) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecords() [2/20]

template<>
GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords ( const GetRecordsRequest request_) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecords() [3/20]

template<>
GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords ( const GetRecordsRequest request_,
GetRecordsResponse< boost::any > &  response_ 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecords() [4/20]

template<>
GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords ( const GetRecordsRequest request_,
GetRecordsResponse< boost::any > &  response_ 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecords() [5/20]

template<>
GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

◆ getRecords() [6/20]

template<>
GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

◆ getRecords() [7/20]

template<>
GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsResponse< boost::any > &  response_ 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecords() [8/20]

template<>
GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsResponse< boost::any > &  response_ 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecords() [9/20]

template<typename TResponse >
GetRecordsResponse<TResponse> gpudb::GPUdb::getRecords ( const GetRecordsRequest request_) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 10042 of file GPUdb.hpp.

◆ getRecords() [10/20]

template<typename TResponse >
GetRecordsResponse<TResponse>& gpudb::GPUdb::getRecords ( const GetRecordsRequest request_,
GetRecordsResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 10085 of file GPUdb.hpp.

◆ getRecords() [11/20]

template<typename TResponse >
GetRecordsResponse<TResponse> gpudb::GPUdb::getRecords ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

Definition at line 10160 of file GPUdb.hpp.

◆ getRecords() [12/20]

template<typename TResponse >
GetRecordsResponse<TResponse>& gpudb::GPUdb::getRecords ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 10243 of file GPUdb.hpp.

◆ getRecords() [13/20]

template<typename TResponse >
GetRecordsResponse<TResponse> gpudb::GPUdb::getRecords ( const ::avro::ValidSchema &  schema_,
const GetRecordsRequest request_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 10289 of file GPUdb.hpp.

◆ getRecords() [14/20]

template<typename TResponse >
GetRecordsResponse<TResponse> gpudb::GPUdb::getRecords ( const Type type_,
const GetRecordsRequest request_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 10331 of file GPUdb.hpp.

◆ getRecords() [15/20]

template<typename TResponse >
GetRecordsResponse<TResponse>& gpudb::GPUdb::getRecords ( const ::avro::ValidSchema &  schema_,
const GetRecordsRequest request_,
GetRecordsResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 10376 of file GPUdb.hpp.

◆ getRecords() [16/20]

template<typename TResponse >
GetRecordsResponse<TResponse>& gpudb::GPUdb::getRecords ( const Type type_,
const GetRecordsRequest request_,
GetRecordsResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 10421 of file GPUdb.hpp.

◆ getRecords() [17/20]

template<typename TResponse >
GetRecordsResponse<TResponse> gpudb::GPUdb::getRecords ( const ::avro::ValidSchema &  schema_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

Definition at line 10498 of file GPUdb.hpp.

◆ getRecords() [18/20]

template<typename TResponse >
GetRecordsResponse<TResponse> gpudb::GPUdb::getRecords ( const Type type_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

Definition at line 10580 of file GPUdb.hpp.

◆ getRecords() [19/20]

template<typename TResponse >
GetRecordsResponse<TResponse>& gpudb::GPUdb::getRecords ( const ::avro::ValidSchema &  schema_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 10665 of file GPUdb.hpp.

◆ getRecords() [20/20]

template<typename TResponse >
GetRecordsResponse<TResponse>& gpudb::GPUdb::getRecords ( const Type type_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
tableNameName of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 10750 of file GPUdb.hpp.

◆ getRecordsByColumn() [1/4]

GetRecordsByColumnResponse gpudb::GPUdb::getRecordsByColumn ( const GetRecordsByColumnRequest request_) const

For a given table, retrieves the values from the requested column(s).

Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const CreateProjectionRequest&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsByColumn() [2/4]

GetRecordsByColumnResponse& gpudb::GPUdb::getRecordsByColumn ( const GetRecordsByColumnRequest request_,
GetRecordsByColumnResponse response_ 
) const

For a given table, retrieves the values from the requested column(s).

Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const CreateProjectionRequest&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsByColumn() [3/4]

GetRecordsByColumnResponse gpudb::GPUdb::getRecordsByColumn ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

For a given table, retrieves the values from the requested column(s).

Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const std::string&,const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
tableNameName of the table on which this operation will be performed. The table cannot be a parent set.
columnNamesThe list of column values to retrieve.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
options
Returns
Response object containing the result of the operation.

◆ getRecordsByColumn() [4/4]

GetRecordsByColumnResponse& gpudb::GPUdb::getRecordsByColumn ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsByColumnResponse response_ 
) const

For a given table, retrieves the values from the requested column(s).

Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const std::string&,const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
tableNameName of the table on which this operation will be performed. The table cannot be a parent set.
columnNamesThe list of column values to retrieve.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned (if not provided the default is 10000), or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsByColumnRaw() [1/2]

RawGetRecordsByColumnResponse gpudb::GPUdb::getRecordsByColumnRaw ( const GetRecordsByColumnRequest request_) const

For a given table, retrieves the values from the requested column(s).

Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const CreateProjectionRequest&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsByColumnRaw() [2/2]

RawGetRecordsByColumnResponse& gpudb::GPUdb::getRecordsByColumnRaw ( const GetRecordsByColumnRequest request_,
RawGetRecordsByColumnResponse response_ 
) const

For a given table, retrieves the values from the requested column(s).

Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const CreateProjectionRequest&,CreateProjectionResponse&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsBySeries() [1/20]

template<>
GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries ( const GetRecordsBySeriesRequest request_) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsBySeries() [2/20]

template<>
GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries ( const GetRecordsBySeriesRequest request_) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsBySeries() [3/20]

template<>
GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries ( const GetRecordsBySeriesRequest request_,
GetRecordsBySeriesResponse< boost::any > &  response_ 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const GetRecordsRequest&,GetRecordsResponse<boost::any>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsBySeries() [4/20]

template<>
GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries ( const GetRecordsBySeriesRequest request_,
GetRecordsBySeriesResponse< boost::any > &  response_ 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const GetRecordsRequest&,GetRecordsResponse<boost::any>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsBySeries() [5/20]

template<>
GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries ( const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ getRecordsBySeries() [6/20]

template<>
GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries ( const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ getRecordsBySeries() [7/20]

template<>
GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries ( const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsBySeriesResponse< boost::any > &  response_ 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<boost::any>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsBySeries() [8/20]

template<>
GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries ( const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsBySeriesResponse< boost::any > &  response_ 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<boost::any>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsBySeries() [9/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse> gpudb::GPUdb::getRecordsBySeries ( const GetRecordsBySeriesRequest request_) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 11119 of file GPUdb.hpp.

◆ getRecordsBySeries() [10/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse>& gpudb::GPUdb::getRecordsBySeries ( const GetRecordsBySeriesRequest request_,
GetRecordsBySeriesResponse< TResponse > &  response_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const GetRecordsRequest&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11168 of file GPUdb.hpp.

◆ getRecordsBySeries() [11/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse> gpudb::GPUdb::getRecordsBySeries ( const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 11229 of file GPUdb.hpp.

◆ getRecordsBySeries() [12/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse>& gpudb::GPUdb::getRecordsBySeries ( const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsBySeriesResponse< TResponse > &  response_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11300 of file GPUdb.hpp.

◆ getRecordsBySeries() [13/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse> gpudb::GPUdb::getRecordsBySeries ( const ::avro::ValidSchema &  schema_,
const GetRecordsBySeriesRequest request_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const ::avro::ValidSchema&,const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 11354 of file GPUdb.hpp.

◆ getRecordsBySeries() [14/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse> gpudb::GPUdb::getRecordsBySeries ( const Type type_,
const GetRecordsBySeriesRequest request_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const Type&,const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 11401 of file GPUdb.hpp.

◆ getRecordsBySeries() [15/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse>& gpudb::GPUdb::getRecordsBySeries ( const ::avro::ValidSchema &  schema_,
const GetRecordsBySeriesRequest request_,
GetRecordsBySeriesResponse< TResponse > &  response_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const ::avro::ValidSchema&,const GetRecordsRequest&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11452 of file GPUdb.hpp.

◆ getRecordsBySeries() [16/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse>& gpudb::GPUdb::getRecordsBySeries ( const Type type_,
const GetRecordsBySeriesRequest request_,
GetRecordsBySeriesResponse< TResponse > &  response_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const Type&,const GetRecordsRequest&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11503 of file GPUdb.hpp.

◆ getRecordsBySeries() [17/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse> gpudb::GPUdb::getRecordsBySeries ( const ::avro::ValidSchema &  schema_,
const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const ::avro::ValidSchema&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 11566 of file GPUdb.hpp.

◆ getRecordsBySeries() [18/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse> gpudb::GPUdb::getRecordsBySeries ( const Type type_,
const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const Type&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 11636 of file GPUdb.hpp.

◆ getRecordsBySeries() [19/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse>& gpudb::GPUdb::getRecordsBySeries ( const ::avro::ValidSchema &  schema_,
const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsBySeriesResponse< TResponse > &  response_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const ::avro::ValidSchema&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11709 of file GPUdb.hpp.

◆ getRecordsBySeries() [20/20]

template<typename TResponse >
GetRecordsBySeriesResponse<TResponse>& gpudb::GPUdb::getRecordsBySeries ( const Type type_,
const std::string &  tableName,
const std::string &  worldTableName,
const int32_t  offset,
const int32_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsBySeriesResponse< TResponse > &  response_ 
) const
inline

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecords(const Type&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
tableNameName of the collection/table/view for which series/tracks will be fetched.
worldTableNameName of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offsetA positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11782 of file GPUdb.hpp.

◆ getRecordsBySeriesRaw() [1/2]

RawGetRecordsBySeriesResponse gpudb::GPUdb::getRecordsBySeriesRaw ( const GetRecordsBySeriesRequest request_) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecordsRaw(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsBySeriesRaw() [2/2]

RawGetRecordsBySeriesResponse& gpudb::GPUdb::getRecordsBySeriesRaw ( const GetRecordsBySeriesRequest request_,
RawGetRecordsBySeriesResponse response_ 
) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

This operation supports paging through the data via the offset and limit parameters.

In contrast to getRecordsRaw(const GetRecordsRequest&,RawGetRecordsResponse&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsFromCollection() [1/20]

template<>
GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection ( const GetRecordsFromCollectionRequest request_) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsFromCollection() [2/20]

template<>
GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection ( const GetRecordsFromCollectionRequest request_) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsFromCollection() [3/20]

template<>
GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection ( const GetRecordsFromCollectionRequest request_,
GetRecordsFromCollectionResponse< boost::any > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsFromCollection() [4/20]

template<>
GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection ( const GetRecordsFromCollectionRequest request_,
GetRecordsFromCollectionResponse< boost::any > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsFromCollection() [5/20]

template<>
GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

◆ getRecordsFromCollection() [6/20]

template<>
GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

◆ getRecordsFromCollection() [7/20]

template<>
GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsFromCollectionResponse< boost::any > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsFromCollection() [8/20]

template<>
GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsFromCollectionResponse< boost::any > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsFromCollection() [9/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> gpudb::GPUdb::getRecordsFromCollection ( const GetRecordsFromCollectionRequest request_) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 11877 of file GPUdb.hpp.

◆ getRecordsFromCollection() [10/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& gpudb::GPUdb::getRecordsFromCollection ( const GetRecordsFromCollectionRequest request_,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 11917 of file GPUdb.hpp.

◆ getRecordsFromCollection() [11/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> gpudb::GPUdb::getRecordsFromCollection ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

Definition at line 11974 of file GPUdb.hpp.

◆ getRecordsFromCollection() [12/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& gpudb::GPUdb::getRecordsFromCollection ( const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 12039 of file GPUdb.hpp.

◆ getRecordsFromCollection() [13/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> gpudb::GPUdb::getRecordsFromCollection ( const ::avro::ValidSchema &  schema_,
const GetRecordsFromCollectionRequest request_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 12082 of file GPUdb.hpp.

◆ getRecordsFromCollection() [14/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> gpudb::GPUdb::getRecordsFromCollection ( const Type type_,
const GetRecordsFromCollectionRequest request_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 12121 of file GPUdb.hpp.

◆ getRecordsFromCollection() [15/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& gpudb::GPUdb::getRecordsFromCollection ( const ::avro::ValidSchema &  schema_,
const GetRecordsFromCollectionRequest request_,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 12163 of file GPUdb.hpp.

◆ getRecordsFromCollection() [16/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& gpudb::GPUdb::getRecordsFromCollection ( const Type type_,
const GetRecordsFromCollectionRequest request_,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 12205 of file GPUdb.hpp.

◆ getRecordsFromCollection() [17/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> gpudb::GPUdb::getRecordsFromCollection ( const ::avro::ValidSchema &  schema_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

Definition at line 12264 of file GPUdb.hpp.

◆ getRecordsFromCollection() [18/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> gpudb::GPUdb::getRecordsFromCollection ( const Type type_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
Returns
Response object containing the result of the operation.

Definition at line 12328 of file GPUdb.hpp.

◆ getRecordsFromCollection() [19/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& gpudb::GPUdb::getRecordsFromCollection ( const ::avro::ValidSchema &  schema_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]schema_Avro schema object used for decoding returned objects.
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 12395 of file GPUdb.hpp.

◆ getRecordsFromCollection() [20/20]

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& gpudb::GPUdb::getRecordsFromCollection ( const Type type_,
const std::string &  tableName,
const int64_t  offset,
const int64_t  limit,
const std::map< std::string, std::string > &  options,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const
inline

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters
<TResponse>The type of object being retrieved.
Parameters
[in]type_Type object used for decoding returned objects.
tableNameName of the collection or table from which records are to be retrieved. Must be an existing collection or table.
offsetA positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limitA positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned.
options
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 12462 of file GPUdb.hpp.

◆ getRecordsFromCollectionRaw() [1/2]

RawGetRecordsFromCollectionResponse gpudb::GPUdb::getRecordsFromCollectionRaw ( const GetRecordsFromCollectionRequest request_) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsFromCollectionRaw() [2/2]

RawGetRecordsFromCollectionResponse& gpudb::GPUdb::getRecordsFromCollectionRaw ( const GetRecordsFromCollectionRequest request_,
RawGetRecordsFromCollectionResponse response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&,DeleteRecordsResponse&) const.

This operation supports paging through the data via the offset and limit parameters.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getRecordsRaw() [1/2]

RawGetRecordsResponse gpudb::GPUdb::getRecordsRaw ( const GetRecordsRequest request_) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ getRecordsRaw() [2/2]

RawGetRecordsResponse& gpudb::GPUdb::getRecordsRaw ( const GetRecordsRequest request_,
RawGetRecordsResponse response_ 
) const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.

This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ getSslContext()

boost::asio::ssl::context* gpudb::GPUdb::getSslContext ( ) const

◆ getThreadCount()

size_t gpudb::GPUdb::getThreadCount ( ) const

◆ getTimeout()

size_t gpudb::GPUdb::getTimeout ( ) const

◆ getUrl()

const HttpUrl& gpudb::GPUdb::getUrl ( ) const

Some getters.

◆ getUrls()

const std::vector<HttpUrl>& gpudb::GPUdb::getUrls ( ) const

◆ getUsername()

const std::string& gpudb::GPUdb::getUsername ( ) const

◆ getUseSnappy()

bool gpudb::GPUdb::getUseSnappy ( ) const

◆ grantPermissionSystem() [1/4]

GrantPermissionSystemResponse gpudb::GPUdb::grantPermissionSystem ( const GrantPermissionSystemRequest request_) const

Grants a system-level permission to a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ grantPermissionSystem() [2/4]

GrantPermissionSystemResponse& gpudb::GPUdb::grantPermissionSystem ( const GrantPermissionSystemRequest request_,
GrantPermissionSystemResponse response_ 
) const

Grants a system-level permission to a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ grantPermissionSystem() [3/4]

GrantPermissionSystemResponse gpudb::GPUdb::grantPermissionSystem ( const std::string &  name,
const std::string &  permission,
const std::map< std::string, std::string > &  options 
) const

Grants a system-level permission to a user or role.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ grantPermissionSystem() [4/4]

GrantPermissionSystemResponse& gpudb::GPUdb::grantPermissionSystem ( const std::string &  name,
const std::string &  permission,
const std::map< std::string, std::string > &  options,
GrantPermissionSystemResponse response_ 
) const

Grants a system-level permission to a user or role.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ grantPermissionTable() [1/4]

GrantPermissionTableResponse gpudb::GPUdb::grantPermissionTable ( const GrantPermissionTableRequest request_) const

Grants a table-level permission to a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ grantPermissionTable() [2/4]

GrantPermissionTableResponse& gpudb::GPUdb::grantPermissionTable ( const GrantPermissionTableRequest request_,
GrantPermissionTableResponse response_ 
) const

Grants a table-level permission to a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ grantPermissionTable() [3/4]

GrantPermissionTableResponse gpudb::GPUdb::grantPermissionTable ( const std::string &  name,
const std::string &  permission,
const std::string &  tableName,
const std::string &  filterExpression,
const std::map< std::string, std::string > &  options 
) const

Grants a table-level permission to a user or role.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role.
tableNameName of the table to which the permission grants access. Must be an existing table, collection, or view. If a collection, the permission also applies to tables and views in the collection.
filterExpressionReserved for future use.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ grantPermissionTable() [4/4]

GrantPermissionTableResponse& gpudb::GPUdb::grantPermissionTable ( const std::string &  name,
const std::string &  permission,
const std::string &  tableName,
const std::string &  filterExpression,
const std::map< std::string, std::string > &  options,
GrantPermissionTableResponse response_ 
) const

Grants a table-level permission to a user or role.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role.
tableNameName of the table to which the permission grants access. Must be an existing table, collection, or view. If a collection, the permission also applies to tables and views in the collection.
filterExpressionReserved for future use.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ grantRole() [1/4]

GrantRoleResponse gpudb::GPUdb::grantRole ( const GrantRoleRequest request_) const

Grants membership in a role to a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ grantRole() [2/4]

GrantRoleResponse& gpudb::GPUdb::grantRole ( const GrantRoleRequest request_,
GrantRoleResponse response_ 
) const

Grants membership in a role to a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ grantRole() [3/4]

GrantRoleResponse gpudb::GPUdb::grantRole ( const std::string &  role,
const std::string &  member,
const std::map< std::string, std::string > &  options 
) const

Grants membership in a role to a user or role.

Parameters
roleName of the role in which membership will be granted. Must be an existing role.
memberName of the user or role that will be granted membership in role. Must be an existing user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ grantRole() [4/4]

GrantRoleResponse& gpudb::GPUdb::grantRole ( const std::string &  role,
const std::string &  member,
const std::map< std::string, std::string > &  options,
GrantRoleResponse response_ 
) const

Grants membership in a role to a user or role.

Parameters
roleName of the role in which membership will be granted. Must be an existing role.
memberName of the user or role that will be granted membership in role. Must be an existing user or role.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ hasProc() [1/4]

HasProcResponse gpudb::GPUdb::hasProc ( const HasProcRequest request_) const

Checks the existence of a proc with the given name.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ hasProc() [2/4]

HasProcResponse& gpudb::GPUdb::hasProc ( const HasProcRequest request_,
HasProcResponse response_ 
) const

Checks the existence of a proc with the given name.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ hasProc() [3/4]

HasProcResponse gpudb::GPUdb::hasProc ( const std::string &  procName,
const std::map< std::string, std::string > &  options 
) const

Checks the existence of a proc with the given name.

Parameters
procNameName of the proc to check for existence.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ hasProc() [4/4]

HasProcResponse& gpudb::GPUdb::hasProc ( const std::string &  procName,
const std::map< std::string, std::string > &  options,
HasProcResponse response_ 
) const

Checks the existence of a proc with the given name.

Parameters
procNameName of the proc to check for existence.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ hasTable() [1/4]

HasTableResponse gpudb::GPUdb::hasTable ( const HasTableRequest request_) const

Checks for the existence of a table with the given name.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ hasTable() [2/4]

HasTableResponse& gpudb::GPUdb::hasTable ( const HasTableRequest request_,
HasTableResponse response_ 
) const

Checks for the existence of a table with the given name.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ hasTable() [3/4]

HasTableResponse gpudb::GPUdb::hasTable ( const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Checks for the existence of a table with the given name.

Parameters
tableNameName of the table to check for existence.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ hasTable() [4/4]

HasTableResponse& gpudb::GPUdb::hasTable ( const std::string &  tableName,
const std::map< std::string, std::string > &  options,
HasTableResponse response_ 
) const

Checks for the existence of a table with the given name.

Parameters
tableNameName of the table to check for existence.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ hasType() [1/4]

HasTypeResponse gpudb::GPUdb::hasType ( const HasTypeRequest request_) const

Check for the existence of a type.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ hasType() [2/4]

HasTypeResponse& gpudb::GPUdb::hasType ( const HasTypeRequest request_,
HasTypeResponse response_ 
) const

Check for the existence of a type.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ hasType() [3/4]

HasTypeResponse gpudb::GPUdb::hasType ( const std::string &  typeId,
const std::map< std::string, std::string > &  options 
) const

Check for the existence of a type.

Parameters
typeIdId of the type returned in response to /create/type request.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ hasType() [4/4]

HasTypeResponse& gpudb::GPUdb::hasType ( const std::string &  typeId,
const std::map< std::string, std::string > &  options,
HasTypeResponse response_ 
) const

Check for the existence of a type.

Parameters
typeIdId of the type returned in response to /create/type request.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ insertRecords() [1/4]

template<typename TRequest >
InsertRecordsResponse gpudb::GPUdb::insertRecords ( const InsertRecordsRequest< TRequest > &  request_) const
inline

Adds multiple records to the specified table.

The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Template Parameters
<TRequest>The type of object being added.
Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 12989 of file GPUdb.hpp.

◆ insertRecords() [2/4]

template<typename TRequest >
InsertRecordsResponse& gpudb::GPUdb::insertRecords ( const InsertRecordsRequest< TRequest > &  request_,
InsertRecordsResponse response_ 
) const
inline

Adds multiple records to the specified table.

The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Template Parameters
<TRequest>The type of object being added.
Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 13030 of file GPUdb.hpp.

◆ insertRecords() [3/4]

template<typename TRequest >
InsertRecordsResponse gpudb::GPUdb::insertRecords ( const std::string &  tableName,
const std::vector< TRequest > &  data,
const std::map< std::string, std::string > &  options 
) const
inline

Adds multiple records to the specified table.

The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Template Parameters
<TRequest>The type of object being added.
Parameters
tableNameTable to which the records are to be added. Must be an existing table.
dataAn array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 13099 of file GPUdb.hpp.

◆ insertRecords() [4/4]

template<typename TRequest >
InsertRecordsResponse& gpudb::GPUdb::insertRecords ( const std::string &  tableName,
const std::vector< TRequest > &  data,
const std::map< std::string, std::string > &  options,
InsertRecordsResponse response_ 
) const
inline

Adds multiple records to the specified table.

The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Template Parameters
<TRequest>The type of object being added.
Parameters
tableNameTable to which the records are to be added. Must be an existing table.
dataAn array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 13173 of file GPUdb.hpp.

◆ insertRecordsRandom() [1/4]

InsertRecordsRandomResponse gpudb::GPUdb::insertRecordsRandom ( const InsertRecordsRandomRequest request_) const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that a response will not be returned until all random records are fully available.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ insertRecordsRandom() [2/4]

InsertRecordsRandomResponse& gpudb::GPUdb::insertRecordsRandom ( const InsertRecordsRandomRequest request_,
InsertRecordsRandomResponse response_ 
) const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that a response will not be returned until all random records are fully available.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ insertRecordsRandom() [3/4]

InsertRecordsRandomResponse gpudb::GPUdb::insertRecordsRandom ( const std::string &  tableName,
const int64_t  count,
const std::map< std::string, std::map< std::string, double > > &  options 
) const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that a response will not be returned until all random records are fully available.

Parameters
tableNameTable to which random records will be added. Must be an existing table. Also, must be an individual table, not a collection of tables, nor a view of a table.
countNumber of records to generate.
optionsOptional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map:
  • gpudb::insert_records_random_seed: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }
  • gpudb::insert_records_random_all: This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.
    • gpudb::insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [0, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [0, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
    • gpudb::insert_records_random_null_percentage: If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
    • gpudb::insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
  • gpudb::insert_records_random_attr_name: Use the desired column name in place of attr_name, and set the following parameters for the column specified. This overrides any parameter set by all.
    • gpudb::insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [0, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [0, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
    • gpudb::insert_records_random_null_percentage: If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
    • gpudb::insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
  • gpudb::insert_records_random_track_length: This key-map pair is only valid for track data sets (an error is thrown otherwise). No nulls would be generated for nullable columns.
    • gpudb::insert_records_random_min: Minimum possible length for generated series; default is 100 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max.
    • gpudb::insert_records_random_max: Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min.
Returns
Response object containing the result of the operation.

◆ insertRecordsRandom() [4/4]

InsertRecordsRandomResponse& gpudb::GPUdb::insertRecordsRandom ( const std::string &  tableName,
const int64_t  count,
const std::map< std::string, std::map< std::string, double > > &  options,
InsertRecordsRandomResponse response_ 
) const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that a response will not be returned until all random records are fully available.

Parameters
tableNameTable to which random records will be added. Must be an existing table. Also, must be an individual table, not a collection of tables, nor a view of a table.
countNumber of records to generate.
optionsOptional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map:
  • gpudb::insert_records_random_seed: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }
  • gpudb::insert_records_random_all: This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.
    • gpudb::insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [0, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [0, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
    • gpudb::insert_records_random_null_percentage: If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
    • gpudb::insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
  • gpudb::insert_records_random_attr_name: Use the desired column name in place of attr_name, and set the following parameters for the column specified. This overrides any parameter set by all.
    • gpudb::insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [0, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [0, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    • gpudb::insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
    • gpudb::insert_records_random_null_percentage: If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
    • gpudb::insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
  • gpudb::insert_records_random_track_length: This key-map pair is only valid for track data sets (an error is thrown otherwise). No nulls would be generated for nullable columns.
    • gpudb::insert_records_random_min: Minimum possible length for generated series; default is 100 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max.
    • gpudb::insert_records_random_max: Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ insertRecordsRaw() [1/2]

InsertRecordsResponse gpudb::GPUdb::insertRecordsRaw ( const RawInsertRecordsRequest request_) const

Adds multiple records to the specified table.

The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ insertRecordsRaw() [2/2]

InsertRecordsResponse& gpudb::GPUdb::insertRecordsRaw ( const RawInsertRecordsRequest request_,
InsertRecordsResponse response_ 
) const

Adds multiple records to the specified table.

The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.

The options parameter can be used to customize this function's behavior.

The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.

The return_record_ids option indicates that the database should return the unique identifiers of inserted records.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ insertSymbol() [1/4]

InsertSymbolResponse gpudb::GPUdb::insertSymbol ( const InsertSymbolRequest request_) const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ insertSymbol() [2/4]

InsertSymbolResponse& gpudb::GPUdb::insertSymbol ( const InsertSymbolRequest request_,
InsertSymbolResponse response_ 
) const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ insertSymbol() [3/4]

InsertSymbolResponse gpudb::GPUdb::insertSymbol ( const std::string &  symbolId,
const std::string &  symbolFormat,
const std::vector< uint8_t > &  symbolData,
const std::map< std::string, std::string > &  options 
) const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Parameters
symbolIdThe id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
symbolFormatSpecifies the symbol format. Must be either 'svg' or 'svg_path'.
symbolDataThe actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'
optionsOptional parameters.
  • gpudb::insert_symbol_color: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
Returns
Response object containing the result of the operation.

◆ insertSymbol() [4/4]

InsertSymbolResponse& gpudb::GPUdb::insertSymbol ( const std::string &  symbolId,
const std::string &  symbolFormat,
const std::vector< uint8_t > &  symbolData,
const std::map< std::string, std::string > &  options,
InsertSymbolResponse response_ 
) const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.

Parameters
symbolIdThe id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
symbolFormatSpecifies the symbol format. Must be either 'svg' or 'svg_path'.
symbolDataThe actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'
optionsOptional parameters.
  • gpudb::insert_symbol_color: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ killProc() [1/4]

KillProcResponse gpudb::GPUdb::killProc ( const KillProcRequest request_) const

Kills a running proc instance.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ killProc() [2/4]

KillProcResponse& gpudb::GPUdb::killProc ( const KillProcRequest request_,
KillProcResponse response_ 
) const

Kills a running proc instance.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ killProc() [3/4]

KillProcResponse gpudb::GPUdb::killProc ( const std::string &  runId,
const std::map< std::string, std::string > &  options 
) const

Kills a running proc instance.

Parameters
runIdThe run ID of the running proc instance. If the run ID is not found or the proc instance has already completed, this does nothing. If not specified, all running proc instances will be killed.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ killProc() [4/4]

KillProcResponse& gpudb::GPUdb::killProc ( const std::string &  runId,
const std::map< std::string, std::string > &  options,
KillProcResponse response_ 
) const

Kills a running proc instance.

Parameters
runIdThe run ID of the running proc instance. If the run ID is not found or the proc instance has already completed, this does nothing. If not specified, all running proc instances will be killed.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ lockTable() [1/4]

LockTableResponse gpudb::GPUdb::lockTable ( const LockTableRequest request_) const

Manages global access to a table's data.

By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ lockTable() [2/4]

LockTableResponse& gpudb::GPUdb::lockTable ( const LockTableRequest request_,
LockTableResponse response_ 
) const

Manages global access to a table's data.

By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ lockTable() [3/4]

LockTableResponse gpudb::GPUdb::lockTable ( const std::string &  tableName,
const std::string &  lockType,
const std::map< std::string, std::string > &  options 
) const

Manages global access to a table's data.

By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters
tableNameName of the table to be locked. It must be a currently existing table, collection, or view.
lockTypeThe type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. The default value is gpudb::lock_table_status.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ lockTable() [4/4]

LockTableResponse& gpudb::GPUdb::lockTable ( const std::string &  tableName,
const std::string &  lockType,
const std::map< std::string, std::string > &  options,
LockTableResponse response_ 
) const

Manages global access to a table's data.

By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters
tableNameName of the table to be locked. It must be a currently existing table, collection, or view.
lockTypeThe type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. The default value is gpudb::lock_table_status.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ mergeRecords() [1/4]

MergeRecordsResponse gpudb::GPUdb::mergeRecords ( const MergeRecordsRequest request_) const

Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).

For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.

The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ mergeRecords() [2/4]

MergeRecordsResponse& gpudb::GPUdb::mergeRecords ( const MergeRecordsRequest request_,
MergeRecordsResponse response_ 
) const

Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).

For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.

The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ mergeRecords() [3/4]

MergeRecordsResponse gpudb::GPUdb::mergeRecords ( const std::string &  tableName,
const std::vector< std::string > &  sourceTableNames,
const std::vector< std::map< std::string, std::string > > &  fieldMaps,
const std::map< std::string, std::string > &  options 
) const

Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).

For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.

The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.

Parameters
tableNameThe new result table name for the records to be merged. Must NOT be an existing table.
sourceTableNamesThe list of source table names to get the records from. Must be existing table names.
fieldMapsContains a list of source/target column mappings, one mapping for each source table listed in sourceTableNames being merged into the target table specified by tableName. Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ mergeRecords() [4/4]

MergeRecordsResponse& gpudb::GPUdb::mergeRecords ( const std::string &  tableName,
const std::vector< std::string > &  sourceTableNames,
const std::vector< std::map< std::string, std::string > > &  fieldMaps,
const std::map< std::string, std::string > &  options,
MergeRecordsResponse response_ 
) const

Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).

For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.

The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.

Parameters
tableNameThe new result table name for the records to be merged. Must NOT be an existing table.
sourceTableNamesThe list of source table names to get the records from. Must be existing table names.
fieldMapsContains a list of source/target column mappings, one mapping for each source table listed in sourceTableNames being merged into the target table specified by tableName. Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ revokePermissionSystem() [1/4]

RevokePermissionSystemResponse gpudb::GPUdb::revokePermissionSystem ( const RevokePermissionSystemRequest request_) const

Revokes a system-level permission from a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ revokePermissionSystem() [2/4]

RevokePermissionSystemResponse& gpudb::GPUdb::revokePermissionSystem ( const RevokePermissionSystemRequest request_,
RevokePermissionSystemResponse response_ 
) const

Revokes a system-level permission from a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ revokePermissionSystem() [3/4]

RevokePermissionSystemResponse gpudb::GPUdb::revokePermissionSystem ( const std::string &  name,
const std::string &  permission,
const std::map< std::string, std::string > &  options 
) const

Revokes a system-level permission from a user or role.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from the user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ revokePermissionSystem() [4/4]

RevokePermissionSystemResponse& gpudb::GPUdb::revokePermissionSystem ( const std::string &  name,
const std::string &  permission,
const std::map< std::string, std::string > &  options,
RevokePermissionSystemResponse response_ 
) const

Revokes a system-level permission from a user or role.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from the user or role.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ revokePermissionTable() [1/4]

RevokePermissionTableResponse gpudb::GPUdb::revokePermissionTable ( const RevokePermissionTableRequest request_) const

Revokes a table-level permission from a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ revokePermissionTable() [2/4]

RevokePermissionTableResponse& gpudb::GPUdb::revokePermissionTable ( const RevokePermissionTableRequest request_,
RevokePermissionTableResponse response_ 
) const

Revokes a table-level permission from a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ revokePermissionTable() [3/4]

RevokePermissionTableResponse gpudb::GPUdb::revokePermissionTable ( const std::string &  name,
const std::string &  permission,
const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Revokes a table-level permission from a user or role.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from the user or role.
tableNameName of the table to which the permission grants access. Must be an existing table, collection, or view.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ revokePermissionTable() [4/4]

RevokePermissionTableResponse& gpudb::GPUdb::revokePermissionTable ( const std::string &  name,
const std::string &  permission,
const std::string &  tableName,
const std::map< std::string, std::string > &  options,
RevokePermissionTableResponse response_ 
) const

Revokes a table-level permission from a user or role.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from the user or role.
tableNameName of the table to which the permission grants access. Must be an existing table, collection, or view.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ revokeRole() [1/4]

RevokeRoleResponse gpudb::GPUdb::revokeRole ( const RevokeRoleRequest request_) const

Revokes membership in a role from a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ revokeRole() [2/4]

RevokeRoleResponse& gpudb::GPUdb::revokeRole ( const RevokeRoleRequest request_,
RevokeRoleResponse response_ 
) const

Revokes membership in a role from a user or role.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ revokeRole() [3/4]

RevokeRoleResponse gpudb::GPUdb::revokeRole ( const std::string &  role,
const std::string &  member,
const std::map< std::string, std::string > &  options 
) const

Revokes membership in a role from a user or role.

Parameters
roleName of the role in which membership will be revoked. Must be an existing role.
memberName of the user or role that will be revoked membership in role. Must be an existing user or role.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ revokeRole() [4/4]

RevokeRoleResponse& gpudb::GPUdb::revokeRole ( const std::string &  role,
const std::string &  member,
const std::map< std::string, std::string > &  options,
RevokeRoleResponse response_ 
) const

Revokes membership in a role from a user or role.

Parameters
roleName of the role in which membership will be revoked. Must be an existing role.
memberName of the user or role that will be revoked membership in role. Must be an existing user or role.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showProc() [1/4]

ShowProcResponse gpudb::GPUdb::showProc ( const ShowProcRequest request_) const

Shows information about a proc.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showProc() [2/4]

ShowProcResponse& gpudb::GPUdb::showProc ( const ShowProcRequest request_,
ShowProcResponse response_ 
) const

Shows information about a proc.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showProc() [3/4]

ShowProcResponse gpudb::GPUdb::showProc ( const std::string &  procName,
const std::map< std::string, std::string > &  options 
) const

Shows information about a proc.

Parameters
procNameName of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showProc() [4/4]

ShowProcResponse& gpudb::GPUdb::showProc ( const std::string &  procName,
const std::map< std::string, std::string > &  options,
ShowProcResponse response_ 
) const

Shows information about a proc.

Parameters
procNameName of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showProcStatus() [1/4]

ShowProcStatusResponse gpudb::GPUdb::showProcStatus ( const ShowProcStatusRequest request_) const

Shows the statuses of running or completed proc instances.

Results are grouped by run ID (as returned from executeProc(const ExecuteProcRequest&) const) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showProcStatus() [2/4]

ShowProcStatusResponse& gpudb::GPUdb::showProcStatus ( const ShowProcStatusRequest request_,
ShowProcStatusResponse response_ 
) const

Shows the statuses of running or completed proc instances.

Results are grouped by run ID (as returned from executeProc(const ExecuteProcRequest&,ExecuteProcResponse&) const) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showProcStatus() [3/4]

ShowProcStatusResponse gpudb::GPUdb::showProcStatus ( const std::string &  runId,
const std::map< std::string, std::string > &  options 
) const

Shows the statuses of running or completed proc instances.

Results are grouped by run ID (as returned from executeProc(const std::string&,const std::map<std::string, std::string>&,const std::map<std::string, std::vector<uint8_t> >&,const std::vector<std::string>&,const std::map<std::string, std::vector<std::string> >&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Parameters
runIdThe run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showProcStatus() [4/4]

ShowProcStatusResponse& gpudb::GPUdb::showProcStatus ( const std::string &  runId,
const std::map< std::string, std::string > &  options,
ShowProcStatusResponse response_ 
) const

Shows the statuses of running or completed proc instances.

Results are grouped by run ID (as returned from executeProc(const std::string&,const std::map<std::string, std::string>&,const std::map<std::string, std::vector<uint8_t> >&,const std::vector<std::string>&,const std::map<std::string, std::vector<std::string> >&,const std::vector<std::string>&,const std::map<std::string, std::string>&,ExecuteProcResponse&) const) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).

Parameters
runIdThe run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSecurity() [1/4]

ShowSecurityResponse gpudb::GPUdb::showSecurity ( const ShowSecurityRequest request_) const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showSecurity() [2/4]

ShowSecurityResponse& gpudb::GPUdb::showSecurity ( const ShowSecurityRequest request_,
ShowSecurityResponse response_ 
) const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSecurity() [3/4]

ShowSecurityResponse gpudb::GPUdb::showSecurity ( const std::vector< std::string > &  names,
const std::map< std::string, std::string > &  options 
) const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters
namesA list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showSecurity() [4/4]

ShowSecurityResponse& gpudb::GPUdb::showSecurity ( const std::vector< std::string > &  names,
const std::map< std::string, std::string > &  options,
ShowSecurityResponse response_ 
) const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters
namesA list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSystemProperties() [1/4]

ShowSystemPropertiesResponse gpudb::GPUdb::showSystemProperties ( const ShowSystemPropertiesRequest request_) const

Returns server configuration and version related information to the caller.

The admin tool uses it to present server related information to the user.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showSystemProperties() [2/4]

ShowSystemPropertiesResponse& gpudb::GPUdb::showSystemProperties ( const ShowSystemPropertiesRequest request_,
ShowSystemPropertiesResponse response_ 
) const

Returns server configuration and version related information to the caller.

The admin tool uses it to present server related information to the user.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSystemProperties() [3/4]

ShowSystemPropertiesResponse gpudb::GPUdb::showSystemProperties ( const std::map< std::string, std::string > &  options) const

Returns server configuration and version related information to the caller.

The admin tool uses it to present server related information to the user.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showSystemProperties() [4/4]

ShowSystemPropertiesResponse& gpudb::GPUdb::showSystemProperties ( const std::map< std::string, std::string > &  options,
ShowSystemPropertiesResponse response_ 
) const

Returns server configuration and version related information to the caller.

The admin tool uses it to present server related information to the user.

Parameters
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSystemStatus() [1/4]

ShowSystemStatusResponse gpudb::GPUdb::showSystemStatus ( const ShowSystemStatusRequest request_) const

Provides server configuration and health related status to the caller.

The admin tool uses it to present server related information to the user.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showSystemStatus() [2/4]

ShowSystemStatusResponse& gpudb::GPUdb::showSystemStatus ( const ShowSystemStatusRequest request_,
ShowSystemStatusResponse response_ 
) const

Provides server configuration and health related status to the caller.

The admin tool uses it to present server related information to the user.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSystemStatus() [3/4]

ShowSystemStatusResponse gpudb::GPUdb::showSystemStatus ( const std::map< std::string, std::string > &  options) const

Provides server configuration and health related status to the caller.

The admin tool uses it to present server related information to the user.

Parameters
optionsOptional parameters, currently unused.
Returns
Response object containing the result of the operation.

◆ showSystemStatus() [4/4]

ShowSystemStatusResponse& gpudb::GPUdb::showSystemStatus ( const std::map< std::string, std::string > &  options,
ShowSystemStatusResponse response_ 
) const

Provides server configuration and health related status to the caller.

The admin tool uses it to present server related information to the user.

Parameters
optionsOptional parameters, currently unused.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSystemTiming() [1/4]

ShowSystemTimingResponse gpudb::GPUdb::showSystemTiming ( const ShowSystemTimingRequest request_) const

Returns the last 100 database requests along with the request timing and internal job id.

The admin tool uses it to present request timing information to the user.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showSystemTiming() [2/4]

ShowSystemTimingResponse& gpudb::GPUdb::showSystemTiming ( const ShowSystemTimingRequest request_,
ShowSystemTimingResponse response_ 
) const

Returns the last 100 database requests along with the request timing and internal job id.

The admin tool uses it to present request timing information to the user.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showSystemTiming() [3/4]

ShowSystemTimingResponse gpudb::GPUdb::showSystemTiming ( const std::map< std::string, std::string > &  options) const

Returns the last 100 database requests along with the request timing and internal job id.

The admin tool uses it to present request timing information to the user.

Parameters
optionsOptional parameters, currently unused.
Returns
Response object containing the result of the operation.

◆ showSystemTiming() [4/4]

ShowSystemTimingResponse& gpudb::GPUdb::showSystemTiming ( const std::map< std::string, std::string > &  options,
ShowSystemTimingResponse response_ 
) const

Returns the last 100 database requests along with the request timing and internal job id.

The admin tool uses it to present request timing information to the user.

Parameters
optionsOptional parameters, currently unused.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTable() [1/4]

ShowTableResponse gpudb::GPUdb::showTable ( const ShowTableRequest request_) const

Retrieves detailed information about tables, views, and collections.

If tableName specifies a table or view, information specific to that entity will be returned.

If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).

If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.

If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showTable() [2/4]

ShowTableResponse& gpudb::GPUdb::showTable ( const ShowTableRequest request_,
ShowTableResponse response_ 
) const

Retrieves detailed information about tables, views, and collections.

If tableName specifies a table or view, information specific to that entity will be returned.

If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).

If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.

If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTable() [3/4]

ShowTableResponse gpudb::GPUdb::showTable ( const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Retrieves detailed information about tables, views, and collections.

If tableName specifies a table or view, information specific to that entity will be returned.

If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).

If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.

If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

Parameters
tableNameName of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showTable() [4/4]

ShowTableResponse& gpudb::GPUdb::showTable ( const std::string &  tableName,
const std::map< std::string, std::string > &  options,
ShowTableResponse response_ 
) const

Retrieves detailed information about tables, views, and collections.

If tableName specifies a table or view, information specific to that entity will be returned.

If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).

If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.

If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.

If the option get_sizes is set to true, then the sizes (objects and elements) of each table are returned (in sizes and fullSizes), along with the total number of objects in the requested table (in totalSize and totalFullSize).

Parameters
tableNameName of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTableMetadata() [1/4]

ShowTableMetadataResponse gpudb::GPUdb::showTableMetadata ( const ShowTableMetadataRequest request_) const

Retrieves the user provided metadata for the specified tables.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showTableMetadata() [2/4]

ShowTableMetadataResponse& gpudb::GPUdb::showTableMetadata ( const ShowTableMetadataRequest request_,
ShowTableMetadataResponse response_ 
) const

Retrieves the user provided metadata for the specified tables.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTableMetadata() [3/4]

ShowTableMetadataResponse gpudb::GPUdb::showTableMetadata ( const std::vector< std::string > &  tableNames,
const std::map< std::string, std::string > &  options 
) const

Retrieves the user provided metadata for the specified tables.

Parameters
tableNamesTables whose metadata will be fetched. All provided tables must exist, or an error is returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showTableMetadata() [4/4]

ShowTableMetadataResponse& gpudb::GPUdb::showTableMetadata ( const std::vector< std::string > &  tableNames,
const std::map< std::string, std::string > &  options,
ShowTableMetadataResponse response_ 
) const

Retrieves the user provided metadata for the specified tables.

Parameters
tableNamesTables whose metadata will be fetched. All provided tables must exist, or an error is returned.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTablesByType() [1/4]

ShowTablesByTypeResponse gpudb::GPUdb::showTablesByType ( const ShowTablesByTypeRequest request_) const

Gets names of the tables whose type matches the given criteria.

Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showTablesByType() [2/4]

ShowTablesByTypeResponse& gpudb::GPUdb::showTablesByType ( const ShowTablesByTypeRequest request_,
ShowTablesByTypeResponse response_ 
) const

Gets names of the tables whose type matches the given criteria.

Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTablesByType() [3/4]

ShowTablesByTypeResponse gpudb::GPUdb::showTablesByType ( const std::string &  typeId,
const std::string &  label,
const std::map< std::string, std::string > &  options 
) const

Gets names of the tables whose type matches the given criteria.

Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters
typeIdType id returned by a call to /create/type.
labelOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showTablesByType() [4/4]

ShowTablesByTypeResponse& gpudb::GPUdb::showTablesByType ( const std::string &  typeId,
const std::string &  label,
const std::map< std::string, std::string > &  options,
ShowTablesByTypeResponse response_ 
) const

Gets names of the tables whose type matches the given criteria.

Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters
typeIdType id returned by a call to /create/type.
labelOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTriggers() [1/4]

ShowTriggersResponse gpudb::GPUdb::showTriggers ( const ShowTriggersRequest request_) const

Retrieves information regarding the specified triggers or all existing triggers currently active.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showTriggers() [2/4]

ShowTriggersResponse& gpudb::GPUdb::showTriggers ( const ShowTriggersRequest request_,
ShowTriggersResponse response_ 
) const

Retrieves information regarding the specified triggers or all existing triggers currently active.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTriggers() [3/4]

ShowTriggersResponse gpudb::GPUdb::showTriggers ( const std::vector< std::string > &  triggerIds,
const std::map< std::string, std::string > &  options 
) const

Retrieves information regarding the specified triggers or all existing triggers currently active.

Parameters
triggerIdsList of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showTriggers() [4/4]

ShowTriggersResponse& gpudb::GPUdb::showTriggers ( const std::vector< std::string > &  triggerIds,
const std::map< std::string, std::string > &  options,
ShowTriggersResponse response_ 
) const

Retrieves information regarding the specified triggers or all existing triggers currently active.

Parameters
triggerIdsList of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTypes() [1/4]

ShowTypesResponse gpudb::GPUdb::showTypes ( const ShowTypesRequest request_) const

Retrieves information for the specified data type ID or type label.

For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ showTypes() [2/4]

ShowTypesResponse& gpudb::GPUdb::showTypes ( const ShowTypesRequest request_,
ShowTypesResponse response_ 
) const

Retrieves information for the specified data type ID or type label.

For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ showTypes() [3/4]

ShowTypesResponse gpudb::GPUdb::showTypes ( const std::string &  typeId,
const std::string &  label,
const std::map< std::string, std::string > &  options 
) const

Retrieves information for the specified data type ID or type label.

For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Parameters
typeIdType Id returned in response to a call to /create/type.
labelOption string that was supplied by user in a call to /create/type.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ showTypes() [4/4]

ShowTypesResponse& gpudb::GPUdb::showTypes ( const std::string &  typeId,
const std::string &  label,
const std::map< std::string, std::string > &  options,
ShowTypesResponse response_ 
) const

Retrieves information for the specified data type ID or type label.

For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Parameters
typeIdType Id returned in response to a call to /create/type.
labelOption string that was supplied by user in a call to /create/type.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ submitRequest() [1/3]

template<typename TRequest , typename TResponse >
TResponse& gpudb::GPUdb::submitRequest ( const HttpUrl url,
const TRequest &  request,
TResponse &  response,
const bool  enableCompression = false 
) const
inline

Definition at line 139 of file GPUdb.hpp.

◆ submitRequest() [2/3]

template<typename TRequest , typename TResponse >
TResponse& gpudb::GPUdb::submitRequest ( const std::string &  endpoint,
const TRequest &  request,
TResponse &  response,
const bool  enableCompression = false 
) const
inline

Definition at line 153 of file GPUdb.hpp.

◆ submitRequest() [3/3]

template<typename TRequest , typename TResponse >
TResponse& gpudb::GPUdb::submitRequest ( const char *  endpoint,
const TRequest &  request,
TResponse &  response,
const bool  enableCompression = false 
) const
inline

Definition at line 167 of file GPUdb.hpp.

◆ submitRequestToHostManager() [1/2]

template<typename TRequest , typename TResponse >
TResponse& gpudb::GPUdb::submitRequestToHostManager ( const std::string &  endpoint,
const TRequest &  request,
TResponse &  response,
const bool  enableCompression = false 
) const
inline

Submit an HTTP request to the host manager.

Parameters
[in]endpointThe endpoint for which the request is made.
[in]requestThe request object containing the parameters for the operation.
[out]responseThe response object in which the return values will be saved.
[in]enableCompressionOptional boolean flag indicating whether any compression should be used. Default is false.
Returns
a reference to the response object.

Definition at line 191 of file GPUdb.hpp.

◆ submitRequestToHostManager() [2/2]

template<typename TRequest , typename TResponse >
TResponse& gpudb::GPUdb::submitRequestToHostManager ( const char *  endpoint,
const TRequest &  request,
TResponse &  response,
const bool  enableCompression = false 
) const
inline

Submit an HTTP request to the host manager.

Parameters
[in]endpointThe endpoint for which the request is made.
[in]requestThe request object containing the parameters for the operation.
[out]responseThe response object in which the return values will be saved.
[in]enableCompressionOptional boolean flag indicating whether any compression should be used. Default is false.
Returns
a reference to the response object.

Definition at line 220 of file GPUdb.hpp.

◆ updateHostManagerPort()

void gpudb::GPUdb::updateHostManagerPort ( )

Update the host manager port by inquiring the server.

◆ updateRecords() [1/4]

template<typename TRequest >
UpdateRecordsResponse gpudb::GPUdb::updateRecords ( const UpdateRecordsRequest< TRequest > &  request_) const
inline

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Template Parameters
<TRequest>The type of object being added.
Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 15521 of file GPUdb.hpp.

◆ updateRecords() [2/4]

template<typename TRequest >
UpdateRecordsResponse& gpudb::GPUdb::updateRecords ( const UpdateRecordsRequest< TRequest > &  request_,
UpdateRecordsResponse response_ 
) const
inline

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Template Parameters
<TRequest>The type of object being added.
Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 15568 of file GPUdb.hpp.

◆ updateRecords() [3/4]

template<typename TRequest >
UpdateRecordsResponse gpudb::GPUdb::updateRecords ( const std::string &  tableName,
const std::vector< std::string > &  expressions,
const std::vector< std::map< std::string, boost::optional< std::string > > > &  newValuesMaps,
const std::vector< TRequest > &  data,
const std::map< std::string, std::string > &  options 
) const
inline

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Template Parameters
<TRequest>The type of object being added.
Parameters
tableNameTable to be updated. Must be a currently existing table and not a collection or view.
expressionsA list of the actual predicates, one for each update; format should follow the guidelines /filter.
newValuesMapsList of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
dataAn optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 15668 of file GPUdb.hpp.

◆ updateRecords() [4/4]

template<typename TRequest >
UpdateRecordsResponse& gpudb::GPUdb::updateRecords ( const std::string &  tableName,
const std::vector< std::string > &  expressions,
const std::vector< std::map< std::string, boost::optional< std::string > > > &  newValuesMaps,
const std::vector< TRequest > &  data,
const std::map< std::string, std::string > &  options,
UpdateRecordsResponse response_ 
) const
inline

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Template Parameters
<TRequest>The type of object being added.
Parameters
tableNameTable to be updated. Must be a currently existing table and not a collection or view.
expressionsA list of the actual predicates, one for each update; format should follow the guidelines /filter.
newValuesMapsList of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
dataAn optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Definition at line 15775 of file GPUdb.hpp.

◆ updateRecordsBySeries() [1/4]

UpdateRecordsBySeriesResponse gpudb::GPUdb::updateRecordsBySeries ( const UpdateRecordsBySeriesRequest request_) const

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

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ updateRecordsBySeries() [2/4]

UpdateRecordsBySeriesResponse& gpudb::GPUdb::updateRecordsBySeries ( const UpdateRecordsBySeriesRequest request_,
UpdateRecordsBySeriesResponse response_ 
) const

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

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ updateRecordsBySeries() [3/4]

UpdateRecordsBySeriesResponse gpudb::GPUdb::updateRecordsBySeries ( 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 
) const

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

Parameters
tableNameName of the view on which the update operation will be performed. Must be an existing view.
worldTableNameName of the table containing the complete series (track) information.
viewNameOptional name of the view containing the series (tracks) which have to be updated.
reserved
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ updateRecordsBySeries() [4/4]

UpdateRecordsBySeriesResponse& gpudb::GPUdb::updateRecordsBySeries ( 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,
UpdateRecordsBySeriesResponse response_ 
) const

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

Parameters
tableNameName of the view on which the update operation will be performed. Must be an existing view.
worldTableNameName of the table containing the complete series (track) information.
viewNameOptional name of the view containing the series (tracks) which have to be updated.
reserved
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ updateRecordsRaw() [1/2]

UpdateRecordsResponse gpudb::GPUdb::updateRecordsRaw ( const RawUpdateRecordsRequest request_) const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ updateRecordsRaw() [2/2]

UpdateRecordsResponse& gpudb::GPUdb::updateRecordsRaw ( const RawUpdateRecordsRequest request_,
UpdateRecordsResponse response_ 
) const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ visualizeImageChart() [1/4]

VisualizeImageChartResponse gpudb::GPUdb::visualizeImageChart ( const VisualizeImageChartRequest request_) const

Scatter plot is the only plot type currently supported.

A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

◆ visualizeImageChart() [2/4]

VisualizeImageChartResponse& gpudb::GPUdb::visualizeImageChart ( const VisualizeImageChartRequest request_,
VisualizeImageChartResponse response_ 
) const

Scatter plot is the only plot type currently supported.

A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

◆ visualizeImageChart() [3/4]

VisualizeImageChartResponse gpudb::GPUdb::visualizeImageChart ( const std::string &  tableName,
const std::vector< std::string > &  xColumnNames,
const std::vector< std::string > &  yColumnNames,
const double  minX,
const double  maxX,
const double  minY,
const double  maxY,
const int32_t  width,
const int32_t  height,
const std::string &  bgColor,
const std::map< std::string, std::vector< std::string > > &  styleOptions,
const std::map< std::string, std::string > &  options 
) const

Scatter plot is the only plot type currently supported.

A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.

Parameters
tableNameName of the table containing the data to be drawn as a chart.
xColumnNamesNames of the columns containing the data mapped to the x axis of a chart.
yColumnNamesNames of the columns containing the data mapped to the y axis of a chart.
minXLower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
maxXUpper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
minYLower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
maxYUpper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
widthWidth of the generated image in pixels.
heightHeight of the generated image in pixels.
bgColorBackground color of the generated image.
styleOptionsRendering style options for a chart.
optionsOptional parameters.
Returns
Response object containing the result of the operation.

◆ visualizeImageChart() [4/4]

VisualizeImageChartResponse& gpudb::GPUdb::visualizeImageChart ( const std::string &  tableName,
const std::vector< std::string > &  xColumnNames,
const std::vector< std::string > &  yColumnNames,
const double  minX,
const double  maxX,
const double  minY,
const double  maxY,
const int32_t  width,
const int32_t  height,
const std::string &  bgColor,
const std::map< std::string, std::vector< std::string > > &  styleOptions,
const std::map< std::string, std::string > &  options,
VisualizeImageChartResponse response_ 
) const

Scatter plot is the only plot type currently supported.

A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.

Parameters
tableNameName of the table containing the data to be drawn as a chart.
xColumnNamesNames of the columns containing the data mapped to the x axis of a chart.
yColumnNamesNames of the columns containing the data mapped to the y axis of a chart.
minXLower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
maxXUpper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
minYLower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
maxYUpper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
widthWidth of the generated image in pixels.
heightHeight of the generated image in pixels.
bgColorBackground color of the generated image.
styleOptionsRendering style options for a chart.
optionsOptional parameters.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

Member Data Documentation

◆ END_OF_SET

const int64_t gpudb::GPUdb::END_OF_SET = -9999
static

Definition at line 108 of file GPUdb.hpp.


The documentation for this class was generated from the following files: