GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GPUdbFunctions.hpp File Reference
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

AdminAddRanksResponse adminAddRanks (const AdminAddRanksRequest &request_) const
 Add one or more new ranks to the Kinetica cluster. More...
 
AdminAddRanksResponse & adminAddRanks (const AdminAddRanksRequest &request_, AdminAddRanksResponse &response_) const
 Add one or more new ranks to the Kinetica cluster. More...
 
AdminAddRanksResponse adminAddRanks (const std::vector< std::string > &hosts, const std::vector< std::map< std::string, std::string > > &configParams, const std::map< std::string, std::string > &options) const
 Add one or more new ranks to the Kinetica cluster. More...
 
AdminAddRanksResponse & adminAddRanks (const std::vector< std::string > &hosts, const std::vector< std::map< std::string, std::string > > &configParams, const std::map< std::string, std::string > &options, AdminAddRanksResponse &response_) const
 Add one or more new ranks to the Kinetica cluster. More...
 
AdminAlterJobsResponse adminAlterJobs (const AdminAlterJobsRequest &request_) const
 Perform the requested action on a list of one or more job(s). More...
 
AdminAlterJobsResponse & adminAlterJobs (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< int64_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...
 
AdminAlterJobsResponse & adminAlterJobs (const std::vector< int64_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...
 
AdminOfflineResponse & adminOffline (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...
 
AdminOfflineResponse & adminOffline (const bool offline, const std::map< std::string, std::string > &options, AdminOfflineResponse &response_) const
 Take the system offline. More...
 
AdminRebalanceResponse adminRebalance (const AdminRebalanceRequest &request_) const
 Rebalance the cluster so that all the nodes contain approximately an equal number of records. More...
 
AdminRebalanceResponse & adminRebalance (const AdminRebalanceRequest &request_, AdminRebalanceResponse &response_) const
 Rebalance the cluster so that all the nodes contain approximately an equal number of records. More...
 
AdminRebalanceResponse adminRebalance (const std::map< std::string, std::string > &options) const
 Rebalance the cluster so that all the nodes contain approximately an equal number of records. More...
 
AdminRebalanceResponse & adminRebalance (const std::map< std::string, std::string > &options, AdminRebalanceResponse &response_) const
 Rebalance the cluster so that all the nodes contain approximately an equal number of records. More...
 
AdminRemoveRanksResponse adminRemoveRanks (const AdminRemoveRanksRequest &request_) const
 Remove one or more ranks from the cluster. More...
 
AdminRemoveRanksResponse & adminRemoveRanks (const AdminRemoveRanksRequest &request_, AdminRemoveRanksResponse &response_) const
 Remove one or more ranks from the cluster. More...
 
AdminRemoveRanksResponse adminRemoveRanks (const std::vector< int32_t > &ranks, const std::map< std::string, std::string > &options) const
 Remove one or more ranks from the cluster. More...
 
AdminRemoveRanksResponse & adminRemoveRanks (const std::vector< int32_t > &ranks, const std::map< std::string, std::string > &options, AdminRemoveRanksResponse &response_) const
 Remove one or more ranks from the cluster. More...
 
AdminShowAlertsResponse adminShowAlerts (const AdminShowAlertsRequest &request_) const
 Requests a list of the most recent alerts. More...
 
AdminShowAlertsResponse & adminShowAlerts (const AdminShowAlertsRequest &request_, AdminShowAlertsResponse &response_) const
 Requests a list of the most recent alerts. More...
 
AdminShowAlertsResponse adminShowAlerts (const int32_t numAlerts, const std::map< std::string, std::string > &options) const
 Requests a list of the most recent alerts. More...
 
AdminShowAlertsResponse & adminShowAlerts (const int32_t numAlerts, const std::map< std::string, std::string > &options, AdminShowAlertsResponse &response_) const
 Requests a list of the most recent alerts. More...
 
AdminShowClusterOperationsResponse adminShowClusterOperations (const AdminShowClusterOperationsRequest &request_) const
 Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex. More...
 
AdminShowClusterOperationsResponse & adminShowClusterOperations (const AdminShowClusterOperationsRequest &request_, AdminShowClusterOperationsResponse &response_) const
 Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex. More...
 
AdminShowClusterOperationsResponse adminShowClusterOperations (const int32_t historyIndex, const std::map< std::string, std::string > &options) const
 Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex. More...
 
AdminShowClusterOperationsResponse & adminShowClusterOperations (const int32_t historyIndex, const std::map< std::string, std::string > &options, AdminShowClusterOperationsResponse &response_) const
 Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex. More...
 
AdminShowJobsResponse adminShowJobs (const AdminShowJobsRequest &request_) const
 Get a list of the current jobs in GPUdb. More...
 
AdminShowJobsResponse & adminShowJobs (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...
 
AdminShowJobsResponse & adminShowJobs (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...
 
AdminShowShardsResponse & adminShowShards (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...
 
AdminShowShardsResponse & adminShowShards (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...
 
AdminShutdownResponse & adminShutdown (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...
 
AdminShutdownResponse & 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. More...
 
AdminVerifyDbResponse adminVerifyDb (const AdminVerifyDbRequest &request_) const
 Verify database is in a consistent state. More...
 
AdminVerifyDbResponse & adminVerifyDb (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...
 
AdminVerifyDbResponse & adminVerifyDb (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...
 
AggregateConvexHullResponse & aggregateConvexHull (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...
 
AggregateConvexHullResponse & 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. More...
 
RawAggregateGroupByResponse aggregateGroupByRaw (const AggregateGroupByRequest &request_) const
 Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination. More...
 
RawAggregateGroupByResponse & aggregateGroupByRaw (const AggregateGroupByRequest &request_, RawAggregateGroupByResponse &response_) const
 Calculates unique combinations (groups) of values for the given columns in a given table or view 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 or view and computes aggregates on each unique combination. More...
 
AggregateGroupByResponse & aggregateGroupBy (const AggregateGroupByRequest &request_, AggregateGroupByResponse &response_) const
 Calculates unique combinations (groups) of values for the given columns in a given table or view 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 or view 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, AggregateGroupByResponse &response_) const
 Calculates unique combinations (groups) of values for the given columns in a given table or view 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...
 
AggregateHistogramResponse & aggregateHistogram (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...
 
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, 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...
 
AggregateKMeansResponse & aggregateKMeans (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...
 
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, 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...
 
AggregateMinMaxResponse & aggregateMinMax (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...
 
AggregateMinMaxResponse & 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. 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...
 
AggregateMinMaxGeometryResponse & 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. 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...
 
AggregateMinMaxGeometryResponse & 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. More...
 
AggregateStatisticsResponse aggregateStatistics (const AggregateStatisticsRequest &request_) const
 Calculates the requested statistics of the given column(s) in a given table. More...
 
AggregateStatisticsResponse & aggregateStatistics (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...
 
AggregateStatisticsResponse & 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. 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...
 
AggregateStatisticsByRangeResponse & 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. 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...
 
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, 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 view (specified by tableName). More...
 
RawAggregateUniqueResponse & aggregateUniqueRaw (const AggregateUniqueRequest &request_, RawAggregateUniqueResponse &response_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 view (specified by tableName). More...
 
AggregateUniqueResponse & aggregateUnique (const AggregateUniqueRequest &request_, AggregateUniqueResponse &response_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 view (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, AggregateUniqueResponse &response_) const
 Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName). More...
 
RawAggregateUnpivotResponse aggregateUnpivotRaw (const AggregateUnpivotRequest &request_) const
 Rotate the column values into rows values. More...
 
RawAggregateUnpivotResponse & aggregateUnpivotRaw (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...
 
AggregateUnpivotResponse & aggregateUnpivot (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...
 
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, AggregateUnpivotResponse &response_) const
 Rotate the column values into rows values. More...
 
AlterResourceGroupResponse alterResourceGroup (const AlterResourceGroupRequest &request_) const
 Alters the properties of an exisiting resource group to facilitate resource management. More...
 
AlterResourceGroupResponse & alterResourceGroup (const AlterResourceGroupRequest &request_, AlterResourceGroupResponse &response_) const
 Alters the properties of an exisiting resource group to facilitate resource management. More...
 
AlterResourceGroupResponse alterResourceGroup (const std::string &name, const std::map< std::string, std::map< std::string, std::string > > &tierAttributes, const std::string &ranking, const std::string &adjoiningResourceGroup, const std::map< std::string, std::string > &options) const
 Alters the properties of an exisiting resource group to facilitate resource management. More...
 
AlterResourceGroupResponse & alterResourceGroup (const std::string &name, const std::map< std::string, std::map< std::string, std::string > > &tierAttributes, const std::string &ranking, const std::string &adjoiningResourceGroup, const std::map< std::string, std::string > &options, AlterResourceGroupResponse &response_) const
 Alters the properties of an exisiting resource group to facilitate resource management. More...
 
AlterRoleResponse alterRole (const AlterRoleRequest &request_) const
 Alters a Role. More...
 
AlterRoleResponse & alterRole (const AlterRoleRequest &request_, AlterRoleResponse &response_) const
 Alters a Role. More...
 
AlterRoleResponse alterRole (const std::string &name, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options) const
 Alters a Role. More...
 
AlterRoleResponse & alterRole (const std::string &name, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options, AlterRoleResponse &response_) const
 Alters a Role. More...
 
AlterSystemPropertiesResponse alterSystemProperties (const AlterSystemPropertiesRequest &request_) const
 The 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 AlterSystemPropertiesRequest &request_, AlterSystemPropertiesResponse &response_) const
 The 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 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, AlterSystemPropertiesResponse &response_) const
 The 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...
 
AlterTableResponse & alterTable (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...
 
AlterTableResponse & 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. More...
 
AlterTableColumnsResponse alterTableColumns (const AlterTableColumnsRequest &request_) const
 Apply various modifications to columns in a table, view. More...
 
AlterTableColumnsResponse & alterTableColumns (const AlterTableColumnsRequest &request_, AlterTableColumnsResponse &response_) const
 Apply various modifications to columns in a table, view. More...
 
AlterTableColumnsResponse alterTableColumns (const std::string &tableName, const std::vector< std::map< std::string, std::string > > &columnAlterations, const std::map< std::string, std::string > &options) const
 Apply various modifications to columns in a table, view. More...
 
AlterTableColumnsResponse & alterTableColumns (const std::string &tableName, const std::vector< std::map< std::string, std::string > > &columnAlterations, const std::map< std::string, std::string > &options, AlterTableColumnsResponse &response_) const
 Apply various modifications to columns in a table, view. More...
 
AlterTableMetadataResponse alterTableMetadata (const AlterTableMetadataRequest &request_) const
 Updates (adds or changes) metadata for tables. More...
 
AlterTableMetadataResponse & alterTableMetadata (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...
 
AlterTableMetadataResponse & 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. More...
 
AlterTierResponse alterTier (const AlterTierRequest &request_) const
 Alters properties of an exisiting tier to facilitate resource management. More...
 
AlterTierResponse & alterTier (const AlterTierRequest &request_, AlterTierResponse &response_) const
 Alters properties of an exisiting tier to facilitate resource management. More...
 
AlterTierResponse alterTier (const std::string &name, const std::map< std::string, std::string > &options) const
 Alters properties of an exisiting tier to facilitate resource management. More...
 
AlterTierResponse & alterTier (const std::string &name, const std::map< std::string, std::string > &options, AlterTierResponse &response_) const
 Alters properties of an exisiting tier to facilitate resource management. More...
 
AlterUserResponse alterUser (const AlterUserRequest &request_) const
 Alters a user. More...
 
AlterUserResponse & alterUser (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...
 
AlterUserResponse & 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. 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...
 
AppendRecordsResponse & 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). 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...
 
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, AppendRecordsResponse &response_) const
 Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). More...
 
ClearStatisticsResponse clearStatistics (const ClearStatisticsRequest &request_) const
 Clears statistics (cardinality, mean value, etc.) for a column in a specified table. More...
 
ClearStatisticsResponse & clearStatistics (const ClearStatisticsRequest &request_, ClearStatisticsResponse &response_) const
 Clears statistics (cardinality, mean value, etc.) for a column in a specified table. More...
 
ClearStatisticsResponse clearStatistics (const std::string &tableName, const std::string &columnName, const std::map< std::string, std::string > &options) const
 Clears statistics (cardinality, mean value, etc.) for a column in a specified table. More...
 
ClearStatisticsResponse & clearStatistics (const std::string &tableName, const std::string &columnName, const std::map< std::string, std::string > &options, ClearStatisticsResponse &response_) const
 Clears statistics (cardinality, mean value, etc.) for a column in a specified table. More...
 
ClearTableResponse clearTable (const ClearTableRequest &request_) const
 Clears (drops) one or all tables in the database cluster. More...
 
ClearTableResponse & clearTable (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...
 
ClearTableResponse & 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. More...
 
ClearTableMonitorResponse clearTableMonitor (const ClearTableMonitorRequest &request_) const
 Deactivates a table monitor previously created with const. More...
 
ClearTableMonitorResponse & clearTableMonitor (const ClearTableMonitorRequest &request_, ClearTableMonitorResponse &response_) const
 Deactivates a table monitor previously created with const. More...
 
ClearTableMonitorResponse clearTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &options) const
 Deactivates a table monitor previously created with const. More...
 
ClearTableMonitorResponse & clearTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &options, ClearTableMonitorResponse &response_) const
 Deactivates a table monitor previously created with const. More...
 
ClearTriggerResponse clearTrigger (const ClearTriggerRequest &request_) const
 Clears or cancels the trigger identified by the specified handle. More...
 
ClearTriggerResponse & clearTrigger (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...
 
ClearTriggerResponse & 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. More...
 
CollectStatisticsResponse collectStatistics (const CollectStatisticsRequest &request_) const
 Collect statistics for a column(s) in a specified table. More...
 
CollectStatisticsResponse & collectStatistics (const CollectStatisticsRequest &request_, CollectStatisticsResponse &response_) const
 Collect statistics for a column(s) in a specified table. More...
 
CollectStatisticsResponse collectStatistics (const std::string &tableName, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options) const
 Collect statistics for a column(s) in a specified table. More...
 
CollectStatisticsResponse & collectStatistics (const std::string &tableName, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options, CollectStatisticsResponse &response_) const
 Collect statistics for a column(s) in a specified table. More...
 
CreateGraphResponse createGraph (const CreateGraphRequest &request_) const
 Creates a new graph network using given nodes, edges, weights, and restrictions. More...
 
CreateGraphResponse & createGraph (const CreateGraphRequest &request_, CreateGraphResponse &response_) const
 Creates a new graph network using given nodes, edges, weights, and restrictions. More...
 
CreateGraphResponse createGraph (const std::string &graphName, const bool directedGraph, const std::vector< std::string > &nodes, const std::vector< std::string > &edges, const std::vector< std::string > &weights, const std::vector< std::string > &restrictions, const std::map< std::string, std::string > &options) const
 Creates a new graph network using given nodes, edges, weights, and restrictions. More...
 
CreateGraphResponse & createGraph (const std::string &graphName, const bool directedGraph, const std::vector< std::string > &nodes, const std::vector< std::string > &edges, const std::vector< std::string > &weights, const std::vector< std::string > &restrictions, const std::map< std::string, std::string > &options, CreateGraphResponse &response_) const
 Creates a new graph network using given nodes, edges, weights, and restrictions. More...
 
CreateJobResponse createJob (const CreateJobRequest &request_) const
 Create a job which will run asynchronously. More...
 
CreateJobResponse & createJob (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...
 
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, 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...
 
CreateJoinTableResponse & createJoinTable (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...
 
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, 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...
 
CreateMaterializedViewResponse & 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. 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...
 
CreateMaterializedViewResponse & 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. 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...
 
CreateProcResponse & 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. 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...
 
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, 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...
 
CreateProjectionResponse & createProjection (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...
 
CreateProjectionResponse & 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. More...
 
CreateResourceGroupResponse createResourceGroup (const CreateResourceGroupRequest &request_) const
 Creates a new resource group to facilitate resource management. More...
 
CreateResourceGroupResponse & createResourceGroup (const CreateResourceGroupRequest &request_, CreateResourceGroupResponse &response_) const
 Creates a new resource group to facilitate resource management. More...
 
CreateResourceGroupResponse createResourceGroup (const std::string &name, const std::map< std::string, std::map< std::string, std::string > > &tierAttributes, const std::string &ranking, const std::string &adjoiningResourceGroup, const std::map< std::string, std::string > &options) const
 Creates a new resource group to facilitate resource management. More...
 
CreateResourceGroupResponse & createResourceGroup (const std::string &name, const std::map< std::string, std::map< std::string, std::string > > &tierAttributes, const std::string &ranking, const std::string &adjoiningResourceGroup, const std::map< std::string, std::string > &options, CreateResourceGroupResponse &response_) const
 Creates a new resource group to facilitate resource management. More...
 
CreateRoleResponse createRole (const CreateRoleRequest &request_) const
 Creates a new role. More...
 
CreateRoleResponse & createRole (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...
 
CreateRoleResponse & createRole (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...
 
CreateTableResponse & createTable (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...
 
CreateTableResponse & 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. More...
 
CreateTableMonitorResponse createTableMonitor (const CreateTableMonitorRequest &request_) const
 Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ. More...
 
CreateTableMonitorResponse & createTableMonitor (const CreateTableMonitorRequest &request_, CreateTableMonitorResponse &response_) const
 Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications 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 a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ. More...
 
CreateTableMonitorResponse & createTableMonitor (const std::string &tableName, const std::map< std::string, std::string > &options, CreateTableMonitorResponse &response_) const
 Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications 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...
 
CreateTriggerByAreaResponse & createTriggerByArea (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...
 
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, 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...
 
CreateTriggerByRangeResponse & createTriggerByRange (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...
 
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, 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...
 
CreateTypeResponse & createType (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...
 
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, 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...
 
CreateUnionResponse & createUnion (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...
 
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, 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...
 
CreateUserExternalResponse & createUserExternal (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...
 
CreateUserExternalResponse & 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). More...
 
CreateUserInternalResponse createUserInternal (const CreateUserInternalRequest &request_) const
 Creates a new internal user (a user whose credentials are managed by the database system). More...
 
CreateUserInternalResponse & createUserInternal (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...
 
CreateUserInternalResponse & 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). More...
 
DeleteGraphResponse deleteGraph (const DeleteGraphRequest &request_) const
 Deletes an existing graph from the graph server and/or persist. More...
 
DeleteGraphResponse & deleteGraph (const DeleteGraphRequest &request_, DeleteGraphResponse &response_) const
 Deletes an existing graph from the graph server and/or persist. More...
 
DeleteGraphResponse deleteGraph (const std::string &graphName, const std::map< std::string, std::string > &options) const
 Deletes an existing graph from the graph server and/or persist. More...
 
DeleteGraphResponse & deleteGraph (const std::string &graphName, const std::map< std::string, std::string > &options, DeleteGraphResponse &response_) const
 Deletes an existing graph from the graph server and/or persist. More...
 
DeleteProcResponse deleteProc (const DeleteProcRequest &request_) const
 Deletes a proc. More...
 
DeleteProcResponse & deleteProc (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...
 
DeleteProcResponse & deleteProc (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...
 
DeleteRecordsResponse & deleteRecords (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...
 
DeleteRecordsResponse & 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. More...
 
DeleteResourceGroupResponse deleteResourceGroup (const DeleteResourceGroupRequest &request_) const
 Deletes a resource group. More...
 
DeleteResourceGroupResponse & deleteResourceGroup (const DeleteResourceGroupRequest &request_, DeleteResourceGroupResponse &response_) const
 Deletes a resource group. More...
 
DeleteResourceGroupResponse deleteResourceGroup (const std::string &name, const std::map< std::string, std::string > &options) const
 Deletes a resource group. More...
 
DeleteResourceGroupResponse & deleteResourceGroup (const std::string &name, const std::map< std::string, std::string > &options, DeleteResourceGroupResponse &response_) const
 Deletes a resource group. More...
 
DeleteRoleResponse deleteRole (const DeleteRoleRequest &request_) const
 Deletes an existing role. More...
 
DeleteRoleResponse & deleteRole (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...
 
DeleteRoleResponse & deleteRole (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...
 
DeleteUserResponse & deleteUser (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...
 
DeleteUserResponse & deleteUser (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...
 
ExecuteProcResponse & executeProc (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...
 
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, ExecuteProcResponse &response_) const
 Executes a proc. More...
 
RawExecuteSqlResponse executeSqlRaw (const ExecuteSqlRequest &request_) const
 SQL Request. More...
 
RawExecuteSqlResponse & executeSqlRaw (const ExecuteSqlRequest &request_, RawExecuteSqlResponse &response_) const
 SQL Request. More...
 
ExecuteSqlResponse executeSql (const ExecuteSqlRequest &request_) const
 SQL Request. More...
 
ExecuteSqlResponse & executeSql (const ExecuteSqlRequest &request_, ExecuteSqlResponse &response_) const
 SQL Request. More...
 
ExecuteSqlResponse executeSql (const std::string &statement, const int64_t offset, const int64_t limit, const std::string &requestSchemaStr, const std::vector< std::vector< uint8_t > > &data, const std::map< std::string, std::string > &options) const
 SQL Request. More...
 
ExecuteSqlResponse & executeSql (const std::string &statement, const int64_t offset, const int64_t limit, const std::string &requestSchemaStr, const std::vector< std::vector< uint8_t > > &data, const std::map< std::string, std::string > &options, ExecuteSqlResponse &response_) const
 SQL Request. More...
 
FilterResponse filter (const FilterRequest &request_) const
 Filters data based on the specified expression. More...
 
FilterResponse & filter (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...
 
FilterResponse & 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. More...
 
FilterByAreaResponse filterByArea (const FilterByAreaRequest &request_) const
 Calculates which objects from a table are within a named area of interest (NAI/polygon). More...
 
FilterByAreaResponse & filterByArea (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...
 
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, 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...
 
FilterByAreaGeometryResponse & filterByAreaGeometry (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...
 
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, 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...
 
FilterByBoxResponse & filterByBox (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...
 
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, 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...
 
FilterByBoxGeometryResponse & filterByBoxGeometry (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...
 
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, 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...
 
FilterByGeometryResponse & filterByGeometry (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...
 
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, 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...
 
FilterByListResponse & filterByList (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...
 
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, 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...
 
FilterByRadiusResponse & 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. 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...
 
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, 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...
 
FilterByRadiusGeometryResponse & 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. 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...
 
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, 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...
 
FilterByRangeResponse & filterByRange (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...
 
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, 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...
 
FilterBySeriesResponse & filterBySeries (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...
 
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, 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...
 
FilterByStringResponse & 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. 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...
 
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, 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...
 
FilterByTableResponse & filterByTable (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...
 
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, 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...
 
FilterByValueResponse & filterByValue (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...
 
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, FilterByValueResponse &response_) const
 Calculates which objects from a table has a particular value for a particular column. More...
 
GetJobResponse getJob (const GetJobRequest &request_) const
 Get the status and result of asynchronously running job. More...
 
GetJobResponse & getJob (const GetJobRequest &request_, GetJobResponse &response_) const
 Get the status and result of asynchronously running job. More...
 
GetJobResponse getJob (const int64_t jobId, const std::map< std::string, std::string > &options) const
 Get the status and result of asynchronously running job. More...
 
GetJobResponse & getJob (const int64_t jobId, const std::map< std::string, std::string > &options, GetJobResponse &response_) const
 Get the status and result of asynchronously running job. More...
 
RawGetRecordsResponse getRecordsRaw (const GetRecordsRequest &request_) const
 Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More...
 
RawGetRecordsResponse & getRecordsRaw (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...
 
RawGetRecordsByColumnResponse & getRecordsByColumnRaw (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...
 
GetRecordsByColumnResponse & getRecordsByColumn (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...
 
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, 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...
 
RawGetRecordsBySeriesResponse & 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. 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...
 
RawGetRecordsFromCollectionResponse & getRecordsFromCollectionRaw (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...
 
GrantPermissionProcResponse grantPermissionProc (const GrantPermissionProcRequest &request_) const
 Grants a proc-level permission to a user or role. More...
 
GrantPermissionProcResponse & grantPermissionProc (const GrantPermissionProcRequest &request_, GrantPermissionProcResponse &response_) const
 Grants a proc-level permission to a user or role. More...
 
GrantPermissionProcResponse grantPermissionProc (const std::string &name, const std::string &permission, const std::string &procName, const std::map< std::string, std::string > &options) const
 Grants a proc-level permission to a user or role. More...
 
GrantPermissionProcResponse & grantPermissionProc (const std::string &name, const std::string &permission, const std::string &procName, const std::map< std::string, std::string > &options, GrantPermissionProcResponse &response_) const
 Grants a proc-level permission to a user or role. More...
 
GrantPermissionSystemResponse grantPermissionSystem (const GrantPermissionSystemRequest &request_) const
 Grants a system-level permission to a user or role. More...
 
GrantPermissionSystemResponse & grantPermissionSystem (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...
 
GrantPermissionSystemResponse & 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. More...
 
GrantPermissionTableResponse grantPermissionTable (const GrantPermissionTableRequest &request_) const
 Grants a table-level permission to a user or role. More...
 
GrantPermissionTableResponse & grantPermissionTable (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...
 
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, 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...
 
GrantRoleResponse & grantRole (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...
 
GrantRoleResponse & 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. More...
 
HasProcResponse hasProc (const HasProcRequest &request_) const
 Checks the existence of a proc with the given name. More...
 
HasProcResponse & hasProc (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...
 
HasProcResponse & 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. More...
 
HasTableResponse hasTable (const HasTableRequest &request_) const
 Checks for the existence of a table with the given name. More...
 
HasTableResponse & hasTable (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...
 
HasTableResponse & 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. More...
 
HasTypeResponse hasType (const HasTypeRequest &request_) const
 Check for the existence of a type. More...
 
HasTypeResponse & hasType (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...
 
HasTypeResponse & hasType (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...
 
InsertRecordsResponse & insertRecordsRaw (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 >
InsertRecordsResponse & insertRecords (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 >
InsertRecordsResponse & insertRecords (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...
 
InsertRecordsFromFilesResponse insertRecordsFromFiles (const InsertRecordsFromFilesRequest &request_) const
 Reads from one or more files located on the server and inserts the data into a new or existing table. More...
 
InsertRecordsFromFilesResponse & insertRecordsFromFiles (const InsertRecordsFromFilesRequest &request_, InsertRecordsFromFilesResponse &response_) const
 Reads from one or more files located on the server and inserts the data into a new or existing table. More...
 
InsertRecordsFromFilesResponse insertRecordsFromFiles (const std::string &tableName, const std::vector< std::string > &filepaths, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options) const
 Reads from one or more files located on the server and inserts the data into a new or existing table. More...
 
InsertRecordsFromFilesResponse & insertRecordsFromFiles (const std::string &tableName, const std::vector< std::string > &filepaths, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options, InsertRecordsFromFilesResponse &response_) const
 Reads from one or more files located on the server and inserts the data into a new or existing table. More...
 
InsertRecordsRandomResponse insertRecordsRandom (const InsertRecordsRandomRequest &request_) const
 Generates a specified number of random records and adds them to the given table. More...
 
InsertRecordsRandomResponse & insertRecordsRandom (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...
 
InsertRecordsRandomResponse & 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. More...
 
InsertSymbolResponse insertSymbol (const InsertSymbolRequest &request_) const
 Adds a symbol or icon (i.e. More...
 
InsertSymbolResponse & insertSymbol (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...
 
InsertSymbolResponse & 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. More...
 
KillProcResponse killProc (const KillProcRequest &request_) const
 Kills a running proc instance. More...
 
KillProcResponse & killProc (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...
 
KillProcResponse & killProc (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...
 
LockTableResponse & lockTable (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...
 
LockTableResponse & 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. More...
 
MatchGraphResponse matchGraph (const MatchGraphRequest &request_) const
 Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type. More...
 
MatchGraphResponse & matchGraph (const MatchGraphRequest &request_, MatchGraphResponse &response_) const
 Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type. More...
 
MatchGraphResponse matchGraph (const std::string &graphName, const std::vector< std::string > &samplePoints, const std::string &solveMethod, const std::string &solutionTable, const std::map< std::string, std::string > &options) const
 Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type. More...
 
MatchGraphResponse & matchGraph (const std::string &graphName, const std::vector< std::string > &samplePoints, const std::string &solveMethod, const std::string &solutionTable, const std::map< std::string, std::string > &options, MatchGraphResponse &response_) const
 Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type. 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...
 
MergeRecordsResponse & 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). 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...
 
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, 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...
 
ModifyGraphResponse modifyGraph (const ModifyGraphRequest &request_) const
 Update an existing graph network using given nodes, edges, weights, restrictions, and options. More...
 
ModifyGraphResponse & modifyGraph (const ModifyGraphRequest &request_, ModifyGraphResponse &response_) const
 Update an existing graph network using given nodes, edges, weights, restrictions, and options. More...
 
ModifyGraphResponse modifyGraph (const std::string &graphName, const std::vector< std::string > &nodes, const std::vector< std::string > &edges, const std::vector< std::string > &weights, const std::vector< std::string > &restrictions, const std::map< std::string, std::string > &options) const
 Update an existing graph network using given nodes, edges, weights, restrictions, and options. More...
 
ModifyGraphResponse & modifyGraph (const std::string &graphName, const std::vector< std::string > &nodes, const std::vector< std::string > &edges, const std::vector< std::string > &weights, const std::vector< std::string > &restrictions, const std::map< std::string, std::string > &options, ModifyGraphResponse &response_) const
 Update an existing graph network using given nodes, edges, weights, restrictions, and options. More...
 
QueryGraphResponse queryGraph (const QueryGraphRequest &request_) const
 Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges. More...
 
QueryGraphResponse & queryGraph (const QueryGraphRequest &request_, QueryGraphResponse &response_) const
 Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges. More...
 
QueryGraphResponse queryGraph (const std::string &graphName, const std::vector< std::string > &queries, const std::vector< std::string > &restrictions, const std::string &adjacencyTable, const int32_t rings, const std::map< std::string, std::string > &options) const
 Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges. More...
 
QueryGraphResponse & queryGraph (const std::string &graphName, const std::vector< std::string > &queries, const std::vector< std::string > &restrictions, const std::string &adjacencyTable, const int32_t rings, const std::map< std::string, std::string > &options, QueryGraphResponse &response_) const
 Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges. More...
 
RevokePermissionProcResponse revokePermissionProc (const RevokePermissionProcRequest &request_) const
 Revokes a proc-level permission from a user or role. More...
 
RevokePermissionProcResponse & revokePermissionProc (const RevokePermissionProcRequest &request_, RevokePermissionProcResponse &response_) const
 Revokes a proc-level permission from a user or role. More...
 
RevokePermissionProcResponse revokePermissionProc (const std::string &name, const std::string &permission, const std::string &procName, const std::map< std::string, std::string > &options) const
 Revokes a proc-level permission from a user or role. More...
 
RevokePermissionProcResponse & revokePermissionProc (const std::string &name, const std::string &permission, const std::string &procName, const std::map< std::string, std::string > &options, RevokePermissionProcResponse &response_) const
 Revokes a proc-level permission from a user or role. More...
 
RevokePermissionSystemResponse revokePermissionSystem (const RevokePermissionSystemRequest &request_) const
 Revokes a system-level permission from a user or role. More...
 
RevokePermissionSystemResponse & revokePermissionSystem (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...
 
RevokePermissionSystemResponse & 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. More...
 
RevokePermissionTableResponse revokePermissionTable (const RevokePermissionTableRequest &request_) const
 Revokes a table-level permission from a user or role. More...
 
RevokePermissionTableResponse & revokePermissionTable (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...
 
RevokePermissionTableResponse & 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. More...
 
RevokeRoleResponse revokeRole (const RevokeRoleRequest &request_) const
 Revokes membership in a role from a user or role. More...
 
RevokeRoleResponse & revokeRole (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...
 
RevokeRoleResponse & 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. More...
 
ShowGraphResponse showGraph (const ShowGraphRequest &request_) const
 Shows information and characteristics of graphs that exist on the graph server. More...
 
ShowGraphResponse & showGraph (const ShowGraphRequest &request_, ShowGraphResponse &response_) const
 Shows information and characteristics of graphs that exist on the graph server. More...
 
ShowGraphResponse showGraph (const std::string &graphName, const std::map< std::string, std::string > &options) const
 Shows information and characteristics of graphs that exist on the graph server. More...
 
ShowGraphResponse & showGraph (const std::string &graphName, const std::map< std::string, std::string > &options, ShowGraphResponse &response_) const
 Shows information and characteristics of graphs that exist on the graph server. More...
 
ShowProcResponse showProc (const ShowProcRequest &request_) const
 Shows information about a proc. More...
 
ShowProcResponse & showProc (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...
 
ShowProcResponse & showProc (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...
 
ShowProcStatusResponse & showProcStatus (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...
 
ShowProcStatusResponse & 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. More...
 
ShowResourceStatisticsResponse showResourceStatistics (const ShowResourceStatisticsRequest &request_) const
 Requests various statistics for storage/memory tiers and resource groups. More...
 
ShowResourceStatisticsResponse & showResourceStatistics (const ShowResourceStatisticsRequest &request_, ShowResourceStatisticsResponse &response_) const
 Requests various statistics for storage/memory tiers and resource groups. More...
 
ShowResourceStatisticsResponse showResourceStatistics (const std::map< std::string, std::string > &options) const
 Requests various statistics for storage/memory tiers and resource groups. More...
 
ShowResourceStatisticsResponse & showResourceStatistics (const std::map< std::string, std::string > &options, ShowResourceStatisticsResponse &response_) const
 Requests various statistics for storage/memory tiers and resource groups. More...
 
ShowResourceGroupsResponse showResourceGroups (const ShowResourceGroupsRequest &request_) const
 Requests resource group properties. More...
 
ShowResourceGroupsResponse & showResourceGroups (const ShowResourceGroupsRequest &request_, ShowResourceGroupsResponse &response_) const
 Requests resource group properties. More...
 
ShowResourceGroupsResponse showResourceGroups (const std::vector< std::string > &names, const std::map< std::string, std::string > &options) const
 Requests resource group properties. More...
 
ShowResourceGroupsResponse & showResourceGroups (const std::vector< std::string > &names, const std::map< std::string, std::string > &options, ShowResourceGroupsResponse &response_) const
 Requests resource group properties. More...
 
ShowSecurityResponse showSecurity (const ShowSecurityRequest &request_) const
 Shows security information relating to users and/or roles. More...
 
ShowSecurityResponse & showSecurity (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...
 
ShowSecurityResponse & 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. More...
 
ShowSqlProcResponse showSqlProc (const ShowSqlProcRequest &request_) const
 Shows information about SQL procedures, including the full definition of each requested procedure. More...
 
ShowSqlProcResponse & showSqlProc (const ShowSqlProcRequest &request_, ShowSqlProcResponse &response_) const
 Shows information about SQL procedures, including the full definition of each requested procedure. More...
 
ShowSqlProcResponse showSqlProc (const std::string &procedureName, const std::map< std::string, std::string > &options) const
 Shows information about SQL procedures, including the full definition of each requested procedure. More...
 
ShowSqlProcResponse & showSqlProc (const std::string &procedureName, const std::map< std::string, std::string > &options, ShowSqlProcResponse &response_) const
 Shows information about SQL procedures, including the full definition of each requested procedure. More...
 
ShowStatisticsResponse showStatistics (const ShowStatisticsRequest &request_) const
 Retrieves the collected column statistics for the specified table. More...
 
ShowStatisticsResponse & showStatistics (const ShowStatisticsRequest &request_, ShowStatisticsResponse &response_) const
 Retrieves the collected column statistics for the specified table. More...
 
ShowStatisticsResponse showStatistics (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options) const
 Retrieves the collected column statistics for the specified table. More...
 
ShowStatisticsResponse & showStatistics (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options, ShowStatisticsResponse &response_) const
 Retrieves the collected column statistics for the specified table. More...
 
ShowSystemPropertiesResponse showSystemProperties (const ShowSystemPropertiesRequest &request_) const
 Returns server configuration and version related information to the caller. More...
 
ShowSystemPropertiesResponse & showSystemProperties (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...
 
ShowSystemPropertiesResponse & showSystemProperties (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...
 
ShowSystemStatusResponse & showSystemStatus (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...
 
ShowSystemStatusResponse & showSystemStatus (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...
 
ShowSystemTimingResponse & showSystemTiming (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...
 
ShowSystemTimingResponse & 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. More...
 
ShowTableResponse showTable (const ShowTableRequest &request_) const
 Retrieves detailed information about a table, view, or collection, specified in tableName. More...
 
ShowTableResponse & showTable (const ShowTableRequest &request_, ShowTableResponse &response_) const
 Retrieves detailed information about a table, view, or collection, specified in tableName. More...
 
ShowTableResponse showTable (const std::string &tableName, const std::map< std::string, std::string > &options) const
 Retrieves detailed information about a table, view, or collection, specified in tableName. More...
 
ShowTableResponse & showTable (const std::string &tableName, const std::map< std::string, std::string > &options, ShowTableResponse &response_) const
 Retrieves detailed information about a table, view, or collection, specified in tableName. More...
 
ShowTableMetadataResponse showTableMetadata (const ShowTableMetadataRequest &request_) const
 Retrieves the user provided metadata for the specified tables. More...
 
ShowTableMetadataResponse & showTableMetadata (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...
 
ShowTableMetadataResponse & 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. More...
 
ShowTablesByTypeResponse showTablesByType (const ShowTablesByTypeRequest &request_) const
 Gets names of the tables whose type matches the given criteria. More...
 
ShowTablesByTypeResponse & showTablesByType (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...
 
ShowTablesByTypeResponse & 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. More...
 
ShowTriggersResponse showTriggers (const ShowTriggersRequest &request_) const
 Retrieves information regarding the specified triggers or all existing triggers currently active. More...
 
ShowTriggersResponse & showTriggers (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...
 
ShowTriggersResponse & 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. More...
 
ShowTypesResponse showTypes (const ShowTypesRequest &request_) const
 Retrieves information for the specified data type ID or type label. More...
 
ShowTypesResponse & showTypes (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...
 
ShowTypesResponse & 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. More...
 
SolveGraphResponse solveGraph (const SolveGraphRequest &request_) const
 Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions. More...
 
SolveGraphResponse & solveGraph (const SolveGraphRequest &request_, SolveGraphResponse &response_) const
 Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions. More...
 
SolveGraphResponse solveGraph (const std::string &graphName, const std::vector< std::string > &weightsOnEdges, const std::vector< std::string > &restrictions, const std::string &solverType, const std::vector< std::string > &sourceNodes, const std::vector< std::string > &destinationNodes, const std::string &solutionTable, const std::map< std::string, std::string > &options) const
 Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions. More...
 
SolveGraphResponse & solveGraph (const std::string &graphName, const std::vector< std::string > &weightsOnEdges, const std::vector< std::string > &restrictions, const std::string &solverType, const std::vector< std::string > &sourceNodes, const std::vector< std::string > &destinationNodes, const std::string &solutionTable, const std::map< std::string, std::string > &options, SolveGraphResponse &response_) const
 Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions. More...
 
UpdateRecordsResponse updateRecordsRaw (const RawUpdateRecordsRequest &request_) const
 Runs multiple predicate-based updates in a single call. More...
 
UpdateRecordsResponse & updateRecordsRaw (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 >
UpdateRecordsResponse & updateRecords (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 >
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, 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...
 
UpdateRecordsBySeriesResponse & 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. 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...
 
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, 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...
 
VisualizeImageChartResponse & visualizeImageChart (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...
 
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, VisualizeImageChartResponse &response_) const
 Scatter plot is the only plot type currently supported. More...
 
VisualizeIsochroneResponse visualizeIsochrone (const VisualizeIsochroneRequest &request_) const
 Generate an image containing isolines for travel results using an existing graph. More...
 
VisualizeIsochroneResponse & visualizeIsochrone (const VisualizeIsochroneRequest &request_, VisualizeIsochroneResponse &response_) const
 Generate an image containing isolines for travel results using an existing graph. More...
 
VisualizeIsochroneResponse visualizeIsochrone (const std::string &graphName, const std::string &sourceNode, const double maxSolutionRadius, const std::vector< std::string > &weightsOnEdges, const std::vector< std::string > &restrictions, const int32_t numLevels, const bool generateImage, const std::string &levelsTable, const std::map< std::string, std::string > &styleOptions, const std::map< std::string, std::string > &solveOptions, const std::map< std::string, std::string > &contourOptions, const std::map< std::string, std::string > &options) const
 Generate an image containing isolines for travel results using an existing graph. More...
 
VisualizeIsochroneResponse & visualizeIsochrone (const std::string &graphName, const std::string &sourceNode, const double maxSolutionRadius, const std::vector< std::string > &weightsOnEdges, const std::vector< std::string > &restrictions, const int32_t numLevels, const bool generateImage, const std::string &levelsTable, const std::map< std::string, std::string > &styleOptions, const std::map< std::string, std::string > &solveOptions, const std::map< std::string, std::string > &contourOptions, const std::map< std::string, std::string > &options, VisualizeIsochroneResponse &response_) const
 Generate an image containing isolines for travel results using an existing graph. More...
 

Function Documentation

AdminAddRanksResponse adminAddRanks ( const AdminAddRanksRequest &  request_) const

Add one or more new ranks to the Kinetica cluster.

The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see const.

For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:

  • hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
  • configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. 'rank.gpu':'1'

This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AdminAddRanksResponse& adminAddRanks ( const AdminAddRanksRequest &  request_,
AdminAddRanksResponse &  response_ 
) const

Add one or more new ranks to the Kinetica cluster.

The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see const.

For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:

  • hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
  • configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. 'rank.gpu':'1'

This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via 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).
AdminAddRanksResponse adminAddRanks ( const std::vector< std::string > &  hosts,
const std::vector< std::map< std::string, std::string > > &  configParams,
const std::map< std::string, std::string > &  options 
) const

Add one or more new ranks to the Kinetica cluster.

The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see const.

For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:

  • hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
  • configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. 'rank.gpu':'1'

This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
hostsThe IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the configParams.
configParamsConfiguration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the hosts. This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default parameters.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AdminAddRanksResponse& adminAddRanks ( const std::vector< std::string > &  hosts,
const std::vector< std::map< std::string, std::string > > &  configParams,
const std::map< std::string, std::string > &  options,
AdminAddRanksResponse &  response_ 
) const

Add one or more new ranks to the Kinetica cluster.

The new ranks will not contain any data initially, other than replicated tables, and not be assigned any shards. To rebalance data across the cluster, which includes shifting some shard key assignments to newly added ranks, see const.

For example, if attempting to add three new ranks (two ranks on host 172.123.45.67 and one rank on host 172.123.45.68) to a Kinetica cluster with additional configuration parameters:

  • hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
  • configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. 'rank.gpu':'1'

This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
hostsThe IP address of each rank being added to the cluster. Insert one entry per rank, even if they are on the same host. The order of the hosts in the array only matters as it relates to the configParams.
configParamsConfiguration parameters to apply to the new ranks, e.g., which GPU to use. Configuration parameters that start with 'rankN.', where N is the rank number, should omit the N, as the new rank number(s) are not allocated until the ranks are created. Each entry in this array corresponds to the entry at the same array index in the hosts. This array must either be completely empty or have the same number of elements as the hosts array. An empty array will result in the new ranks being set only with default 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).
AdminAlterJobsResponse 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.
AdminAlterJobsResponse& 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).
AdminAlterJobsResponse adminAlterJobs ( const std::vector< int64_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.
AdminAlterJobsResponse& adminAlterJobs ( const std::vector< int64_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).
AdminOfflineResponse 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.
AdminOfflineResponse& 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).
AdminOfflineResponse 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.
AdminOfflineResponse& 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).
AdminRebalanceResponse adminRebalance ( const AdminRebalanceRequest &  request_) const

Rebalance the cluster so that all the nodes contain approximately an equal number of records.

The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.

This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AdminRebalanceResponse& adminRebalance ( const AdminRebalanceRequest &  request_,
AdminRebalanceResponse &  response_ 
) const

Rebalance the cluster so that all the nodes contain approximately an equal number of records.

The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.

This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via 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).
AdminRebalanceResponse adminRebalance ( const std::map< std::string, std::string > &  options) const

Rebalance the cluster so that all the nodes contain approximately an equal number of records.

The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.

This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AdminRebalanceResponse& adminRebalance ( const std::map< std::string, std::string > &  options,
AdminRebalanceResponse &  response_ 
) const

Rebalance the cluster so that all the nodes contain approximately an equal number of records.

The rebalance will also cause the shards to be equally distributed (as much as possible) across all the ranks.

This endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

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).
AdminRemoveRanksResponse adminRemoveRanks ( const AdminRemoveRanksRequest &  request_) const

Remove one or more ranks from the cluster.

All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.

Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AdminRemoveRanksResponse& adminRemoveRanks ( const AdminRemoveRanksRequest &  request_,
AdminRemoveRanksResponse &  response_ 
) const

Remove one or more ranks from the cluster.

All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.

Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via 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).
AdminRemoveRanksResponse adminRemoveRanks ( const std::vector< int32_t > &  ranks,
const std::map< std::string, std::string > &  options 
) const

Remove one or more ranks from the cluster.

All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.

Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
ranksRank numbers of the ranks to be removed from the cluster.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AdminRemoveRanksResponse& adminRemoveRanks ( const std::vector< int32_t > &  ranks,
const std::map< std::string, std::string > &  options,
AdminRemoveRanksResponse &  response_ 
) const

Remove one or more ranks from the cluster.

All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.

Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via const.

Parameters
ranksRank numbers of the ranks to be removed from the cluster.
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).
AdminShowAlertsResponse adminShowAlerts ( const AdminShowAlertsRequest &  request_) const

Requests a list of the most recent alerts.

Returns lists of alert data, including timestamp and type.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AdminShowAlertsResponse& adminShowAlerts ( const AdminShowAlertsRequest &  request_,
AdminShowAlertsResponse &  response_ 
) const

Requests a list of the most recent alerts.

Returns lists of alert data, including timestamp and 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).
AdminShowAlertsResponse adminShowAlerts ( const int32_t  numAlerts,
const std::map< std::string, std::string > &  options 
) const

Requests a list of the most recent alerts.

Returns lists of alert data, including timestamp and type.

Parameters
numAlertsNumber of most recent alerts to request. The response will include up to numAlerts depending on how many alerts there are in the system. A value of 0 returns all stored alerts.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AdminShowAlertsResponse& adminShowAlerts ( const int32_t  numAlerts,
const std::map< std::string, std::string > &  options,
AdminShowAlertsResponse &  response_ 
) const

Requests a list of the most recent alerts.

Returns lists of alert data, including timestamp and type.

Parameters
numAlertsNumber of most recent alerts to request. The response will include up to numAlerts depending on how many alerts there are 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).
AdminShowClusterOperationsResponse adminShowClusterOperations ( const AdminShowClusterOperationsRequest &  request_) const

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.

Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AdminShowClusterOperationsResponse& adminShowClusterOperations ( const AdminShowClusterOperationsRequest &  request_,
AdminShowClusterOperationsResponse &  response_ 
) const

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.

Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

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).
AdminShowClusterOperationsResponse adminShowClusterOperations ( const int32_t  historyIndex,
const std::map< std::string, std::string > &  options 
) const

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.

Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Parameters
historyIndexIndicates which cluster operation to retrieve. Use 0 for the most recent.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AdminShowClusterOperationsResponse& adminShowClusterOperations ( const int32_t  historyIndex,
const std::map< std::string, std::string > &  options,
AdminShowClusterOperationsResponse &  response_ 
) const

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.

Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Parameters
historyIndexIndicates which cluster operation to retrieve. Use 0 for the most recent.
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).
AdminShowJobsResponse 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.
AdminShowJobsResponse& 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).
AdminShowJobsResponse 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.
AdminShowJobsResponse& 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).
AdminShowShardsResponse 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.
AdminShowShardsResponse& 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).
AdminShowShardsResponse 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.
AdminShowShardsResponse& 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).
AdminShutdownResponse 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.
AdminShutdownResponse& 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).
AdminShutdownResponse 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.
AdminShutdownResponse& 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).
AdminVerifyDbResponse 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.
AdminVerifyDbResponse& 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).
AdminVerifyDbResponse 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.
AdminVerifyDbResponse& 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).
AggregateConvexHullResponse 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.
AggregateConvexHullResponse& 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).
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.

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.
AggregateConvexHullResponse& 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).
AggregateGroupByResponse aggregateGroupBy ( const AggregateGroupByRequest &  request_) const

Calculates unique combinations (groups) of values for the given columns in a given table or view 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.
AggregateGroupByResponse& aggregateGroupBy ( const AggregateGroupByRequest &  request_,
AggregateGroupByResponse &  response_ 
) const

Calculates unique combinations (groups) of values for the given columns in a given table or view 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).
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 or view 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 an existing table or view on which the operation will be performed.
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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
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,
AggregateGroupByResponse &  response_ 
) const

Calculates unique combinations (groups) of values for the given columns in a given table or view 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 an existing table or view on which the operation will be performed.
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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
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).
RawAggregateGroupByResponse aggregateGroupByRaw ( const AggregateGroupByRequest &  request_) const

Calculates unique combinations (groups) of values for the given columns in a given table or view 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.
RawAggregateGroupByResponse& aggregateGroupByRaw ( const AggregateGroupByRequest &  request_,
RawAggregateGroupByResponse &  response_ 
) const

Calculates unique combinations (groups) of values for the given columns in a given table or view 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).
AggregateHistogramResponse 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.
AggregateHistogramResponse& 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).
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.

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.
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,
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).
AggregateKMeansResponse 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.
AggregateKMeansResponse& 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).
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.

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.
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,
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).
AggregateMinMaxResponse 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.
AggregateMinMaxResponse& 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).
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.

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.
AggregateMinMaxResponse& 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).
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.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AggregateMinMaxGeometryResponse& 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).
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.

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.
AggregateMinMaxGeometryResponse& 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).
AggregateStatisticsResponse 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.
AggregateStatisticsResponse& 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).
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.

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.
AggregateStatisticsResponse& 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).
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.

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.
AggregateStatisticsByRangeResponse& 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).
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.

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.
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,
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).
AggregateUniqueResponse aggregateUnique ( const AggregateUniqueRequest &  request_) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 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.
AggregateUniqueResponse& aggregateUnique ( const AggregateUniqueRequest &  request_,
AggregateUniqueResponse &  response_ 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 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).
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 view (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 the value of columnName is an unrestricted-length string.

Parameters
tableNameName of an existing table or view 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
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,
AggregateUniqueResponse &  response_ 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 the value of columnName is an unrestricted-length string.

Parameters
tableNameName of an existing table or view 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
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).
RawAggregateUniqueResponse aggregateUniqueRaw ( const AggregateUniqueRequest &  request_) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 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.
RawAggregateUniqueResponse& aggregateUniqueRaw ( const AggregateUniqueRequest &  request_,
RawAggregateUniqueResponse &  response_ 
) const

Returns all the unique values from a particular column (specified by columnName) of a particular table or view (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 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).
AggregateUnpivotResponse 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.
AggregateUnpivotResponse& 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).
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.

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.
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,
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).
RawAggregateUnpivotResponse 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.
RawAggregateUnpivotResponse& 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).
AlterResourceGroupResponse alterResourceGroup ( const AlterResourceGroupRequest &  request_) const

Alters the properties of an exisiting resource group to facilitate resource management.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AlterResourceGroupResponse& alterResourceGroup ( const AlterResourceGroupRequest &  request_,
AlterResourceGroupResponse &  response_ 
) const

Alters the properties of an exisiting resource group to facilitate resource management.

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).
AlterResourceGroupResponse alterResourceGroup ( const std::string &  name,
const std::map< std::string, std::map< std::string, std::string > > &  tierAttributes,
const std::string &  ranking,
const std::string &  adjoiningResourceGroup,
const std::map< std::string, std::string > &  options 
) const

Alters the properties of an exisiting resource group to facilitate resource management.

Parameters
nameName of the group to be altered. Must be an existing resource group name.
tierAttributesOptional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}
rankingIf the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup. The default value is gpudb::alter_resource_group_empty_string.
adjoiningResourceGroupIf ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AlterResourceGroupResponse& alterResourceGroup ( const std::string &  name,
const std::map< std::string, std::map< std::string, std::string > > &  tierAttributes,
const std::string &  ranking,
const std::string &  adjoiningResourceGroup,
const std::map< std::string, std::string > &  options,
AlterResourceGroupResponse &  response_ 
) const

Alters the properties of an exisiting resource group to facilitate resource management.

Parameters
nameName of the group to be altered. Must be an existing resource group name.
tierAttributesOptional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}
rankingIf the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup. The default value is gpudb::alter_resource_group_empty_string.
adjoiningResourceGroupIf ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.
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).
AlterRoleResponse alterRole ( const AlterRoleRequest &  request_) const

Alters a Role.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AlterRoleResponse& alterRole ( const AlterRoleRequest &  request_,
AlterRoleResponse &  response_ 
) const

Alters a 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).
AlterRoleResponse alterRole ( const std::string &  name,
const std::string &  action,
const std::string &  value,
const std::map< std::string, std::string > &  options 
) const

Alters a Role.

Parameters
nameName of the role to be altered. Must be an existing role.
actionModification operation to be applied to the role.
  • gpudb::alter_role_set_resource_group: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
valueThe value of the modification, depending on action.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AlterRoleResponse& alterRole ( const std::string &  name,
const std::string &  action,
const std::string &  value,
const std::map< std::string, std::string > &  options,
AlterRoleResponse &  response_ 
) const

Alters a Role.

Parameters
nameName of the role to be altered. Must be an existing role.
actionModification operation to be applied to the role.
  • gpudb::alter_role_set_resource_group: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
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).
AlterSystemPropertiesResponse alterSystemProperties ( const AlterSystemPropertiesRequest &  request_) const

The 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.
AlterSystemPropertiesResponse& alterSystemProperties ( const AlterSystemPropertiesRequest &  request_,
AlterSystemPropertiesResponse &  response_ 
) const

The 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).
AlterSystemPropertiesResponse alterSystemProperties ( const std::map< std::string, std::string > &  propertyUpdatesMap,
const std::map< std::string, std::string > &  options 
) const

The 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.
AlterSystemPropertiesResponse& alterSystemProperties ( const std::map< std::string, std::string > &  propertyUpdatesMap,
const std::map< std::string, std::string > &  options,
AlterSystemPropertiesResponse &  response_ 
) const

The 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).
AlterTableResponse alterTable ( const AlterTableRequest &  request_) const

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

The available modifications include the following:

Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.

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.

Create or delete a foreign key on a particular column.

Manage a range-partitioned or a manual list-partitioned table's partitions.

Set (or reset) the tier strategy of a table or view.

Refresh and manage the refresh mode of a materialized view.

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.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AlterTableResponse& alterTable ( const AlterTableRequest &  request_,
AlterTableResponse &  response_ 
) const

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

The available modifications include the following:

Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.

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.

Create or delete a foreign key on a particular column.

Manage a range-partitioned or a manual list-partitioned table's partitions.

Set (or reset) the tier strategy of a table or view.

Refresh and manage the refresh mode of a materialized view.

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.

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).
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.

The available modifications include the following:

Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.

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.

Create or delete a foreign key on a particular column.

Manage a range-partitioned or a manual list-partitioned table's partitions.

Set (or reset) the tier strategy of a table or view.

Refresh and manage the refresh mode of a materialized view.

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.

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, depending on action. For example, if action is add_column, this would be the column name; while the column's definition would be covered by the column_type, column_properties, column_default_value, and add_column_expression in options. If action is ttl, it would be the number of minutes for the new TTL. If action is refresh, this field would be blank.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AlterTableResponse& 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:

Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.

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.

Create or delete a foreign key on a particular column.

Manage a range-partitioned or a manual list-partitioned table's partitions.

Set (or reset) the tier strategy of a table or view.

Refresh and manage the refresh mode of a materialized view.

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.

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, depending on action. For example, if action is add_column, this would be the column name; while the column's definition would be covered by the column_type, column_properties, column_default_value, and add_column_expression in options. If action is ttl, it would be the number of minutes for the new TTL. If action is refresh, this field would be blank.
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).
AlterTableColumnsResponse alterTableColumns ( const AlterTableColumnsRequest &  request_) const

Apply various modifications to columns in a table, view.

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.

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.
AlterTableColumnsResponse& alterTableColumns ( const AlterTableColumnsRequest &  request_,
AlterTableColumnsResponse &  response_ 
) const

Apply various modifications to columns in a table, view.

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.

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).
AlterTableColumnsResponse alterTableColumns ( const std::string &  tableName,
const std::vector< std::map< std::string, std::string > > &  columnAlterations,
const std::map< std::string, std::string > &  options 
) const

Apply various modifications to columns in a table, view.

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.

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 or view.
columnAlterationslist of alter table add/delete/change column requests - all for the same table. each request is a map that includes 'column_name', 'action' and the options specific for the action, note that the same options as in alter table requests but in the same map as the column name and the action. For example: [{'column_name':'col_1','action':'change_column','rename_column':'col_2'}, {'column_name':'col_1','action':'add_column', 'type':'int','default_value':'1'} ]
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AlterTableColumnsResponse& alterTableColumns ( const std::string &  tableName,
const std::vector< std::map< std::string, std::string > > &  columnAlterations,
const std::map< std::string, std::string > &  options,
AlterTableColumnsResponse &  response_ 
) const

Apply various modifications to columns in a table, view.

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.

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 or view.
columnAlterationslist of alter table add/delete/change column requests - all for the same table. each request is a map that includes 'column_name', 'action' and the options specific for the action, note that the same options as in alter table requests but in the same map as the column name and the action. For example: [{'column_name':'col_1','action':'change_column','rename_column':'col_2'}, {'column_name':'col_1','action':'add_column', 'type':'int','default_value':'1'} ]
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).
AlterTableMetadataResponse 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.
AlterTableMetadataResponse& 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).
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.

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.
AlterTableMetadataResponse& 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).
AlterTierResponse alterTier ( const AlterTierRequest &  request_) const

Alters properties of an exisiting tier to facilitate resource management.

To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
AlterTierResponse& alterTier ( const AlterTierRequest &  request_,
AlterTierResponse &  response_ 
) const

Alters properties of an exisiting tier to facilitate resource management.

To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

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).
AlterTierResponse alterTier ( const std::string &  name,
const std::map< std::string, std::string > &  options 
) const

Alters properties of an exisiting tier to facilitate resource management.

To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

Parameters
nameName of the tier to be altered. Must be an existing tier group name.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
AlterTierResponse& alterTier ( const std::string &  name,
const std::map< std::string, std::string > &  options,
AlterTierResponse &  response_ 
) const

Alters properties of an exisiting tier to facilitate resource management.

To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

Parameters
nameName of the tier to be altered. Must be an existing tier group name.
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).
AlterUserResponse 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.
AlterUserResponse& 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).
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.

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.
AlterUserResponse& 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).
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).

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.
AppendRecordsResponse& 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).
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).

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 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 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 sourceTableName. The default value is ''.
  • gpudb::append_records_order_by: Comma-separated list of the columns to be sorted by from 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 longer strings into smaller charN string columns by truncating the longer strings to fit. The default value is gpudb::append_records_false.
Returns
Response object containing the result of the operation.
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,
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 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 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 sourceTableName. The default value is ''.
  • gpudb::append_records_order_by: Comma-separated list of the columns to be sorted by from 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 longer strings into smaller charN string columns by truncating the longer 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).
ClearStatisticsResponse clearStatistics ( const ClearStatisticsRequest &  request_) const

Clears statistics (cardinality, mean value, etc.) for a column in a specified table.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ClearStatisticsResponse& clearStatistics ( const ClearStatisticsRequest &  request_,
ClearStatisticsResponse &  response_ 
) const

Clears statistics (cardinality, mean value, etc.) for a column in a specified 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).
ClearStatisticsResponse clearStatistics ( const std::string &  tableName,
const std::string &  columnName,
const std::map< std::string, std::string > &  options 
) const

Clears statistics (cardinality, mean value, etc.) for a column in a specified table.

Parameters
tableNameName of a table. Must be an existing table.
columnNameName of the column in tableName for which to clear statistics. The column must be from an existing table. An empty string clears statistics for all columns in the table.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ClearStatisticsResponse& clearStatistics ( const std::string &  tableName,
const std::string &  columnName,
const std::map< std::string, std::string > &  options,
ClearStatisticsResponse &  response_ 
) const

Clears statistics (cardinality, mean value, etc.) for a column in a specified table.

Parameters
tableNameName of a table. Must be an existing table.
columnNameName of the column in tableName for which to clear statistics. The column must be from an existing table. An empty string clears statistics for all columns 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).
ClearTableResponse 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.
ClearTableResponse& 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).
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.

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.
ClearTableResponse& 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).
ClearTableMonitorResponse clearTableMonitor ( const ClearTableMonitorRequest &  request_) const

Deactivates a table monitor previously created with const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ClearTableMonitorResponse& clearTableMonitor ( const ClearTableMonitorRequest &  request_,
ClearTableMonitorResponse &  response_ 
) const

Deactivates a table monitor previously created with 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).
ClearTableMonitorResponse clearTableMonitor ( const std::string &  topicId,
const std::map< std::string, std::string > &  options 
) const

Deactivates a table monitor previously created with const.

Parameters
topicIdThe topic ID returned by /create/tablemonitor.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ClearTableMonitorResponse& clearTableMonitor ( const std::string &  topicId,
const std::map< std::string, std::string > &  options,
ClearTableMonitorResponse &  response_ 
) const

Deactivates a table monitor previously created with 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).
ClearTriggerResponse 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.
ClearTriggerResponse& 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).
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.

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.
ClearTriggerResponse& 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).
CollectStatisticsResponse collectStatistics ( const CollectStatisticsRequest &  request_) const

Collect statistics for a column(s) in a specified table.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CollectStatisticsResponse& collectStatistics ( const CollectStatisticsRequest &  request_,
CollectStatisticsResponse &  response_ 
) const

Collect statistics for a column(s) in a specified 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).
CollectStatisticsResponse collectStatistics ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const std::map< std::string, std::string > &  options 
) const

Collect statistics for a column(s) in a specified table.

Parameters
tableNameName of a table. Must be an existing table.
columnNamesList of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.).
optionsOptional parameters.
Returns
Response object containing the result of the operation.
CollectStatisticsResponse& collectStatistics ( const std::string &  tableName,
const std::vector< std::string > &  columnNames,
const std::map< std::string, std::string > &  options,
CollectStatisticsResponse &  response_ 
) const

Collect statistics for a column(s) in a specified table.

Parameters
tableNameName of a table. Must be an existing table.
columnNamesList of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.).
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).
CreateGraphResponse createGraph ( const CreateGraphRequest &  request_) const

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CreateGraphResponse& createGraph ( const CreateGraphRequest &  request_,
CreateGraphResponse &  response_ 
) const

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

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).
CreateGraphResponse createGraph ( const std::string &  graphName,
const bool  directedGraph,
const std::vector< std::string > &  nodes,
const std::vector< std::string > &  edges,
const std::vector< std::string > &  weights,
const std::vector< std::string > &  restrictions,
const std::map< std::string, std::string > &  options 
) const

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to generate.
directedGraphIf set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. The default value is gpudb::create_graph_true.
nodesNodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.
edgesEdges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.
weightsWeights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.
restrictionsRestrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
CreateGraphResponse& createGraph ( const std::string &  graphName,
const bool  directedGraph,
const std::vector< std::string > &  nodes,
const std::vector< std::string > &  edges,
const std::vector< std::string > &  weights,
const std::vector< std::string > &  restrictions,
const std::map< std::string, std::string > &  options,
CreateGraphResponse &  response_ 
) const

Creates a new graph network using given nodes, edges, weights, and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to generate.
directedGraphIf set to true, the graph will be directed. If set to false, the graph will not be directed. Consult Directed Graphs for more details. The default value is gpudb::create_graph_true.
nodesNodes represent fundamental topological units of a graph. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or constant values, e.g., '{9, 10, 11} AS NODE_ID'. If using constant values in an identifier combination, the number of values specified must match across the combination.
edgesEdges represent the required fundamental topological unit of a graph that typically connect nodes. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or constant values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using constant values in an identifier combination, the number of values specified must match across the combination.
weightsWeights represent a method of informing the graph solver of the cost of including a given edge in a solution. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using constant values in an identifier combination, the number of values specified must match across the combination.
restrictionsRestrictions represent a method of informing the graph solver which edges and/or nodes should be ignored for the solution. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination.
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).
CreateJobResponse 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 const.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CreateJobResponse& 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 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).
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.

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 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.
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,
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 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).
CreateJoinTableResponse 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.
CreateJoinTableResponse& 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).
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.

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.
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,
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).
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.

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.
CreateMaterializedViewResponse& 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).
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.

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.
CreateMaterializedViewResponse& 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).
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.

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.
CreateProcResponse& 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).
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.

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.
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,
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).
CreateProjectionResponse 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CreateProjectionResponse& 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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).
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.

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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

Parameters
tableNameName of the existing table on which the projection is to be applied. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.
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.
CreateProjectionResponse& 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

Parameters
tableNameName of the existing table on which the projection is to be applied. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.
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).
CreateResourceGroupResponse createResourceGroup ( const CreateResourceGroupRequest &  request_) const

Creates a new resource group to facilitate resource management.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CreateResourceGroupResponse& createResourceGroup ( const CreateResourceGroupRequest &  request_,
CreateResourceGroupResponse &  response_ 
) const

Creates a new resource group to facilitate resource management.

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).
CreateResourceGroupResponse createResourceGroup ( const std::string &  name,
const std::map< std::string, std::map< std::string, std::string > > &  tierAttributes,
const std::string &  ranking,
const std::string &  adjoiningResourceGroup,
const std::map< std::string, std::string > &  options 
) const

Creates a new resource group to facilitate resource management.

Parameters
nameName of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.
tierAttributesOptional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}
rankingIndicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup.
adjoiningResourceGroupIf ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
CreateResourceGroupResponse& createResourceGroup ( const std::string &  name,
const std::map< std::string, std::map< std::string, std::string > > &  tierAttributes,
const std::string &  ranking,
const std::string &  adjoiningResourceGroup,
const std::map< std::string, std::string > &  options,
CreateResourceGroupResponse &  response_ 
) const

Creates a new resource group to facilitate resource management.

Parameters
nameName of the group to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match existing resource group name.
tierAttributesOptional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}
rankingIndicates the relative ranking among existing resource groups where this new resource group will be placed. When using before or after, specify which resource group this one will be inserted before or after in adjoiningResourceGroup.
adjoiningResourceGroupIf ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.
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).
CreateRoleResponse 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.
CreateRoleResponse& 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).
CreateRoleResponse 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.
CreateRoleResponse& 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).
CreateTableResponse 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 be the ID of a currently registered type (i.e. one created via 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.

A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CreateTableResponse& 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 be the ID of a currently registered type (i.e. one created via 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.

A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.

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).
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.

If a new table is being created, the type of the table is given by typeId, which must be the ID of a currently registered type (i.e. one created via 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.

A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.

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.
CreateTableResponse& 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 be the ID of a currently registered type (i.e. one created via 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.

A table may optionally be designated to use a replicated distribution scheme, have foreign keys to other tables assigned, be assigned a partitioning scheme, or have a tier strategy assigned.

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).
CreateTableMonitorResponse createTableMonitor ( const CreateTableMonitorRequest &  request_) const

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type 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 corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with const.

For more information on table monitors, see Table Monitors.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
CreateTableMonitorResponse& createTableMonitor ( const CreateTableMonitorRequest &  request_,
CreateTableMonitorResponse &  response_ 
) const

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type 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 corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with const.

For more information on table monitors, see Table Monitors.

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).
CreateTableMonitorResponse createTableMonitor ( const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type 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 corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with const.

For more information on table monitors, see Table Monitors.

Parameters
tableNameName of the table to monitor. Must not refer to a collection.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
CreateTableMonitorResponse& createTableMonitor ( const std::string &  tableName,
const std::map< std::string, std::string > &  options,
CreateTableMonitorResponse &  response_ 
) const

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.

After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type 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 corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with const.

For more information on table monitors, see Table Monitors.

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).
CreateTriggerByAreaResponse 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 const.) Once the trigger has been activated, any record added to the listed tables(s) via 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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.
CreateTriggerByAreaResponse& 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 const.) Once the trigger has been activated, any record added to the listed tables(s) via 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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).
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.

(This function is essentially the two-dimensional version of const.) Once the trigger has been activated, any record added to the listed tables(s) via 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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.
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,
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 const.) Once the trigger has been activated, any record added to the listed tables(s) via 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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).
CreateTriggerByRangeResponse 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 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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.
CreateTriggerByRangeResponse& 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 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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).
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.

Once the trigger has been activated, any record added to the listed tables(s) via 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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.
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,
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 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 const) for any listening client to collect. Active triggers can be cancelled by using the 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).
CreateTypeResponse 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.
CreateTypeResponse& 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 const 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).
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.

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 and /aggregate/groupby 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_ulong: Valid only for 'string' columns. It represents an unsigned long integer data type. The string can only be interpreted as an unsigned long data type with minimum value of zero, and maximum value of 18446744073709551615.
  • 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 restricted string (charN), int, long or date columns. Dictionary encoding is best for columns where the cardinality (the number of unique values) is expected to be low. This property can save a large amount of memory.
  • gpudb::create_type_init_with_now: For 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timestamps with 'NOW()' upon insert.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
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,
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 and /aggregate/groupby 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_ulong: Valid only for 'string' columns. It represents an unsigned long integer data type. The string can only be interpreted as an unsigned long data type with minimum value of zero, and maximum value of 18446744073709551615.
  • 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 restricted string (charN), int, long or date columns. Dictionary encoding is best for columns where the cardinality (the number of unique values) is expected to be low. This property can save a large amount of memory.
  • gpudb::create_type_init_with_now: For 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timestamps with 'NOW()' upon insert.
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).
CreateUnionResponse 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.
CreateUnionResponse& 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).
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.

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.
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,
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).
CreateUserExternalResponse 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.
CreateUserExternalResponse& 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).
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).

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.
CreateUserExternalResponse& 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).
CreateUserInternalResponse 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.
CreateUserInternalResponse& 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).
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).

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.
CreateUserInternalResponse& 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).
DeleteGraphResponse deleteGraph ( const DeleteGraphRequest &  request_) const

Deletes an existing graph from the graph server and/or persist.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
DeleteGraphResponse& deleteGraph ( const DeleteGraphRequest &  request_,
DeleteGraphResponse &  response_ 
) const

Deletes an existing graph from the graph server and/or persist.

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).
DeleteGraphResponse deleteGraph ( const std::string &  graphName,
const std::map< std::string, std::string > &  options 
) const

Deletes an existing graph from the graph server and/or persist.

Parameters
graphNameName of the graph to be deleted.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
DeleteGraphResponse& deleteGraph ( const std::string &  graphName,
const std::map< std::string, std::string > &  options,
DeleteGraphResponse &  response_ 
) const

Deletes an existing graph from the graph server and/or persist.

Parameters
graphNameName of the graph to be deleted.
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).
DeleteProcResponse 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.
DeleteProcResponse& 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).
DeleteProcResponse 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.
DeleteProcResponse& 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).
DeleteRecordsResponse 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.
DeleteRecordsResponse& 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).
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.

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.
DeleteRecordsResponse& 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).
DeleteResourceGroupResponse deleteResourceGroup ( const DeleteResourceGroupRequest &  request_) const

Deletes a resource group.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
DeleteResourceGroupResponse& deleteResourceGroup ( const DeleteResourceGroupRequest &  request_,
DeleteResourceGroupResponse &  response_ 
) const

Deletes a resource group.

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).
DeleteResourceGroupResponse deleteResourceGroup ( const std::string &  name,
const std::map< std::string, std::string > &  options 
) const

Deletes a resource group.

Parameters
nameName of the resource group to be deleted.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
DeleteResourceGroupResponse& deleteResourceGroup ( const std::string &  name,
const std::map< std::string, std::string > &  options,
DeleteResourceGroupResponse &  response_ 
) const

Deletes a resource group.

Parameters
nameName of the resource group to be deleted.
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).
DeleteRoleResponse 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.
DeleteRoleResponse& 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).
DeleteRoleResponse 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.
DeleteRoleResponse& 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).
DeleteUserResponse 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.
DeleteUserResponse& 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).
DeleteUserResponse 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.
DeleteUserResponse& 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).
ExecuteProcResponse 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.
ExecuteProcResponse& 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).
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.

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 ''.
  • gpudb::execute_proc_run_tag: A string that, if not empty, can be used in subsequent calls to /show/proc/status or /kill/proc to identify the proc instance. The default value is ''.
Returns
Response object containing the result of the operation.
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,
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 ''.
  • gpudb::execute_proc_run_tag: A string that, if not empty, can be used in subsequent calls to /show/proc/status or /kill/proc to identify the proc instance. 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).
ExecuteSqlResponse executeSql ( const ExecuteSqlRequest &  request_) const

SQL Request.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ExecuteSqlResponse& executeSql ( const ExecuteSqlRequest &  request_,
ExecuteSqlResponse &  response_ 
) const

SQL 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).
ExecuteSqlResponse executeSql ( const std::string &  statement,
const int64_t  offset,
const int64_t  limit,
const std::string &  requestSchemaStr,
const std::vector< std::vector< uint8_t > > &  data,
const std::map< std::string, std::string > &  options 
) const

SQL Request.

Parameters
statementSQL statement (query, DML, or DDL) to be executed
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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
requestSchemaStrAvro schema of data.
dataAn array of binary-encoded data for the records to be binded to the SQL query.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ExecuteSqlResponse& executeSql ( const std::string &  statement,
const int64_t  offset,
const int64_t  limit,
const std::string &  requestSchemaStr,
const std::vector< std::vector< uint8_t > > &  data,
const std::map< std::string, std::string > &  options,
ExecuteSqlResponse &  response_ 
) const

SQL Request.

Parameters
statementSQL statement (query, DML, or DDL) to be executed
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 maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
requestSchemaStrAvro schema of data.
dataAn array of binary-encoded data for the records to be binded to the SQL query.
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).
RawExecuteSqlResponse executeSqlRaw ( const ExecuteSqlRequest &  request_) const

SQL Request.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
RawExecuteSqlResponse& executeSqlRaw ( const ExecuteSqlRequest &  request_,
RawExecuteSqlResponse &  response_ 
) const

SQL 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).
FilterResponse 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.
FilterResponse& 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).
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.

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 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.
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.
FilterResponse& 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 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.
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).
FilterByAreaResponse 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.
FilterByAreaResponse& 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).
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).

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.
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,
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).
FilterByAreaGeometryResponse 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.
FilterByAreaGeometryResponse& 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).
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).

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.
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,
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).
FilterByBoxResponse 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.
FilterByBoxResponse& 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).
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.

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.
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,
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).
FilterByBoxGeometryResponse 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.
FilterByBoxGeometryResponse& 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).
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.

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.
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,
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).
FilterByGeometryResponse 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.
FilterByGeometryResponse& 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).
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.

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.
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,
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).
FilterByListResponse 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.
FilterByListResponse& 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).
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.

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 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.
columnValuesMapList of values for the corresponding column in the table
optionsOptional parameters.
Returns
Response object containing the result of the operation.
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,
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 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.
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).
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.

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.
FilterByRadiusResponse& 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).
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.

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.
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,
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).
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.

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.
FilterByRadiusGeometryResponse& 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).
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.

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.
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,
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).
FilterByRangeResponse 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.
FilterByRangeResponse& 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).
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.

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.
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,
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).
FilterBySeriesResponse 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.
FilterBySeriesResponse& 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).
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).

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.
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,
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).
FilterByStringResponse 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.
FilterByStringResponse& 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).
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.

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.
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,
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).
FilterByTableResponse 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.
FilterByTableResponse& 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).
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.

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.
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,
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).
FilterByValueResponse 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.
FilterByValueResponse& 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).
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.

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.
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,
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).
GetJobResponse getJob ( const GetJobRequest &  request_) const

Get the status and result of asynchronously running job.

See the const for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
GetJobResponse& getJob ( const GetJobRequest &  request_,
GetJobResponse &  response_ 
) const

Get the status and result of asynchronously running job.

See the const for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

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).
GetJobResponse getJob ( const int64_t  jobId,
const std::map< std::string, std::string > &  options 
) const

Get the status and result of asynchronously running job.

See the const for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

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.
GetJobResponse& getJob ( const int64_t  jobId,
const std::map< std::string, std::string > &  options,
GetJobResponse &  response_ 
) const

Get the status and result of asynchronously running job.

See the const for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.

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).
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.

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 13400 of file GPUdbFunctions.hpp.

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.

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 13444 of file GPUdbFunctions.hpp.

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.

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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.

Definition at line 13526 of file GPUdbFunctions.hpp.

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.

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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
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 13616 of file GPUdbFunctions.hpp.

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.

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 13663 of file GPUdbFunctions.hpp.

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.

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 13706 of file GPUdbFunctions.hpp.

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.

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 13752 of file GPUdbFunctions.hpp.

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.

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 13798 of file GPUdbFunctions.hpp.

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.

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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.

Definition at line 13882 of file GPUdbFunctions.hpp.

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.

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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.

Definition at line 13971 of file GPUdbFunctions.hpp.

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.

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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
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 14063 of file GPUdbFunctions.hpp.

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.

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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
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 14155 of file GPUdbFunctions.hpp.

GetRecordsByColumnResponse 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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.
GetRecordsByColumnResponse& 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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).
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).

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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. 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, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.
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,
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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. 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, or END_OF_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use hasMoreRecords to see if more records exist in the result to be fetched, and offset & limit to request subsequent pages of results.
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).
RawGetRecordsByColumnResponse 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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.
RawGetRecordsByColumnResponse& 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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).
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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14603 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14653 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14715 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14787 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14842 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14890 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14942 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 14994 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 15058 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 15129 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 15203 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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 15277 of file GPUdbFunctions.hpp.

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.

This operation supports paging through the data via the offset and limit parameters.

In contrast to 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.
RawGetRecordsBySeriesResponse& 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 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).
template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> 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 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 15373 of file GPUdbFunctions.hpp.

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection ( const GetRecordsFromCollectionRequest &  request_,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as 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 15414 of file GPUdbFunctions.hpp.

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.

The operation can optionally return the record IDs which can be used in certain queries such as 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.

Definition at line 15477 of file GPUdbFunctions.hpp.

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.

The operation can optionally return the record IDs which can be used in certain queries such as 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results.
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 15548 of file GPUdbFunctions.hpp.

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection ( const ::avro::ValidSchema &  schema_,
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 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 15592 of file GPUdbFunctions.hpp.

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection ( const Type &  type_,
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 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 15632 of file GPUdbFunctions.hpp.

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection ( const ::avro::ValidSchema &  schema_,
const GetRecordsFromCollectionRequest &  request_,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as 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 15675 of file GPUdbFunctions.hpp.

template<typename TResponse >
GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection ( const Type &  type_,
const GetRecordsFromCollectionRequest &  request_,
GetRecordsFromCollectionResponse< TResponse > &  response_ 
) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as 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 15718 of file GPUdbFunctions.hpp.

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.

The operation can optionally return the record IDs which can be used in certain queries such as 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.

Definition at line 15783 of file GPUdbFunctions.hpp.

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.

The operation can optionally return the record IDs which can be used in certain queries such as 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results.
options
Returns
Response object containing the result of the operation.

Definition at line 15853 of file GPUdbFunctions.hpp.

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.

The operation can optionally return the record IDs which can be used in certain queries such as 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results.
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 15926 of file GPUdbFunctions.hpp.

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.

The operation can optionally return the record IDs which can be used in certain queries such as 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. The number of records returned will never exceed the server's own limit, defined by the max_get_records_size parameter in the server configuration. Use offset & limit to request subsequent pages of results.
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 15999 of file GPUdbFunctions.hpp.

RawGetRecordsFromCollectionResponse 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 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.
RawGetRecordsFromCollectionResponse& 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 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).
RawGetRecordsResponse 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.
RawGetRecordsResponse& 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).
GrantPermissionProcResponse grantPermissionProc ( const GrantPermissionProcRequest &  request_) const

Grants a proc-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.
GrantPermissionProcResponse& grantPermissionProc ( const GrantPermissionProcRequest &  request_,
GrantPermissionProcResponse &  response_ 
) const

Grants a proc-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).
GrantPermissionProcResponse grantPermissionProc ( const std::string &  name,
const std::string &  permission,
const std::string &  procName,
const std::map< std::string, std::string > &  options 
) const

Grants a proc-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.
procNameName of the proc to which the permission grants access. Must be an existing proc, or an empty string to grant access to all procs.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
GrantPermissionProcResponse& grantPermissionProc ( const std::string &  name,
const std::string &  permission,
const std::string &  procName,
const std::map< std::string, std::string > &  options,
GrantPermissionProcResponse &  response_ 
) const

Grants a proc-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.
procNameName of the proc to which the permission grants access. Must be an existing proc, or an empty string to grant access to all procs.
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).
GrantPermissionSystemResponse 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.
GrantPermissionSystemResponse& 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).
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.

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.
GrantPermissionSystemResponse& 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).
GrantPermissionTableResponse 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.
GrantPermissionTableResponse& 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).
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.

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.
filterExpressionOptional filter expression to apply to this grant. Only rows that match the filter will be affected.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
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,
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.
filterExpressionOptional filter expression to apply to this grant. Only rows that match the filter will be affected.
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).
GrantRoleResponse 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.
GrantRoleResponse& 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).
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.

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.
GrantRoleResponse& 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).
HasProcResponse 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.
HasProcResponse& 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).
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.

Parameters
procNameName of the proc to check for existence.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
HasProcResponse& 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).
HasTableResponse 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.
HasTableResponse& 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).
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.

Parameters
tableNameName of the table to check for existence.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
HasTableResponse& 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).
HasTypeResponse 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.
HasTypeResponse& 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).
HasTypeResponse 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.
HasTypeResponse& 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).
template<typename TRequest >
InsertRecordsResponse insertRecords ( const InsertRecordsRequest< TRequest > &  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.

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 16705 of file GPUdbFunctions.hpp.

template<typename TRequest >
InsertRecordsResponse& insertRecords ( const InsertRecordsRequest< TRequest > &  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.

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 16746 of file GPUdbFunctions.hpp.

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.

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 16852 of file GPUdbFunctions.hpp.

template<typename TRequest >
InsertRecordsResponse& insertRecords ( 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.

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 16963 of file GPUdbFunctions.hpp.

InsertRecordsFromFilesResponse insertRecordsFromFiles ( const InsertRecordsFromFilesRequest &  request_) const

Reads from one or more files located on the server and inserts the data into a new or existing table.

For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.

Returns once all files are processed.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
InsertRecordsFromFilesResponse& insertRecordsFromFiles ( const InsertRecordsFromFilesRequest &  request_,
InsertRecordsFromFilesResponse &  response_ 
) const

Reads from one or more files located on the server and inserts the data into a new or existing table.

For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.

Returns once all files are processed.

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).
InsertRecordsFromFilesResponse insertRecordsFromFiles ( const std::string &  tableName,
const std::vector< std::string > &  filepaths,
const std::map< std::string, std::string > &  createTableOptions,
const std::map< std::string, std::string > &  options 
) const

Reads from one or more files located on the server and inserts the data into a new or existing table.

For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.

Returns once all files are processed.

Parameters
tableNameName of the table into which the data will be inserted. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file.
filepathsAbsolute or relative filepath(s) from where files will be loaded. Relative filepaths are relative to the defined external_files_directory parameter in the server configuration. The filepaths may include wildcards (*). If the first path ends in .tsv, the text delimiter will be defaulted to a tab character. If the first path ends in .psv, the text delimiter will be defaulted to a pipe character (|).
createTableOptionsOptions used when creating a new table.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
InsertRecordsFromFilesResponse& insertRecordsFromFiles ( const std::string &  tableName,
const std::vector< std::string > &  filepaths,
const std::map< std::string, std::string > &  createTableOptions,
const std::map< std::string, std::string > &  options,
InsertRecordsFromFilesResponse &  response_ 
) const

Reads from one or more files located on the server and inserts the data into a new or existing table.

For CSV files, there are two loading schemes: positional and name-based. The name-based loading scheme is enabled when the file has a header present and text_has_header is set to true. In this scheme, the source file(s) field names must match the target table's column names exactly; however, the source file can have more fields than the target table has columns. If error_handling is set to permissive, the source file can have fewer fields than the target table has columns. If the name-based loading scheme is being used, names matching the file header's names may be provided to columns_to_load instead of numbers, but ranges are not supported.

Returns once all files are processed.

Parameters
tableNameName of the table into which the data will be inserted. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file.
filepathsAbsolute or relative filepath(s) from where files will be loaded. Relative filepaths are relative to the defined external_files_directory parameter in the server configuration. The filepaths may include wildcards (*). If the first path ends in .tsv, the text delimiter will be defaulted to a tab character. If the first path ends in .psv, the text delimiter will be defaulted to a pipe character (|).
createTableOptionsOptions used when creating a new 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).
InsertRecordsRandomResponse 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.
InsertRecordsRandomResponse& 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).
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.

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.
InsertRecordsRandomResponse& 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).
InsertRecordsResponse 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.
InsertRecordsResponse& 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).
InsertSymbolResponse 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.
InsertSymbolResponse& 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).
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.

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.
InsertSymbolResponse& 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).
KillProcResponse 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.
KillProcResponse& 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).
KillProcResponse killProc ( const std::string &  runId,
const std::map< std::string, std::string > &  options 
) const

Kills a running proc instance.

Parameters
runIdThe run ID of a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed.
optionsOptional parameters.
  • gpudb::kill_proc_run_tag: If runId is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If runId is not specified, kill the proc instance(s) where a matching run tag was provided to /execute/proc. The default value is ''.
Returns
Response object containing the result of the operation.
KillProcResponse& 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 a running proc instance. If a proc with a matching run ID is not found or the proc instance has already completed, no procs will be killed. If not specified, all running proc instances will be killed.
optionsOptional parameters.
  • gpudb::kill_proc_run_tag: If runId is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to /execute/proc. If runId is not specified, kill the proc instance(s) where a matching run tag was provided to /execute/proc. 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).
LockTableResponse 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.
LockTableResponse& 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).
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.

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.
LockTableResponse& 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).
MatchGraphResponse matchGraph ( const MatchGraphRequest &  request_) const

Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
MatchGraphResponse& matchGraph ( const MatchGraphRequest &  request_,
MatchGraphResponse &  response_ 
) const

Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

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).
MatchGraphResponse matchGraph ( const std::string &  graphName,
const std::vector< std::string > &  samplePoints,
const std::string &  solveMethod,
const std::string &  solutionTable,
const std::map< std::string, std::string > &  options 
) const

Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters
graphNameName of the underlying geospatial graph resource to match to using samplePoints.
samplePointsSample points used to match to an underlying geospatial graph. Sample points must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with: existing column names, e.g., 'table.column AS SAMPLE_X'; expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS SAMPLE_WKTPOINT'; or constant values, e.g., '{1, 2, 10} AS SAMPLE_TRIPID'.
solveMethodThe type of solver to use for graph matching.
  • gpudb::match_graph_markov_chain: Matches samplePoints to the graph using the Hidden Markov Model (HMM)-based method, which conducts a range-tree closest-edge search to find the best combinations of possible road segments (num_segments) for each sample point to create the best route. The route is secured one point at a time while looking ahead chain_width number of points, so the prediction is corrected after each point. This solution type is the most accurate but also the most computationally intensive. Related options: num_segments and chain_width.
  • gpudb::match_graph_match_od_pairs: Matches samplePoints to find the most probable path between origin and destination pairs with cost constraints.
  • gpudb::match_graph_match_supply_demand: Matches samplePoints to optimize scheduling multiple supplies (trucks) with varying sizes to varying demand sites with varying capacities per depot. Related options: partial_loading and max_combinations.
  • gpudb::match_graph_match_batch_solves: Matches samplePoints source and destination pairs for the shortest path solves in batch mode.
The default value is gpudb::match_graph_markov_chain.
solutionTableThe name of the table used to store the results; this table contains a track of geospatial points for the matched portion of the graph, a track ID, and a score value. Also outputs a details table containing a trip ID (that matches the track ID), the latitude/longitude pair, the timestamp the point was recorded at, and an edge ID corresponding to the matched road segment. Has the same naming restrictions as tables. Must not be an existing table of the same name.
optionsAdditional parameters
  • gpudb::match_graph_gps_noise: GPS noise value (in meters) to remove redundant sample points. Use -1 to disable noise reduction. The default value accounts for 95% of point variation (+ or -5 meters). The default value is '5.0'.
  • gpudb::match_graph_num_segments: Maximum number of potentially matching road segments for each sample point. For the markov_chain solver, the default is 3. The default value is '3'.
  • gpudb::match_graph_search_radius: Maximum search radius used when snapping sample points onto potentially matching surrounding segments. The default value corresponds to approximately 100 meters. The default value is '0.001'.
  • gpudb::match_graph_chain_width: For the markov_chain solver only. Length of the sample points lookahead window within the Markov kernel; the larger the number, the more accurate the solution. The default value is '9'.
  • gpudb::match_graph_source: Optional WKT starting point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.
  • gpudb::match_graph_destination: Optional WKT ending point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.
  • gpudb::match_graph_partial_loading: For the match_supply_demand solver only. When false (non-default), trucks do not off-load at the demand (store) side if the remainder is less than the store's need The default value is gpudb::match_graph_true.
  • gpudb::match_graph_max_combinations: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the demand locations - can increase this up to 2M. The default value is '10000'.
  • gpudb::match_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_aggregated_output: For the match_supply_demand solver only. When it is true (default), each record in the output table shows a particular truck's scheduled cumulative round trip path (MULTILINESTRING) and the corresponding aggregated cost. Otherwise, each record shows a single scheduled truck route (LINESTRING) towards a particular demand location (store id) with its corresponding cost. The default value is 'true'.
  • gpudb::match_graph_max_trip_cost: For the match_supply_demand solver only. If this constraint is greater than zero (default) then the trucks will skip travelling from one demand location to another if the cost between them is greater than this number (distance or time). Zero (default) value means no check is performed. The default value is '0.0'.
  • gpudb::match_graph_filter_folding_paths: For the markov_chain solver only. When true (non-default), the paths per sequence combination is checked for folding over patterns and can significantly increase the execution time depending on the chain width and the number of gps samples. The default value is gpudb::match_graph_false.
  • gpudb::match_graph_unit_unloading_cost: For the match_supply_demand solver only. The unit cost per load amount to be delivered. If this value is greater than zero (default) then the additional cost of this unit load multiplied by the total dropped load will be added over to the trip cost to the demand location. The default value is '0.0'.
  • gpudb::match_graph_max_num_threads: For the markov_chain solver only. If specified (greater than zero), the maximum number of threads will not be greater than the specified value. It can be lower due to the memory and the number cores available. Default value of zero allows the algorithm to set the maximal number of threads within these constraints. The default value is '0'.
  • gpudb::match_graph_truck_service_limit: For the match_supply_demand solver only. If specified (greather than zero), any truck's total service cost (distance or time) will be limited by the specified value including multiple rounds (if set). The default value is '0.0'.
  • gpudb::match_graph_enable_truck_reuse: For the match_supply_demand solver only. If specified (true), all trucks can be scheduled for second rounds from their originating depots. The default value is gpudb::match_graph_false.
Returns
Response object containing the result of the operation.
MatchGraphResponse& matchGraph ( const std::string &  graphName,
const std::vector< std::string > &  samplePoints,
const std::string &  solveMethod,
const std::string &  solutionTable,
const std::map< std::string, std::string > &  options,
MatchGraphResponse &  response_ 
) const

Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.

Parameters
graphNameName of the underlying geospatial graph resource to match to using samplePoints.
samplePointsSample points used to match to an underlying geospatial graph. Sample points must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with: existing column names, e.g., 'table.column AS SAMPLE_X'; expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS SAMPLE_WKTPOINT'; or constant values, e.g., '{1, 2, 10} AS SAMPLE_TRIPID'.
solveMethodThe type of solver to use for graph matching.
  • gpudb::match_graph_markov_chain: Matches samplePoints to the graph using the Hidden Markov Model (HMM)-based method, which conducts a range-tree closest-edge search to find the best combinations of possible road segments (num_segments) for each sample point to create the best route. The route is secured one point at a time while looking ahead chain_width number of points, so the prediction is corrected after each point. This solution type is the most accurate but also the most computationally intensive. Related options: num_segments and chain_width.
  • gpudb::match_graph_match_od_pairs: Matches samplePoints to find the most probable path between origin and destination pairs with cost constraints.
  • gpudb::match_graph_match_supply_demand: Matches samplePoints to optimize scheduling multiple supplies (trucks) with varying sizes to varying demand sites with varying capacities per depot. Related options: partial_loading and max_combinations.
  • gpudb::match_graph_match_batch_solves: Matches samplePoints source and destination pairs for the shortest path solves in batch mode.
The default value is gpudb::match_graph_markov_chain.
solutionTableThe name of the table used to store the results; this table contains a track of geospatial points for the matched portion of the graph, a track ID, and a score value. Also outputs a details table containing a trip ID (that matches the track ID), the latitude/longitude pair, the timestamp the point was recorded at, and an edge ID corresponding to the matched road segment. Has the same naming restrictions as tables. Must not be an existing table of the same name.
optionsAdditional parameters
  • gpudb::match_graph_gps_noise: GPS noise value (in meters) to remove redundant sample points. Use -1 to disable noise reduction. The default value accounts for 95% of point variation (+ or -5 meters). The default value is '5.0'.
  • gpudb::match_graph_num_segments: Maximum number of potentially matching road segments for each sample point. For the markov_chain solver, the default is 3. The default value is '3'.
  • gpudb::match_graph_search_radius: Maximum search radius used when snapping sample points onto potentially matching surrounding segments. The default value corresponds to approximately 100 meters. The default value is '0.001'.
  • gpudb::match_graph_chain_width: For the markov_chain solver only. Length of the sample points lookahead window within the Markov kernel; the larger the number, the more accurate the solution. The default value is '9'.
  • gpudb::match_graph_source: Optional WKT starting point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.
  • gpudb::match_graph_destination: Optional WKT ending point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.
  • gpudb::match_graph_partial_loading: For the match_supply_demand solver only. When false (non-default), trucks do not off-load at the demand (store) side if the remainder is less than the store's need The default value is gpudb::match_graph_true.
  • gpudb::match_graph_max_combinations: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the demand locations - can increase this up to 2M. The default value is '10000'.
  • gpudb::match_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::match_graph_aggregated_output: For the match_supply_demand solver only. When it is true (default), each record in the output table shows a particular truck's scheduled cumulative round trip path (MULTILINESTRING) and the corresponding aggregated cost. Otherwise, each record shows a single scheduled truck route (LINESTRING) towards a particular demand location (store id) with its corresponding cost. The default value is 'true'.
  • gpudb::match_graph_max_trip_cost: For the match_supply_demand solver only. If this constraint is greater than zero (default) then the trucks will skip travelling from one demand location to another if the cost between them is greater than this number (distance or time). Zero (default) value means no check is performed. The default value is '0.0'.
  • gpudb::match_graph_filter_folding_paths: For the markov_chain solver only. When true (non-default), the paths per sequence combination is checked for folding over patterns and can significantly increase the execution time depending on the chain width and the number of gps samples. The default value is gpudb::match_graph_false.
  • gpudb::match_graph_unit_unloading_cost: For the match_supply_demand solver only. The unit cost per load amount to be delivered. If this value is greater than zero (default) then the additional cost of this unit load multiplied by the total dropped load will be added over to the trip cost to the demand location. The default value is '0.0'.
  • gpudb::match_graph_max_num_threads: For the markov_chain solver only. If specified (greater than zero), the maximum number of threads will not be greater than the specified value. It can be lower due to the memory and the number cores available. Default value of zero allows the algorithm to set the maximal number of threads within these constraints. The default value is '0'.
  • gpudb::match_graph_truck_service_limit: For the match_supply_demand solver only. If specified (greather than zero), any truck's total service cost (distance or time) will be limited by the specified value including multiple rounds (if set). The default value is '0.0'.
  • gpudb::match_graph_enable_truck_reuse: For the match_supply_demand solver only. If specified (true), all trucks can be scheduled for second rounds from their originating depots. The default value is gpudb::match_graph_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).
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).

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.
MergeRecordsResponse& 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).
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).

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.
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,
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).
ModifyGraphResponse modifyGraph ( const ModifyGraphRequest &  request_) const

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ModifyGraphResponse& modifyGraph ( const ModifyGraphRequest &  request_,
ModifyGraphResponse &  response_ 
) const

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

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).
ModifyGraphResponse modifyGraph ( const std::string &  graphName,
const std::vector< std::string > &  nodes,
const std::vector< std::string > &  edges,
const std::vector< std::string > &  weights,
const std::vector< std::string > &  restrictions,
const std::map< std::string, std::string > &  options 
) const

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to modify.
nodesNodes with which to update existing nodes in graph specified by graphName. Review Nodes for more information. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or raw values, e.g., '{9, 10, 11} AS NODE_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
edgesEdges with which to update existing edges in graph specified by graphName. Review Edges for more information. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or raw values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
weightsWeights with which to update existing weights in graph specified by graphName. Review Weights for more information. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or raw values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
restrictionsRestrictions with which to update existing restrictions in graph specified by graphName. Review Restrictions for more information. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ModifyGraphResponse& modifyGraph ( const std::string &  graphName,
const std::vector< std::string > &  nodes,
const std::vector< std::string > &  edges,
const std::vector< std::string > &  weights,
const std::vector< std::string > &  restrictions,
const std::map< std::string, std::string > &  options,
ModifyGraphResponse &  response_ 
) const

Update an existing graph network using given nodes, edges, weights, restrictions, and options.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to modify.
nodesNodes with which to update existing nodes in graph specified by graphName. Review Nodes for more information. Nodes must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS NODE_ID', expressions, e.g., 'ST_MAKEPOINT(column1, column2) AS NODE_WKTPOINT', or raw values, e.g., '{9, 10, 11} AS NODE_ID'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
edgesEdges with which to update existing edges in graph specified by graphName. Review Edges for more information. Edges must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS EDGE_ID', expressions, e.g., 'SUBSTR(column, 1, 6) AS EDGE_NODE1_NAME', or raw values, e.g., "{'family', 'coworker'} AS EDGE_LABEL". If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
weightsWeights with which to update existing weights in graph specified by graphName. Review Weights for more information. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or raw values, e.g., '{4, 15} AS WEIGHTS_VALUESPECIFIED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
restrictionsRestrictions with which to update existing restrictions in graph specified by graphName. Review Restrictions for more information. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination. Identifier combination(s) do not have to match the method used to create the graph, e.g., if column names were specified to create the graph, expressions or raw values could also be used to modify the graph.
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).
QueryGraphResponse queryGraph ( const QueryGraphRequest &  request_) const

Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.

To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries. This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.

To return the adjacency list in the response, leave adjacencyTable empty. To return the adjacency list in a table and not in the response, provide a value to adjacencyTable and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to adjacencyTable and set export_query_results to true.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
QueryGraphResponse& queryGraph ( const QueryGraphRequest &  request_,
QueryGraphResponse &  response_ 
) const

Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.

To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries. This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.

To return the adjacency list in the response, leave adjacencyTable empty. To return the adjacency list in a table and not in the response, provide a value to adjacencyTable and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to adjacencyTable and set export_query_results to true.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.

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).
QueryGraphResponse queryGraph ( const std::string &  graphName,
const std::vector< std::string > &  queries,
const std::vector< std::string > &  restrictions,
const std::string &  adjacencyTable,
const int32_t  rings,
const std::map< std::string, std::string > &  options 
) const

Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.

To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries. This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.

To return the adjacency list in the response, leave adjacencyTable empty. To return the adjacency list in a table and not in the response, provide a value to adjacencyTable and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to adjacencyTable and set export_query_results to true.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to query.
queriesNodes or edges to be queried specified using query identifiers. Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.
restrictionsAdditional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination.
adjacencyTableName of the table to store the resulting adjacencies. If left blank, the query results are instead returned in the response even if export_query_results is set to false. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in queries, then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information.
ringsSets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in queries and restrictions will be returned. This parameter is only applicable when querying nodes.
optionsAdditional parameters
Returns
Response object containing the result of the operation.
QueryGraphResponse& queryGraph ( const std::string &  graphName,
const std::vector< std::string > &  queries,
const std::vector< std::string > &  restrictions,
const std::string &  adjacencyTable,
const int32_t  rings,
const std::map< std::string, std::string > &  options,
QueryGraphResponse &  response_ 
) const

Employs a topological query on a network graph generated a-priori by const and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.

To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to queries. This field can be populated with column values from any table as long as the type is supported by the given identifier. See Query Identifiers for more information.

To return the adjacency list in the response, leave adjacencyTable empty. To return the adjacency list in a table and not in the response, provide a value to adjacencyTable and set export_query_results to false. To return the adjacency list both in a table and the response, provide a value to adjacencyTable and set export_query_results to true.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /query/graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to query.
queriesNodes or edges to be queried specified using query identifiers. Identifiers can be used with existing column names, e.g., 'table.column AS QUERY_NODE_ID', raw values, e.g., '{0, 2} AS QUERY_NODE_ID', or expressions, e.g., 'ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT'. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.
restrictionsAdditional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or raw values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using raw values in an identifier combination, the number of values specified must match across the combination.
adjacencyTableName of the table to store the resulting adjacencies. If left blank, the query results are instead returned in the response even if export_query_results is set to false. If the 'QUERY_TARGET_NODE_LABEL' query identifier is used in queries, then two additional columns will be available: 'PATH_ID' and 'RING_ID'. See Using Labels for more information.
ringsSets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. Also known as number of hops. For example, if it is set to '2', the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to '0', any nodes that meet the criteria in queries and restrictions will be returned. This parameter is only applicable when querying nodes.
optionsAdditional 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).
RevokePermissionProcResponse revokePermissionProc ( const RevokePermissionProcRequest &  request_) const

Revokes a proc-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.
RevokePermissionProcResponse& revokePermissionProc ( const RevokePermissionProcRequest &  request_,
RevokePermissionProcResponse &  response_ 
) const

Revokes a proc-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).
RevokePermissionProcResponse revokePermissionProc ( const std::string &  name,
const std::string &  permission,
const std::string &  procName,
const std::map< std::string, std::string > &  options 
) const

Revokes a proc-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.
procNameName of the proc to which the permission grants access. Must be an existing proc, or an empty string if the permission grants access to all procs.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
RevokePermissionProcResponse& revokePermissionProc ( const std::string &  name,
const std::string &  permission,
const std::string &  procName,
const std::map< std::string, std::string > &  options,
RevokePermissionProcResponse &  response_ 
) const

Revokes a proc-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.
procNameName of the proc to which the permission grants access. Must be an existing proc, or an empty string if the permission grants access to all procs.
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).
RevokePermissionSystemResponse 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.
RevokePermissionSystemResponse& 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).
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.

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.
RevokePermissionSystemResponse& 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).
RevokePermissionTableResponse 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.
RevokePermissionTableResponse& 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).
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.

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.
RevokePermissionTableResponse& 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).
RevokeRoleResponse 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.
RevokeRoleResponse& 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).
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.

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.
RevokeRoleResponse& 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).
ShowGraphResponse showGraph ( const ShowGraphRequest &  request_) const

Shows information and characteristics of graphs that exist on the graph server.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ShowGraphResponse& showGraph ( const ShowGraphRequest &  request_,
ShowGraphResponse &  response_ 
) const

Shows information and characteristics of graphs that exist on the graph server.

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).
ShowGraphResponse showGraph ( const std::string &  graphName,
const std::map< std::string, std::string > &  options 
) const

Shows information and characteristics of graphs that exist on the graph server.

Parameters
graphNameName of the graph on which to retrieve information. If left as the default value, information about all graphs is returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ShowGraphResponse& showGraph ( const std::string &  graphName,
const std::map< std::string, std::string > &  options,
ShowGraphResponse &  response_ 
) const

Shows information and characteristics of graphs that exist on the graph server.

Parameters
graphNameName of the graph on which to retrieve information. If left as the default value, information about all graphs 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).
ShowProcResponse 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.
ShowProcResponse& 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).
ShowProcResponse 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.
ShowProcResponse& 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).
ShowProcStatusResponse showProcStatus ( const ShowProcStatusRequest &  request_) const

Shows the statuses of running or completed proc instances.

Results are grouped by run ID (as returned from 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.
ShowProcStatusResponse& 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 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).
ShowProcStatusResponse 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 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 proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed proc instances will be returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ShowProcStatusResponse& 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 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 proc instance for which the status will be returned. If a proc with a matching run ID is not found, the response will be empty. If not specified, the statuses of all executed 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).
ShowResourceGroupsResponse showResourceGroups ( const ShowResourceGroupsRequest &  request_) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ShowResourceGroupsResponse& showResourceGroups ( const ShowResourceGroupsRequest &  request_,
ShowResourceGroupsResponse &  response_ 
) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

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).
ShowResourceGroupsResponse showResourceGroups ( const std::vector< std::string > &  names,
const std::map< std::string, std::string > &  options 
) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

Parameters
namesList of names of groups to be shown. A single entry with an empty string returns all groups.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ShowResourceGroupsResponse& showResourceGroups ( const std::vector< std::string > &  names,
const std::map< std::string, std::string > &  options,
ShowResourceGroupsResponse &  response_ 
) const

Requests resource group properties.

Returns detailed information about the requested resource groups.

Parameters
namesList of names of groups to be shown. A single entry with an empty string returns all groups.
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).
ShowResourceStatisticsResponse showResourceStatistics ( const ShowResourceStatisticsRequest &  request_) const

Requests various statistics for storage/memory tiers and resource groups.

Returns statistics on a per-rank basis.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ShowResourceStatisticsResponse& showResourceStatistics ( const ShowResourceStatisticsRequest &  request_,
ShowResourceStatisticsResponse &  response_ 
) const

Requests various statistics for storage/memory tiers and resource groups.

Returns statistics on a per-rank basis.

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).
ShowResourceStatisticsResponse showResourceStatistics ( const std::map< std::string, std::string > &  options) const

Requests various statistics for storage/memory tiers and resource groups.

Returns statistics on a per-rank basis.

Parameters
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ShowResourceStatisticsResponse& showResourceStatistics ( const std::map< std::string, std::string > &  options,
ShowResourceStatisticsResponse &  response_ 
) const

Requests various statistics for storage/memory tiers and resource groups.

Returns statistics on a per-rank basis.

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).
ShowSecurityResponse 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.
ShowSecurityResponse& 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).
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.

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.
ShowSecurityResponse& 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).
ShowSqlProcResponse showSqlProc ( const ShowSqlProcRequest &  request_) const

Shows information about SQL procedures, including the full definition of each requested procedure.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ShowSqlProcResponse& showSqlProc ( const ShowSqlProcRequest &  request_,
ShowSqlProcResponse &  response_ 
) const

Shows information about SQL procedures, including the full definition of each requested procedure.

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).
ShowSqlProcResponse showSqlProc ( const std::string &  procedureName,
const std::map< std::string, std::string > &  options 
) const

Shows information about SQL procedures, including the full definition of each requested procedure.

Parameters
procedureNameName of the procedure for which to retrieve the information. If blank, then information about all procedures is returned.
optionsOptional parameters.
Returns
Response object containing the result of the operation.
ShowSqlProcResponse& showSqlProc ( const std::string &  procedureName,
const std::map< std::string, std::string > &  options,
ShowSqlProcResponse &  response_ 
) const

Shows information about SQL procedures, including the full definition of each requested procedure.

Parameters
procedureNameName of the procedure for which to retrieve the information. If blank, then information about all procedures 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).
ShowStatisticsResponse showStatistics ( const ShowStatisticsRequest &  request_) const

Retrieves the collected column statistics for the specified table.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ShowStatisticsResponse& showStatistics ( const ShowStatisticsRequest &  request_,
ShowStatisticsResponse &  response_ 
) const

Retrieves the collected column statistics for the specified 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).
ShowStatisticsResponse showStatistics ( const std::vector< std::string > &  tableNames,
const std::map< std::string, std::string > &  options 
) const

Retrieves the collected column statistics for the specified table.

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.
ShowStatisticsResponse& showStatistics ( const std::vector< std::string > &  tableNames,
const std::map< std::string, std::string > &  options,
ShowStatisticsResponse &  response_ 
) const

Retrieves the collected column statistics for the specified table.

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).
ShowSystemPropertiesResponse 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.
ShowSystemPropertiesResponse& 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).
ShowSystemPropertiesResponse 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.
ShowSystemPropertiesResponse& 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).
ShowSystemStatusResponse 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.
ShowSystemStatusResponse& 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).
ShowSystemStatusResponse 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.
ShowSystemStatusResponse& 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).
ShowSystemTimingResponse 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.
ShowSystemTimingResponse& 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).
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.

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.
ShowSystemTimingResponse& 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).
ShowTableResponse showTable ( const ShowTableRequest &  request_) const

Retrieves detailed information about a table, view, or collection, specified in tableName.

If the supplied tableName is a collection, the call can return information about either the collection itself or the tables and views it contains. If tableName is empty, information about all collections and top-level tables and views can be returned.

If the option get_sizes is set to true, then the number of records in each table is returned (in sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.

To retrieve a list of every table, view, and collection in the database, set tableName to '*' and show_children to true.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
ShowTableResponse& showTable ( const ShowTableRequest &  request_,
ShowTableResponse &  response_ 
) const

Retrieves detailed information about a table, view, or collection, specified in tableName.

If the supplied tableName is a collection, the call can return information about either the collection itself or the tables and views it contains. If tableName is empty, information about all collections and top-level tables and views can be returned.

If the option get_sizes is set to true, then the number of records in each table is returned (in sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.

To retrieve a list of every table, view, and collection in the database, set tableName to '*' and show_children to true.

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).
ShowTableResponse showTable ( const std::string &  tableName,
const std::map< std::string, std::string > &  options 
) const

Retrieves detailed information about a table, view, or collection, specified in tableName.

If the supplied tableName is a collection, the call can return information about either the collection itself or the tables and views it contains. If tableName is empty, information about all collections and top-level tables and views can be returned.

If the option get_sizes is set to true, then the number of records in each table is returned (in sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.

To retrieve a list of every table, view, and collection in the database, set tableName to '*' and show_children to true.

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.
ShowTableResponse& showTable ( const std::string &  tableName,
const std::map< std::string, std::string > &  options,
ShowTableResponse &  response_ 
) const

Retrieves detailed information about a table, view, or collection, specified in tableName.

If the supplied tableName is a collection, the call can return information about either the collection itself or the tables and views it contains. If tableName is empty, information about all collections and top-level tables and views can be returned.

If the option get_sizes is set to true, then the number of records in each table is returned (in sizes and fullSizes), along with the total number of objects across all requested tables (in totalSize and totalFullSize).

For a collection, setting the show_children option to false returns only information about the collection itself; setting show_children to true returns a list of tables and views contained in the collection, along with their corresponding detail.

To retrieve a list of every table, view, and collection in the database, set tableName to '*' and show_children to true.

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).
ShowTableMetadataResponse 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.
ShowTableMetadataResponse& 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).
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.

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.
ShowTableMetadataResponse& 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).
ShowTablesByTypeResponse 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.
ShowTablesByTypeResponse& 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).
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.

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.
ShowTablesByTypeResponse& 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).
ShowTriggersResponse 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.
ShowTriggersResponse& 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).
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.

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.
ShowTriggersResponse& 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).
ShowTypesResponse 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.
ShowTypesResponse& 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).
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.

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.
ShowTypesResponse& 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).
SolveGraphResponse solveGraph ( const SolveGraphRequest &  request_) const

Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
SolveGraphResponse& solveGraph ( const SolveGraphRequest &  request_,
SolveGraphResponse &  response_ 
) const

Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

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).
SolveGraphResponse solveGraph ( const std::string &  graphName,
const std::vector< std::string > &  weightsOnEdges,
const std::vector< std::string > &  restrictions,
const std::string &  solverType,
const std::vector< std::string > &  sourceNodes,
const std::vector< std::string > &  destinationNodes,
const std::string &  solutionTable,
const std::map< std::string, std::string > &  options 
) const

Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to solve.
weightsOnEdgesAdditional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15, 2} AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s). If using constant values in an identifier combination, the number of values specified must match across the combination.
restrictionsAdditional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED').
solverTypeThe type of solver to use for the graph.
  • gpudb::solve_graph_SHORTEST_PATH: Solves for the optimal (shortest) path based on weights and restrictions from one source to destinations nodes. Also known as the Dijkstra solver.
  • gpudb::solve_graph_PAGE_RANK: Solves for the probability of each destination node being visited based on the links of the graph topology. Weights are not required to use this solver.
  • gpudb::solve_graph_PROBABILITY_RANK: Solves for the transitional probability (Hidden Markov) for each node based on the weights (probability assigned over given edges).
  • gpudb::solve_graph_CENTRALITY: Solves for the degree of a node to depict how many pairs of individuals that would have to go through the node to reach one another in the minimum number of hops. Also known as betweenness.
  • gpudb::solve_graph_MULTIPLE_ROUTING: Solves for finding the minimum cost cumulative path for a round-trip starting from the given source and visiting each given destination node once then returning to the source. Also known as the travelling salesman problem.
  • gpudb::solve_graph_INVERSE_SHORTEST_PATH: Solves for finding the optimal path cost for each destination node to route to the source node. Also known as inverse Dijkstra or the service man routing problem.
  • gpudb::solve_graph_BACKHAUL_ROUTING: Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
  • gpudb::solve_graph_ALLPATHS: Solves for paths that would give costs between max and min solution radia - Make sure to limit by the 'max_solution_targets' option. Min cost shoudl be >= shortest_path cost.
The default value is gpudb::solve_graph_SHORTEST_PATH.
sourceNodesIt can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets.
destinationNodesIt can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets.
solutionTableName of the table to store the solution.
optionsAdditional parameters
  • gpudb::solve_graph_max_solution_radius: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
  • gpudb::solve_graph_min_solution_radius: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
  • gpudb::solve_graph_max_solution_targets: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destinationNodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '0'.
  • gpudb::solve_graph_export_solve_results: Returns solution results inside the resultPerDestinationNode array in the response if set to true. The default value is gpudb::solve_graph_false.
  • gpudb::solve_graph_remove_previous_restrictions: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. The default value is gpudb::solve_graph_false.
  • gpudb::solve_graph_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.
  • gpudb::solve_graph_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
  • gpudb::solve_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_num_best_paths: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
  • gpudb::solve_graph_max_num_combinations: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
  • gpudb::solve_graph_accurate_snaps: Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge. For the latter case (false), the solver modifies the resulting cost with the weights proportional to the ratio of the snap location within the edge. This may be an over-kill when the performance is considered and the difference is well less than 1 percent. In batch runs, since the performance is of utmost importance, the option is always considered 'false'. The default value is gpudb::solve_graph_true.
  • gpudb::solve_graph_output_edge_path: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. The default value is gpudb::solve_graph_false.
  • gpudb::solve_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. The default value is gpudb::solve_graph_true.
Returns
Response object containing the result of the operation.
SolveGraphResponse& solveGraph ( const std::string &  graphName,
const std::vector< std::string > &  weightsOnEdges,
const std::vector< std::string > &  restrictions,
const std::string &  solverType,
const std::vector< std::string > &  sourceNodes,
const std::vector< std::string > &  destinationNodes,
const std::string &  solutionTable,
const std::map< std::string, std::string > &  options,
SolveGraphResponse &  response_ 
) const

Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.

IMPORTANT: It's highly recommended that you review the Network Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.

Parameters
graphNameName of the graph resource to solve.
weightsOnEdgesAdditional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED', or constant values, e.g., '{4, 15, 2} AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s). If using constant values in an identifier combination, the number of values specified must match across the combination.
restrictionsAdditional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED', or constant values, e.g., '{0, 0, 0, 1} AS RESTRICTIONS_ONOFFCOMPARED'. If using constant values in an identifier combination, the number of values specified must match across the combination. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED').
solverTypeThe type of solver to use for the graph.
  • gpudb::solve_graph_SHORTEST_PATH: Solves for the optimal (shortest) path based on weights and restrictions from one source to destinations nodes. Also known as the Dijkstra solver.
  • gpudb::solve_graph_PAGE_RANK: Solves for the probability of each destination node being visited based on the links of the graph topology. Weights are not required to use this solver.
  • gpudb::solve_graph_PROBABILITY_RANK: Solves for the transitional probability (Hidden Markov) for each node based on the weights (probability assigned over given edges).
  • gpudb::solve_graph_CENTRALITY: Solves for the degree of a node to depict how many pairs of individuals that would have to go through the node to reach one another in the minimum number of hops. Also known as betweenness.
  • gpudb::solve_graph_MULTIPLE_ROUTING: Solves for finding the minimum cost cumulative path for a round-trip starting from the given source and visiting each given destination node once then returning to the source. Also known as the travelling salesman problem.
  • gpudb::solve_graph_INVERSE_SHORTEST_PATH: Solves for finding the optimal path cost for each destination node to route to the source node. Also known as inverse Dijkstra or the service man routing problem.
  • gpudb::solve_graph_BACKHAUL_ROUTING: Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
  • gpudb::solve_graph_ALLPATHS: Solves for paths that would give costs between max and min solution radia - Make sure to limit by the 'max_solution_targets' option. Min cost shoudl be >= shortest_path cost.
The default value is gpudb::solve_graph_SHORTEST_PATH.
sourceNodesIt can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets.
destinationNodesIt can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets.
solutionTableName of the table to store the solution.
optionsAdditional parameters
  • gpudb::solve_graph_max_solution_radius: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
  • gpudb::solve_graph_min_solution_radius: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
  • gpudb::solve_graph_max_solution_targets: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destinationNodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '0'.
  • gpudb::solve_graph_export_solve_results: Returns solution results inside the resultPerDestinationNode array in the response if set to true. The default value is gpudb::solve_graph_false.
  • gpudb::solve_graph_remove_previous_restrictions: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. The default value is gpudb::solve_graph_false.
  • gpudb::solve_graph_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.
  • gpudb::solve_graph_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
  • gpudb::solve_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'.
  • gpudb::solve_graph_num_best_paths: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
  • gpudb::solve_graph_max_num_combinations: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
  • gpudb::solve_graph_accurate_snaps: Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge. For the latter case (false), the solver modifies the resulting cost with the weights proportional to the ratio of the snap location within the edge. This may be an over-kill when the performance is considered and the difference is well less than 1 percent. In batch runs, since the performance is of utmost importance, the option is always considered 'false'. The default value is gpudb::solve_graph_true.
  • gpudb::solve_graph_output_edge_path: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. The default value is gpudb::solve_graph_false.
  • gpudb::solve_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. The default value is gpudb::solve_graph_true.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).
template<typename TRequest >
UpdateRecordsResponse updateRecords ( const UpdateRecordsRequest< TRequest > &  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.Note that this operation can only be run on an original table and not on a collection or a result view.

The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.

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 22605 of file GPUdbFunctions.hpp.

template<typename TRequest >
UpdateRecordsResponse& updateRecords ( const UpdateRecordsRequest< TRequest > &  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.Note that this operation can only be run on an original table and not on a collection or a result view.

The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.

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 22658 of file GPUdbFunctions.hpp.

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.

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.Note that this operation can only be run on an original table and not on a collection or a result view.

The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.

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 22795 of file GPUdbFunctions.hpp.

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,
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.Note that this operation can only be run on an original table and not on a collection or a result view.

The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.

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 22939 of file GPUdbFunctions.hpp.

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.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
UpdateRecordsBySeriesResponse& 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).
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.

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.
viewNamename of the view containing the series (tracks) which have to be updated.
reserved
optionsOptional parameters.
Returns
Response object containing the result of the operation.
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,
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.
viewNamename 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).
UpdateRecordsResponse 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.Note that this operation can only be run on an original table and not on a collection or a result view.

The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
UpdateRecordsResponse& 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.Note that this operation can only be run on an original table and not on a collection or a result view.

The update_on_existing_pk option specifies the record collision policy for tables with a primary key, and is ignored on tables with no primary key.

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).
VisualizeImageChartResponse 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.
VisualizeImageChartResponse& 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).
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.

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.
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,
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).
VisualizeIsochroneResponse visualizeIsochrone ( const VisualizeIsochroneRequest &  request_) const

Generate an image containing isolines for travel results using an existing graph.

Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Network Graphs & Solvers for more information on graphs.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.
VisualizeIsochroneResponse& visualizeIsochrone ( const VisualizeIsochroneRequest &  request_,
VisualizeIsochroneResponse &  response_ 
) const

Generate an image containing isolines for travel results using an existing graph.

Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Network Graphs & Solvers for more information on graphs.

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).
VisualizeIsochroneResponse visualizeIsochrone ( const std::string &  graphName,
const std::string &  sourceNode,
const double  maxSolutionRadius,
const std::vector< std::string > &  weightsOnEdges,
const std::vector< std::string > &  restrictions,
const int32_t  numLevels,
const bool  generateImage,
const std::string &  levelsTable,
const std::map< std::string, std::string > &  styleOptions,
const std::map< std::string, std::string > &  solveOptions,
const std::map< std::string, std::string > &  contourOptions,
const std::map< std::string, std::string > &  options 
) const

Generate an image containing isolines for travel results using an existing graph.

Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Network Graphs & Solvers for more information on graphs.

Parameters
graphNameName of the graph on which the isochrone is to be computed.
sourceNodeStarting vertex on the underlying graph from/to which the isochrones are created.
maxSolutionRadiusExtent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius.
weightsOnEdgesAdditional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', or expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s).
restrictionsAdditional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', or expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED'. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED').
numLevelsNumber of equally-separated isochrones to compute.
generateImageIf set to true, generates a PNG image of the isochrones in the response. The default value is gpudb::visualize_isochrone_true.
levelsTableName of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated.
styleOptionsVarious style related options of the isochrone image.
solveOptionsSolver specific parameters
contourOptionsSolver specific parameters
optionsAdditional parameters
Returns
Response object containing the result of the operation.
VisualizeIsochroneResponse& visualizeIsochrone ( const std::string &  graphName,
const std::string &  sourceNode,
const double  maxSolutionRadius,
const std::vector< std::string > &  weightsOnEdges,
const std::vector< std::string > &  restrictions,
const int32_t  numLevels,
const bool  generateImage,
const std::string &  levelsTable,
const std::map< std::string, std::string > &  styleOptions,
const std::map< std::string, std::string > &  solveOptions,
const std::map< std::string, std::string > &  contourOptions,
const std::map< std::string, std::string > &  options,
VisualizeIsochroneResponse &  response_ 
) const

Generate an image containing isolines for travel results using an existing graph.

Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Network Graphs & Solvers for more information on graphs.

Parameters
graphNameName of the graph on which the isochrone is to be computed.
sourceNodeStarting vertex on the underlying graph from/to which the isochrones are created.
maxSolutionRadiusExtent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius.
weightsOnEdgesAdditional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS WEIGHTS_EDGE_ID', or expressions, e.g., 'ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED'. Any provided weights will be added (in the case of 'WEIGHTS_VALUESPECIFIED') to or multiplied with (in the case of 'WEIGHTS_FACTORSPECIFIED') the existing weight(s).
restrictionsAdditional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., 'table.column AS RESTRICTIONS_EDGE_ID', or expressions, e.g., 'column/2 AS RESTRICTIONS_VALUECOMPARED'. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED').
numLevelsNumber of equally-separated isochrones to compute.
generateImageIf set to true, generates a PNG image of the isochrones in the response. The default value is gpudb::visualize_isochrone_true.
levelsTableName of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated.
styleOptionsVarious style related options of the isochrone image.
solveOptionsSolver specific parameters
contourOptionsSolver specific parameters
optionsAdditional 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).