|
GPUdb C++ API
Version 7.0.19.0
|
|
GPUdb C++ API
Version 7.0.19.0
|
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 > ¶ms, 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 > ¶ms, 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... | |
| 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:
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.
| [in] | request_ | Request object containing the parameters for 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:
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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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:
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.
| hosts | The 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. |
| configParams | Configuration 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. |
| options | Optional parameters.
|
| 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:
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.
| hosts | The 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. | |
| configParams | Configuration 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| jobIds | Jobs to be modified. |
| action | Action to be performed on the jobs specified by job_ids. |
| options | Optional parameters. |
| 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.
| jobIds | Jobs to be modified. | |
| action | Action to be performed on the jobs specified by job_ids. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| offline | Set to true if desired state is offline. |
| options | Optional parameters.
|
| 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.
| offline | Set to true if desired state is offline. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters.
|
| 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.
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| ranks | Rank numbers of the ranks to be removed from the cluster. |
| options | Optional parameters.
|
| 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.
| ranks | Rank numbers of the ranks to be removed from the cluster. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowAlertsResponse adminShowAlerts | ( | const AdminShowAlertsRequest & | request_ | ) | const |
Requests a list of the most recent alerts.
Returns lists of alert data, including timestamp and type.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| numAlerts | Number 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. |
| options | Optional parameters. |
| 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.
| numAlerts | Number 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| historyIndex | Indicates which cluster operation to retrieve. Use 0 for the most recent. |
| options | Optional parameters. |
| 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.
| historyIndex | Indicates which cluster operation to retrieve. Use 0 for the most recent. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowJobsResponse adminShowJobs | ( | const AdminShowJobsRequest & | request_ | ) | const |
Get a list of the current jobs in GPUdb.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminShowJobsResponse& adminShowJobs | ( | const AdminShowJobsRequest & | request_, |
| AdminShowJobsResponse & | response_ | ||
| ) | const |
Get a list of the current jobs in GPUdb.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowJobsResponse adminShowJobs | ( | const std::map< std::string, std::string > & | options | ) | const |
Get a list of the current jobs in GPUdb.
| options | Optional parameters.
|
| AdminShowJobsResponse& adminShowJobs | ( | const std::map< std::string, std::string > & | options, |
| AdminShowJobsResponse & | response_ | ||
| ) | const |
Get a list of the current jobs in GPUdb.
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters. |
| 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.
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShutdownResponse adminShutdown | ( | const AdminShutdownRequest & | request_ | ) | const |
Exits the database server application.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminShutdownResponse& adminShutdown | ( | const AdminShutdownRequest & | request_, |
| AdminShutdownResponse & | response_ | ||
| ) | const |
Exits the database server application.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShutdownResponse adminShutdown | ( | const std::string & | exitType, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Exits the database server application.
| exitType | Reserved for future use. User can pass an empty string. |
| authorization | No longer used. User can pass an empty string. |
| options | Optional parameters. |
| 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.
| exitType | Reserved for future use. User can pass an empty string. | |
| authorization | No longer used. User can pass an empty string. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters.
|
| 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.
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateConvexHullResponse aggregateConvexHull | ( | const AggregateConvexHullRequest & | request_ | ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
| tableName | Name of table on which the operation will be performed. Must be an existing table. It cannot be a collection. |
| xColumnName | Name of the column containing the x coordinates of the points for the operation being performed. |
| yColumnName | Name of the column containing the y coordinates of the points for the operation being performed. |
| options | Optional parameters. |
| 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.
| tableName | Name of table on which the operation will be performed. Must be an existing table. It cannot be a collection. | |
| xColumnName | Name of the column containing the x coordinates of the points for the operation being performed. | |
| yColumnName | Name of the column containing the y coordinates of the points for the operation being performed. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of an existing table or view on which the operation will be performed. |
| columnNames | List of one or more column names, expressions, and aggregate expressions. |
| offset | A 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. |
| limit | A 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 | Optional parameters.
|
| 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.
| tableName | Name of an existing table or view on which the operation will be performed. | |
| columnNames | List of one or more column names, expressions, and aggregate expressions. | |
| offset | A 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. | |
| limit | A 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 | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table or collection. |
| columnName | Name of a column or an expression of one or more column names over which the histogram will be calculated. |
| start | Lower end value of the histogram interval, inclusive. |
| end | Upper end value of the histogram interval, inclusive. |
| interval | The size of each bin within the start and end parameters. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table or collection. | |
| columnName | Name of a column or an expression of one or more column names over which the histogram will be calculated. | |
| start | Lower end value of the histogram interval, inclusive. | |
| end | Upper end value of the histogram interval, inclusive. | |
| interval | The size of each bin within the start and end parameters. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table or collection. |
| columnNames | List 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. |
| k | The number of mean points to be determined by the algorithm. |
| tolerance | Stop iterating when the distances between successive points is less than the given tolerance. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table or collection. | |
| columnNames | List 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. | |
| k | The number of mean points to be determined by the algorithm. | |
| tolerance | Stop iterating when the distances between successive points is less than the given tolerance. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateMinMaxResponse aggregateMinMax | ( | const AggregateMinMaxRequest & | request_ | ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table. |
| columnName | Name of a column or an expression of one or more column on which the min-max will be calculated. |
| options | Optional parameters. |
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table. | |
| columnName | Name of a column or an expression of one or more column on which the min-max will be calculated. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table. |
| columnName | Name of a geospatial geometry column on which the min-max will be calculated. |
| options | Optional parameters. |
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table. | |
| columnName | Name of a geospatial geometry column on which the min-max will be calculated. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the statistics operation will be performed. |
| columnName | Name of the primary column for which the statistics are to be calculated. |
| stats | Comma separated list of the statistics to calculate, e.g. "sum,mean".
|
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the statistics operation will be performed. | |
| columnName | Name of the primary column for which the statistics are to be calculated. | |
| stats | Comma separated list of the statistics to calculate, e.g. "sum,mean".
| |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the ranged-statistics operation will be performed. |
| selectExpression | For a non-empty expression statistics are calculated for those records for which the expression is true. |
| columnName | Name of the binning-column used to divide the set samples into bins. |
| valueColumnName | Name of the value-column for which statistics are to be computed. |
| stats | A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum. |
| start | The lower bound of the binning-column. |
| end | The upper bound of the binning-column. |
| interval | The 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)). |
| options | Map of optional parameters:
|
| 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.
| tableName | Name of the table on which the ranged-statistics operation will be performed. | |
| selectExpression | For a non-empty expression statistics are calculated for those records for which the expression is true. | |
| columnName | Name of the binning-column used to divide the set samples into bins. | |
| valueColumnName | Name of the value-column for which statistics are to be computed. | |
| stats | A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum. | |
| start | The lower bound of the binning-column. | |
| end | The upper bound of the binning-column. | |
| interval | The 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)). | |
| options | Map of optional parameters:
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of an existing table or view on which the operation will be performed. |
| columnName | Name of the column or an expression containing one or more column names on which the unique function would be applied. |
| offset | A 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. |
| limit | A 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 | Optional parameters.
|
| 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.
| tableName | Name of an existing table or view on which the operation will be performed. | |
| columnName | Name of the column or an expression containing one or more column names on which the unique function would be applied. | |
| offset | A 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. | |
| limit | A 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 | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table/view. |
| columnNames | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
| variableColumnName | Specifies the variable/parameter column name. |
| valueColumnName | Specifies the value column name. |
| pivotedColumns | List 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. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the operation will be performed. Must be an existing table/view. | |
| columnNames | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. | |
| variableColumnName | Specifies the variable/parameter column name. | |
| valueColumnName | Specifies the value column name. | |
| pivotedColumns | List 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterResourceGroupResponse alterResourceGroup | ( | const AlterResourceGroupRequest & | request_ | ) | const |
Alters the properties of an exisiting resource group to facilitate resource management.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterResourceGroupResponse& alterResourceGroup | ( | const AlterResourceGroupRequest & | request_, |
| AlterResourceGroupResponse & | response_ | ||
| ) | const |
Alters the properties of an exisiting resource group to facilitate resource management.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Alters the properties of an exisiting resource group to facilitate resource management.
| name | Name of the group to be altered. Must be an existing resource group name. |
| tierAttributes | Optional 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'}}
|
| ranking | If 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.
|
| adjoiningResourceGroup | If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. |
| options | Optional parameters.
|
| 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.
| name | Name of the group to be altered. Must be an existing resource group name. | |
| tierAttributes | Optional 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'}}
| |
| ranking | If 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.
| |
| adjoiningResourceGroup | If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| AlterRoleResponse alterRole | ( | const AlterRoleRequest & | request_ | ) | const |
Alters a Role.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterRoleResponse& alterRole | ( | const AlterRoleRequest & | request_, |
| AlterRoleResponse & | response_ | ||
| ) | const |
Alters a Role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Alters a Role.
| name | Name of the role to be altered. Must be an existing role. |
| action | Modification operation to be applied to the role.
|
| value | The value of the modification, depending on action. |
| options | Optional parameters. |
| 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.
| name | Name of the role to be altered. Must be an existing role. | |
| action | Modification operation to be applied to the role.
| |
| value | The value of the modification, depending on action. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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').
| [in] | request_ | Request object containing the parameters for 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').
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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').
| propertyUpdatesMap | Map containing the properties of the system to be updated. Error if empty.
|
| options | Optional parameters. |
| 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').
| propertyUpdatesMap | Map containing the properties of the system to be updated. Error if empty.
| |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Table on which the operation will be performed. Must be an existing table, view, or collection. |
| action | Modification operation to be applied
|
| value | The 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. |
| options | Optional parameters.
|
| 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.
| tableName | Table on which the operation will be performed. Must be an existing table, view, or collection. | |
| action | Modification operation to be applied
| |
| value | The 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Table on which the operation will be performed. Must be an existing table or view. |
| columnAlterations | list 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'} ] |
| options | Optional parameters. |
| 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.
| tableName | Table on which the operation will be performed. Must be an existing table or view. | |
| columnAlterations | list 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'} ] | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableNames | Names of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned. |
| metadataMap | A 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. |
| options | Optional parameters. |
| 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.
| tableNames | Names of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned. | |
| metadataMap | A 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| name | Name of the tier to be altered. Must be an existing tier group name. |
| options | Optional parameters.
|
| 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.
| name | Name of the tier to be altered. Must be an existing tier group name. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| AlterUserResponse alterUser | ( | const AlterUserRequest & | request_ | ) | const |
Alters a user.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterUserResponse& alterUser | ( | const AlterUserRequest & | request_, |
| AlterUserResponse & | response_ | ||
| ) | const |
Alters a user.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Alters a user.
| name | Name of the user to be altered. Must be an existing user. |
| action | Modification operation to be applied to the user.
|
| value | The value of the modification, depending on action. |
| options | Optional parameters. |
| 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.
| name | Name of the user to be altered. Must be an existing user. | |
| action | Modification operation to be applied to the user.
| |
| value | The value of the modification, depending on action. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | The table name for the records to be appended. Must be an existing table. |
| sourceTableName | The source table name to get records from. Must be an existing table name. |
| fieldMap | Contains 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. |
| options | Optional parameters.
|
| 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.
| tableName | The table name for the records to be appended. Must be an existing table. | |
| sourceTableName | The source table name to get records from. Must be an existing table name. | |
| fieldMap | Contains 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ClearStatisticsResponse clearStatistics | ( | const ClearStatisticsRequest & | request_ | ) | const |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
| [in] | request_ | Request object containing the parameters for the operation. |
| ClearStatisticsResponse& clearStatistics | ( | const ClearStatisticsRequest & | request_, |
| ClearStatisticsResponse & | response_ | ||
| ) | const |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of a table. Must be an existing table. |
| columnName | Name 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. |
| options | Optional parameters. |
| 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.
| tableName | Name of a table. Must be an existing table. | |
| columnName | Name 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name 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'. |
| authorization | No longer used. User can pass an empty string. |
| options | Optional parameters.
|
| 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.
| tableName | Name 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'. | |
| authorization | No longer used. User can pass an empty string. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ClearTableMonitorResponse clearTableMonitor | ( | const ClearTableMonitorRequest & | request_ | ) | const |
Deactivates a table monitor previously created with const.
| [in] | request_ | Request object containing the parameters for the operation. |
| ClearTableMonitorResponse& clearTableMonitor | ( | const ClearTableMonitorRequest & | request_, |
| ClearTableMonitorResponse & | response_ | ||
| ) | const |
Deactivates a table monitor previously created with const.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ClearTableMonitorResponse clearTableMonitor | ( | const std::string & | topicId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deactivates a table monitor previously created with const.
| topicId | The topic ID returned by /create/tablemonitor. |
| options | Optional parameters. |
| 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.
| topicId | The topic ID returned by /create/tablemonitor. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| triggerId | ID for the trigger to be deactivated. |
| options | Optional parameters. |
| 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.
| triggerId | ID for the trigger to be deactivated. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| CollectStatisticsResponse collectStatistics | ( | const CollectStatisticsRequest & | request_ | ) | const |
Collect statistics for a column(s) in a specified table.
| [in] | request_ | Request object containing the parameters for the operation. |
| CollectStatisticsResponse& collectStatistics | ( | const CollectStatisticsRequest & | request_, |
| CollectStatisticsResponse & | response_ | ||
| ) | const |
Collect statistics for a column(s) in a specified table.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of a table. Must be an existing table. |
| columnNames | List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). |
| options | Optional parameters. |
| 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.
| tableName | Name of a table. Must be an existing table. | |
| columnNames | List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| graphName | Name of the graph resource to generate. |
| directedGraph | If 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. |
| nodes | Nodes 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. |
| edges | Edges 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. |
| weights | Weights 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. |
| restrictions | Restrictions 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. |
| options | Optional parameters.
|
| 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.
| graphName | Name of the graph resource to generate. | |
| directedGraph | If 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. | |
| nodes | Nodes 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. | |
| edges | Edges 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. | |
| weights | Weights 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. | |
| restrictions | Restrictions 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| endpoint | Indicates which endpoint to execute, e.g. '/alter/table'. |
| requestEncoding | The encoding of the request payload for the job. The default value is gpudb::create_job_binary. |
| data | Binary-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. |
| dataStr | JSON-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. |
| options | Optional parameters. |
| 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.
| endpoint | Indicates which endpoint to execute, e.g. '/alter/table'. | |
| requestEncoding | The encoding of the request payload for the job. The default value is gpudb::create_job_binary. | |
| data | Binary-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. | |
| dataStr | JSON-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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| joinTableName | Name of the join table to be created. Has the same naming restrictions as tables. |
| tableNames | The list of table names composing the join. Corresponds to a SQL statement FROM clause. |
| columnNames | List 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. |
| expressions | An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. |
| options | Optional parameters.
|
| 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.
| joinTableName | Name of the join table to be created. Has the same naming restrictions as tables. | |
| tableNames | The list of table names composing the join. Corresponds to a SQL statement FROM clause. | |
| columnNames | List 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. | |
| expressions | An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table to be created that is the top-level table of the materialized view. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table to be created that is the top-level table of the materialized view. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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
| [in] | request_ | Request object containing the parameters for 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
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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
| procName | Name of the proc to be created. Must not be the name of a currently existing proc. |
| executionMode | The execution mode of the proc.
|
| files | A 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. |
| command | The 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. |
| args | An array of command-line arguments that will be passed to command when the proc is executed. |
| options | Optional parameters.
|
| 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
| procName | Name of the proc to be created. Must not be the name of a currently existing proc. | |
| executionMode | The execution mode of the proc.
| |
| files | A 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. | |
| command | The 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. | |
| args | An array of command-line arguments that will be passed to command when the proc is executed. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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)).
| [in] | request_ | Request object containing the parameters for 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)).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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)).
| tableName | Name 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. |
| projectionName | Name of the projection to be created. Has the same naming restrictions as tables. |
| columnNames | List 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'. |
| options | Optional parameters.
|
| 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)).
| tableName | Name 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. | |
| projectionName | Name of the projection to be created. Has the same naming restrictions as tables. | |
| columnNames | List 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'. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| CreateResourceGroupResponse createResourceGroup | ( | const CreateResourceGroupRequest & | request_ | ) | const |
Creates a new resource group to facilitate resource management.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateResourceGroupResponse& createResourceGroup | ( | const CreateResourceGroupRequest & | request_, |
| CreateResourceGroupResponse & | response_ | ||
| ) | const |
Creates a new resource group to facilitate resource management.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Creates a new resource group to facilitate resource management.
| name | Name 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. |
| tierAttributes | Optional 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'}}
|
| ranking | Indicates 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. |
| adjoiningResourceGroup | If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. |
| options | Optional parameters.
|
| 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.
| name | Name 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. | |
| tierAttributes | Optional 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'}}
| |
| ranking | Indicates 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. | |
| adjoiningResourceGroup | If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| CreateRoleResponse createRole | ( | const CreateRoleRequest & | request_ | ) | const |
Creates a new role.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateRoleResponse& createRole | ( | const CreateRoleRequest & | request_, |
| CreateRoleResponse & | response_ | ||
| ) | const |
Creates a new role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateRoleResponse createRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new role.
| name | Name 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. |
| options | Optional parameters.
|
| CreateRoleResponse& createRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| CreateRoleResponse & | response_ | ||
| ) | const |
Creates a new role.
| name | Name 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name 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. |
| typeId | ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true. |
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| typeId | ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table to monitor. Must not refer to a collection. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table to monitor. Must not refer to a collection. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| tableNames | Names of the tables on which the trigger will be activated and maintained. |
| xColumnName | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
| xVector | The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. |
| yColumnName | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
| yVector | The 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. |
| options | Optional parameters. |
| 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.
| requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. | |
| tableNames | Names of the tables on which the trigger will be activated and maintained. | |
| xColumnName | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. | |
| xVector | The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. | |
| yColumnName | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. | |
| yVector | The 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| tableNames | Tables on which the trigger will be active. |
| columnName | Name of a numeric column_name on which the trigger is activated. |
| min | The lower bound (inclusive) for the trigger range. |
| max | The upper bound (inclusive) for the trigger range. |
| options | Optional parameters. |
| 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.
| requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. | |
| tableNames | Tables on which the trigger will be active. | |
| columnName | Name of a numeric column_name on which the trigger is activated. | |
| min | The lower bound (inclusive) for the trigger range. | |
| max | The upper bound (inclusive) for the trigger range. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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"] }
| [in] | request_ | Request object containing the parameters for 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"] }
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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"] }
| typeDefinition | a JSON string describing the columns of the type to be registered. |
| label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
| properties | Each 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).
|
| options | Optional parameters. |
| 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"] }
| typeDefinition | a JSON string describing the columns of the type to be registered. | |
| label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. | |
| properties | Each 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).
| |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table to be created. Has the same naming restrictions as tables. |
| tableNames | The list of table names to merge. Must contain the names of one or more existing tables. |
| inputColumnNames | The list of columns from each of the corresponding input tables. |
| outputColumnNames | The list of names of the columns to be stored in the output table. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table to be created. Has the same naming restrictions as tables. | |
| tableNames | The list of table names to merge. Must contain the names of one or more existing tables. | |
| inputColumnNames | The list of columns from each of the corresponding input tables. | |
| outputColumnNames | The list of names of the columns to be stored in the output table. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| CreateUserExternalResponse createUserExternal | ( | const CreateUserExternalRequest & | request_ | ) | const |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| [in] | request_ | Request object containing the parameters for 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).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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).
| name | Name 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. |
| options | Optional parameters. |
| 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).
| name | Name 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| CreateUserInternalResponse createUserInternal | ( | const CreateUserInternalRequest & | request_ | ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
| [in] | request_ | Request object containing the parameters for 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).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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).
| name | Name 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. |
| password | Initial password of the user to be created. May be an empty string for no password. |
| options | Optional parameters.
|
| 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).
| name | Name 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. | |
| password | Initial password of the user to be created. May be an empty string for no password. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteGraphResponse deleteGraph | ( | const DeleteGraphRequest & | request_ | ) | const |
Deletes an existing graph from the graph server and/or persist.
| [in] | request_ | Request object containing the parameters for the operation. |
| DeleteGraphResponse& deleteGraph | ( | const DeleteGraphRequest & | request_, |
| DeleteGraphResponse & | response_ | ||
| ) | const |
Deletes an existing graph from the graph server and/or persist.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| graphName | Name of the graph to be deleted. |
| options | Optional parameters.
|
| 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.
| graphName | Name of the graph to be deleted. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteProcResponse deleteProc | ( | const DeleteProcRequest & | request_ | ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
| [in] | request_ | Request object containing the parameters for the operation. |
| DeleteProcResponse& deleteProc | ( | const DeleteProcRequest & | request_, |
| DeleteProcResponse & | response_ | ||
| ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| procName | Name of the proc to be deleted. Must be the name of a currently existing proc. |
| options | Optional parameters. |
| 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.
| procName | Name of the proc to be deleted. Must be the name of a currently existing proc. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view. |
| expressions | A 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. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view. | |
| expressions | A 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteResourceGroupResponse deleteResourceGroup | ( | const DeleteResourceGroupRequest & | request_ | ) | const |
Deletes a resource group.
| [in] | request_ | Request object containing the parameters for the operation. |
| DeleteResourceGroupResponse& deleteResourceGroup | ( | const DeleteResourceGroupRequest & | request_, |
| DeleteResourceGroupResponse & | response_ | ||
| ) | const |
Deletes a resource group.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteResourceGroupResponse deleteResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a resource group.
| name | Name of the resource group to be deleted. |
| options | Optional parameters. |
| DeleteResourceGroupResponse& deleteResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteResourceGroupResponse & | response_ | ||
| ) | const |
Deletes a resource group.
| name | Name of the resource group to be deleted. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteRoleResponse deleteRole | ( | const DeleteRoleRequest & | request_ | ) | const |
Deletes an existing role.
| [in] | request_ | Request object containing the parameters for the operation. |
| DeleteRoleResponse& deleteRole | ( | const DeleteRoleRequest & | request_, |
| DeleteRoleResponse & | response_ | ||
| ) | const |
Deletes an existing role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteRoleResponse deleteRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing role.
| name | Name of the role to be deleted. Must be an existing role. |
| options | Optional parameters. |
| DeleteRoleResponse& deleteRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteRoleResponse & | response_ | ||
| ) | const |
Deletes an existing role.
| name | Name of the role to be deleted. Must be an existing role. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteUserResponse deleteUser | ( | const DeleteUserRequest & | request_ | ) | const |
Deletes an existing user.
| [in] | request_ | Request object containing the parameters for the operation. |
| DeleteUserResponse& deleteUser | ( | const DeleteUserRequest & | request_, |
| DeleteUserResponse & | response_ | ||
| ) | const |
Deletes an existing user.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteUserResponse deleteUser | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing user.
| name | Name of the user to be deleted. Must be an existing user. |
| options | Optional parameters. |
| DeleteUserResponse& deleteUser | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteUserResponse & | response_ | ||
| ) | const |
Deletes an existing user.
| name | Name of the user to be deleted. Must be an existing user. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| ExecuteProcResponse executeProc | ( | const ExecuteProcRequest & | request_ | ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
| procName | Name of the proc to execute. Must be the name of a currently existing proc. |
| params | A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. |
| binParams | A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. |
| inputTableNames | Names 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. |
| inputColumnNames | Map 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. |
| outputTableNames | Names 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. |
| options | Optional parameters.
|
| 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.
| procName | Name of the proc to execute. Must be the name of a currently existing proc. | |
| params | A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. | |
| binParams | A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. | |
| inputTableNames | Names 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. | |
| inputColumnNames | Map 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. | |
| outputTableNames | Names 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ExecuteSqlResponse executeSql | ( | const ExecuteSqlRequest & | request_ | ) | const |
SQL Request.
| [in] | request_ | Request object containing the parameters for the operation. |
| ExecuteSqlResponse& executeSql | ( | const ExecuteSqlRequest & | request_, |
| ExecuteSqlResponse & | response_ | ||
| ) | const |
SQL Request.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
SQL Request.
| statement | SQL statement (query, DML, or DDL) to be executed |
| offset | A 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. |
| limit | A 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. |
| requestSchemaStr | Avro schema of data. |
| data | An array of binary-encoded data for the records to be binded to the SQL query. |
| options | Optional parameters.
|
| 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.
| statement | SQL statement (query, DML, or DDL) to be executed | |
| offset | A 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. | |
| limit | A 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. | |
| requestSchemaStr | Avro schema of data. | |
| data | An array of binary-encoded data for the records to be binded to the SQL query. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| RawExecuteSqlResponse executeSqlRaw | ( | const ExecuteSqlRequest & | request_ | ) | const |
SQL Request.
| [in] | request_ | Request object containing the parameters for the operation. |
| RawExecuteSqlResponse& executeSqlRaw | ( | const ExecuteSqlRequest & | request_, |
| RawExecuteSqlResponse & | response_ | ||
| ) | const |
SQL Request.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name 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. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| expression | The select expression to filter the specified table. For details see Expressions. |
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| expression | The select expression to filter the specified table. For details see Expressions. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name 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. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| xColumnName | Name of the column containing the x values to be filtered. |
| xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| yColumnName | Name of the column containing the y values to be filtered. |
| yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| xColumnName | Name of the column containing the x values to be filtered. | |
| xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. | |
| yColumnName | Name of the column containing the y values to be filtered. | |
| yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name 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. |
| viewName | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. |
| columnName | Name of the geospatial geometry column to be filtered. |
| xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| viewName | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. | |
| columnName | Name of the geospatial geometry column to be filtered. | |
| xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. | |
| yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the bounding box operation will be performed. Must be an existing table. |
| viewName | Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. |
| xColumnName | Name of the column on which to perform the bounding box query. Must be a valid numeric column. |
| minX | Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX. |
| maxX | Upper bound for xColumnName. Must be greater than or equal to minX. |
| yColumnName | Name of a column on which to perform the bounding box query. Must be a valid numeric column. |
| minY | Lower bound for yColumnName. Must be less than or equal to maxY. |
| maxY | Upper bound for yColumnName. Must be greater than or equal to minY. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the bounding box operation will be performed. Must be an existing table. | |
| viewName | Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. | |
| xColumnName | Name of the column on which to perform the bounding box query. Must be a valid numeric column. | |
| minX | Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX. | |
| maxX | Upper bound for xColumnName. Must be greater than or equal to minX. | |
| yColumnName | Name of a column on which to perform the bounding box query. Must be a valid numeric column. | |
| minY | Lower bound for yColumnName. Must be less than or equal to maxY. | |
| maxY | Upper bound for yColumnName. Must be greater than or equal to minY. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the bounding box operation will be performed. Must be an existing table. |
| viewName | Optional 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. |
| columnName | Name of the geospatial geometry column to be filtered. |
| minX | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX. |
| maxX | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX. |
| minY | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY. |
| maxY | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the bounding box operation will be performed. Must be an existing table. | |
| viewName | Optional 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. | |
| columnName | Name of the geospatial geometry column to be filtered. | |
| minX | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX. | |
| maxX | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX. | |
| minY | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY. | |
| maxY | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Applies a geometry filter against a geospatial geometry column in a given table, collection or view.
The filtering geometry is provided by inputWkt.
| tableName | Name 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. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| columnName | Name of the column to be used in the filter. Must be a geospatial geometry column. |
| inputWkt | A geometry in WKT format that will be used to filter the objects in tableName. |
| operation | The geometric filtering operation to perform
|
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| columnName | Name of the column to be used in the filter. Must be a geospatial geometry column. | |
| inputWkt | A geometry in WKT format that will be used to filter the objects in tableName. | |
| operation | The geometric filtering operation to perform
| |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name 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. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| columnValuesMap | List of values for the corresponding column in the table |
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| columnValuesMap | List of values for the corresponding column in the table | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| xColumnName | Name of the column to be used for the x-coordinate (the longitude) of the center. |
| xCenter | Value 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. |
| yColumnName | Name of the column to be used for the y-coordinate-the latitude-of the center. |
| yCenter | Value 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. |
| radius | The 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. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the filter by radius operation will be performed. Must be an existing table. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| xColumnName | Name of the column to be used for the x-coordinate (the longitude) of the center. | |
| xCenter | Value 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. | |
| yColumnName | Name of the column to be used for the y-coordinate-the latitude-of the center. | |
| yCenter | Value 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. | |
| radius | The 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
| viewName | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. |
| columnName | Name of the geospatial geometry column to be filtered. |
| xCenter | Value 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. |
| yCenter | Value 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. |
| radius | The 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. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the filter by radius operation will be performed. Must be an existing table. | |
| viewName | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. | |
| columnName | Name of the geospatial geometry column to be filtered. | |
| xCenter | Value 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. | |
| yCenter | Value 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. | |
| radius | The 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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).
| [in] | request_ | Request object containing the parameters for 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).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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).
| tableName | Name of the table on which the filter by range operation will be performed. Must be an existing table. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| columnName | Name of a column on which the operation would be applied. |
| lowerBound | Value of the lower bound (inclusive). |
| upperBound | Value of the upper bound (inclusive). |
| options | Optional parameters.
|
| 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).
| tableName | Name of the table on which the filter by range operation will be performed. Must be an existing table. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| columnName | Name of a column on which the operation would be applied. | |
| lowerBound | Value of the lower bound (inclusive). | |
| upperBound | Value of the upper bound (inclusive). | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| trackId | The ID of the track which will act as the filtering points. Must be an existing track within the given table. |
| targetTrackIds | Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the filter by track operation will be performed. Must be a currently existing table with a track present. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| trackId | The ID of the track which will act as the filtering points. Must be an existing track within the given table. | |
| targetTrackIds | Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table on which the filter operation will be performed. Must be an existing table, collection or view. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| expression | The expression with which to filter the table. |
| mode | The string filtering mode to apply. See below for details.
|
| columnNames | List of columns on which to apply the filter. Ignored for 'search' mode. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table on which the filter operation will be performed. Must be an existing table, collection or view. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| expression | The expression with which to filter the table. | |
| mode | The string filtering mode to apply. See below for details.
| |
| columnNames | List of columns on which to apply the filter. Ignored for 'search' mode. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table whose data will be filtered. Must be an existing table. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| columnName | Name of the column by whose value the data will be filtered from the table designated by tableName. |
| sourceTableName | Name of the table whose data will be compared against in the table called tableName. Must be an existing table. |
| sourceTableColumnName | Name 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. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table whose data will be filtered. Must be an existing table. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| columnName | Name of the column by whose value the data will be filtered from the table designated by tableName. | |
| sourceTableName | Name of the table whose data will be compared against in the table called tableName. Must be an existing table. | |
| sourceTableColumnName | Name 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of an existing table on which to perform the calculation. |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
| isString | Indicates whether the value being searched for is string or numeric. |
| value | The value to search for. |
| valueStr | The string value to search for. |
| columnName | Name of a column on which the filter by value would be applied. |
| options | Optional parameters.
|
| 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.
| tableName | Name of an existing table on which to perform the calculation. | |
| viewName | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. | |
| isString | Indicates whether the value being searched for is string or numeric. | |
| value | The value to search for. | |
| valueStr | The string value to search for. | |
| columnName | Name of a column on which the filter by value would be applied. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| jobId | A unique identifier for the job whose status and result is to be fetched. |
| options | Optional parameters. |
| 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.
| jobId | A unique identifier for the job whose status and result is to be fetched. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 13400 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 13444 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| tableName | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. |
| offset | A 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. |
| limit | A 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 |
|
Definition at line 13526 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| tableName | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. | |
| offset | A 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. | |
| limit | A 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. |
Definition at line 13616 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 13663 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 13706 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [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. |
Definition at line 13752 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [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. |
Definition at line 13798 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| tableName | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. | |
| offset | A 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. | |
| limit | A 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 |
|
Definition at line 13882 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| tableName | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. | |
| offset | A 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. | |
| limit | A 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 |
|
Definition at line 13971 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| tableName | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. | |
| offset | A 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. | |
| limit | A 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. |
Definition at line 14063 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| tableName | Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection. | |
| offset | A 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. | |
| limit | A 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. |
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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name 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. |
| columnNames | The list of column values to retrieve. |
| offset | A 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. |
| limit | A 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 |
|
| 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.
| tableName | Name 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. | |
| columnNames | The list of column values to retrieve. | |
| offset | A 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. | |
| limit | A 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. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 14603 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 14653 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| tableName | Name of the collection/table/view for which series/tracks will be fetched. |
| worldTableName | Name 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. |
| offset | A 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. |
| limit | A 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. |
| options | Optional parameters. |
Definition at line 14715 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| tableName | Name of the collection/table/view for which series/tracks will be fetched. | |
| worldTableName | Name 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. | |
| offset | A 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. | |
| limit | A 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 14787 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 14842 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 14890 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [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. |
Definition at line 14942 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [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. |
Definition at line 14994 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| tableName | Name of the collection/table/view for which series/tracks will be fetched. | |
| worldTableName | Name 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. | |
| offset | A 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. | |
| limit | A 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. | |
| options | Optional parameters. |
Definition at line 15058 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| tableName | Name of the collection/table/view for which series/tracks will be fetched. | |
| worldTableName | Name 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. | |
| offset | A 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. | |
| limit | A 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. | |
| options | Optional parameters. |
Definition at line 15129 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| tableName | Name of the collection/table/view for which series/tracks will be fetched. | |
| worldTableName | Name 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. | |
| offset | A 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. | |
| limit | A 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 15203 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| tableName | Name of the collection/table/view for which series/tracks will be fetched. | |
| worldTableName | Name 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. | |
| offset | A 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. | |
| limit | A 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 15373 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 15414 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| tableName | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. |
| offset | A 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. |
| limit | A 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 |
|
Definition at line 15477 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| tableName | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. | |
| offset | A 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. | |
| limit | A 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. |
Definition at line 15548 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 15592 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 15632 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [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. |
Definition at line 15675 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [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. |
Definition at line 15718 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| tableName | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. | |
| offset | A 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. | |
| limit | A 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 |
|
Definition at line 15783 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| tableName | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. | |
| offset | A 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. | |
| limit | A 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 |
|
Definition at line 15853 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| tableName | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. | |
| offset | A 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. | |
| limit | A 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. |
Definition at line 15926 of file GPUdbFunctions.hpp.
| 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.
| <TResponse> | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| tableName | Name of the collection or table from which records are to be retrieved. Must be an existing collection or table. | |
| offset | A 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. | |
| limit | A 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. |
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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionProcResponse grantPermissionProc | ( | const GrantPermissionProcRequest & | request_ | ) | const |
Grants a proc-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| GrantPermissionProcResponse& grantPermissionProc | ( | const GrantPermissionProcRequest & | request_, |
| GrantPermissionProcResponse & | response_ | ||
| ) | const |
Grants a proc-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Grants a proc-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role.
|
| procName | Name of the proc to which the permission grants access. Must be an existing proc, or an empty string to grant access to all procs. |
| options | Optional parameters. |
| 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.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. | |
| permission | Permission to grant to the user or role.
| |
| procName | Name of the proc to which the permission grants access. Must be an existing proc, or an empty string to grant access to all procs. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionSystemResponse grantPermissionSystem | ( | const GrantPermissionSystemRequest & | request_ | ) | const |
Grants a system-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| GrantPermissionSystemResponse& grantPermissionSystem | ( | const GrantPermissionSystemRequest & | request_, |
| GrantPermissionSystemResponse & | response_ | ||
| ) | const |
Grants a system-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role.
|
| options | Optional parameters. |
| 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.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. | |
| permission | Permission to grant to the user or role.
| |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionTableResponse grantPermissionTable | ( | const GrantPermissionTableRequest & | request_ | ) | const |
Grants a table-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| GrantPermissionTableResponse& grantPermissionTable | ( | const GrantPermissionTableRequest & | request_, |
| GrantPermissionTableResponse & | response_ | ||
| ) | const |
Grants a table-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Grants a table-level permission to a user or role.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role.
|
| tableName | Name 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. |
| filterExpression | Optional filter expression to apply to this grant. Only rows that match the filter will be affected. |
| options | Optional parameters.
|
| 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.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. | |
| permission | Permission to grant to the user or role.
| |
| tableName | Name 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. | |
| filterExpression | Optional filter expression to apply to this grant. Only rows that match the filter will be affected. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| GrantRoleResponse grantRole | ( | const GrantRoleRequest & | request_ | ) | const |
Grants membership in a role to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| GrantRoleResponse& grantRole | ( | const GrantRoleRequest & | request_, |
| GrantRoleResponse & | response_ | ||
| ) | const |
Grants membership in a role to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| role | Name of the role in which membership will be granted. Must be an existing role. |
| member | Name of the user or role that will be granted membership in role. Must be an existing user or role. |
| options | Optional parameters. |
| 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.
| role | Name of the role in which membership will be granted. Must be an existing role. | |
| member | Name of the user or role that will be granted membership in role. Must be an existing user or role. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| HasProcResponse hasProc | ( | const HasProcRequest & | request_ | ) | const |
Checks the existence of a proc with the given name.
| [in] | request_ | Request object containing the parameters for the operation. |
| HasProcResponse& hasProc | ( | const HasProcRequest & | request_, |
| HasProcResponse & | response_ | ||
| ) | const |
Checks the existence of a proc with the given name.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| procName | Name of the proc to check for existence. |
| options | Optional parameters. |
| 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.
| procName | Name of the proc to check for existence. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| HasTableResponse hasTable | ( | const HasTableRequest & | request_ | ) | const |
Checks for the existence of a table with the given name.
| [in] | request_ | Request object containing the parameters for the operation. |
| HasTableResponse& hasTable | ( | const HasTableRequest & | request_, |
| HasTableResponse & | response_ | ||
| ) | const |
Checks for the existence of a table with the given name.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table to check for existence. |
| options | Optional parameters. |
| 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.
| tableName | Name of the table to check for existence. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| HasTypeResponse hasType | ( | const HasTypeRequest & | request_ | ) | const |
Check for the existence of a type.
| [in] | request_ | Request object containing the parameters for the operation. |
| HasTypeResponse& hasType | ( | const HasTypeRequest & | request_, |
| HasTypeResponse & | response_ | ||
| ) | const |
Check for the existence of a type.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| HasTypeResponse hasType | ( | const std::string & | typeId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Check for the existence of a type.
| typeId | Id of the type returned in response to /create/type request. |
| options | Optional parameters. |
| HasTypeResponse& hasType | ( | const std::string & | typeId, |
| const std::map< std::string, std::string > & | options, | ||
| HasTypeResponse & | response_ | ||
| ) | const |
Check for the existence of a type.
| typeId | Id of the type returned in response to /create/type request. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| <TRequest> | The type of object being added. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 16705 of file GPUdbFunctions.hpp.
| 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.
| <TRequest> | The type of object being added. |
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 16746 of file GPUdbFunctions.hpp.
| 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.
| <TRequest> | The type of object being added. |
| tableName | Table to which the records are to be added. Must be an existing table. |
| data | An 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. |
| options | Optional parameters.
|
Definition at line 16852 of file GPUdbFunctions.hpp.
| 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.
| <TRequest> | The type of object being added. |
| tableName | Table to which the records are to be added. Must be an existing table. | |
| data | An 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name 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. |
| filepaths | Absolute 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 (|). |
| createTableOptions | Options used when creating a new table.
|
| options | Optional parameters.
|
| 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.
| tableName | Name 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. | |
| filepaths | Absolute 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 (|). | |
| createTableOptions | Options used when creating a new table.
| |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Table 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. |
| count | Number of records to generate. |
| options | Optional 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:
|
| 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.
| tableName | Table 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. | |
| count | Number of records to generate. | |
| options | Optional 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:
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| symbolId | The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol |
| symbolFormat | Specifies the symbol format. Must be either 'svg' or 'svg_path'. |
| symbolData | The 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' |
| options | Optional parameters.
|
| 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.
| symbolId | The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol | |
| symbolFormat | Specifies the symbol format. Must be either 'svg' or 'svg_path'. | |
| symbolData | The 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' | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| KillProcResponse killProc | ( | const KillProcRequest & | request_ | ) | const |
Kills a running proc instance.
| [in] | request_ | Request object containing the parameters for the operation. |
| KillProcResponse& killProc | ( | const KillProcRequest & | request_, |
| KillProcResponse & | response_ | ||
| ) | const |
Kills a running proc instance.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| KillProcResponse killProc | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Kills a running proc instance.
| runId | The 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. |
| options | Optional parameters.
|
| KillProcResponse& killProc | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options, | ||
| KillProcResponse & | response_ | ||
| ) | const |
Kills a running proc instance.
| runId | The 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table to be locked. It must be a currently existing table, collection, or view. |
| lockType | The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it.
|
| options | Optional parameters. |
| 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.
| tableName | Name of the table to be locked. It must be a currently existing table, collection, or view. | |
| lockType | The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it.
| |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| graphName | Name of the underlying geospatial graph resource to match to using samplePoints. |
| samplePoints | Sample 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'. |
| solveMethod | The type of solver to use for graph matching.
|
| solutionTable | The 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. |
| options | Additional parameters
|
| 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.
| graphName | Name of the underlying geospatial graph resource to match to using samplePoints. | |
| samplePoints | Sample 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'. | |
| solveMethod | The type of solver to use for graph matching.
| |
| solutionTable | The 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. | |
| options | Additional parameters
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | The new result table name for the records to be merged. Must NOT be an existing table. |
| sourceTableNames | The list of source table names to get the records from. Must be existing table names. |
| fieldMaps | Contains 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. |
| options | Optional parameters.
|
| 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.
| tableName | The new result table name for the records to be merged. Must NOT be an existing table. | |
| sourceTableNames | The list of source table names to get the records from. Must be existing table names. | |
| fieldMaps | Contains 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| graphName | Name of the graph resource to modify. |
| nodes | Nodes 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. |
| edges | Edges 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. |
| weights | Weights 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. |
| restrictions | Restrictions 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. |
| options | Optional parameters.
|
| 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.
| graphName | Name of the graph resource to modify. | |
| nodes | Nodes 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. | |
| edges | Edges 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. | |
| weights | Weights 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. | |
| restrictions | Restrictions 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| graphName | Name of the graph resource to query. |
| queries | Nodes 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. |
| restrictions | Additional 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. |
| adjacencyTable | Name 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. |
| rings | Sets 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. |
| options | Additional parameters
|
| 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.
| graphName | Name of the graph resource to query. | |
| queries | Nodes 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. | |
| restrictions | Additional 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. | |
| adjacencyTable | Name 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. | |
| rings | Sets 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. | |
| options | Additional parameters
| |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionProcResponse revokePermissionProc | ( | const RevokePermissionProcRequest & | request_ | ) | const |
Revokes a proc-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| RevokePermissionProcResponse& revokePermissionProc | ( | const RevokePermissionProcRequest & | request_, |
| RevokePermissionProcResponse & | response_ | ||
| ) | const |
Revokes a proc-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Revokes a proc-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role.
|
| procName | Name 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. |
| options | Optional parameters. |
| 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.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. | |
| permission | Permission to revoke from the user or role.
| |
| procName | Name 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionSystemResponse revokePermissionSystem | ( | const RevokePermissionSystemRequest & | request_ | ) | const |
Revokes a system-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| RevokePermissionSystemResponse& revokePermissionSystem | ( | const RevokePermissionSystemRequest & | request_, |
| RevokePermissionSystemResponse & | response_ | ||
| ) | const |
Revokes a system-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role.
|
| options | Optional parameters. |
| 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.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. | |
| permission | Permission to revoke from the user or role.
| |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionTableResponse revokePermissionTable | ( | const RevokePermissionTableRequest & | request_ | ) | const |
Revokes a table-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| RevokePermissionTableResponse& revokePermissionTable | ( | const RevokePermissionTableRequest & | request_, |
| RevokePermissionTableResponse & | response_ | ||
| ) | const |
Revokes a table-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Revokes a table-level permission from a user or role.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| permission | Permission to revoke from the user or role.
|
| tableName | Name of the table to which the permission grants access. Must be an existing table, collection, or view. |
| options | Optional parameters.
|
| 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.
| name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. | |
| permission | Permission to revoke from the user or role.
| |
| tableName | Name of the table to which the permission grants access. Must be an existing table, collection, or view. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| RevokeRoleResponse revokeRole | ( | const RevokeRoleRequest & | request_ | ) | const |
Revokes membership in a role from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| RevokeRoleResponse& revokeRole | ( | const RevokeRoleRequest & | request_, |
| RevokeRoleResponse & | response_ | ||
| ) | const |
Revokes membership in a role from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| role | Name of the role in which membership will be revoked. Must be an existing role. |
| member | Name of the user or role that will be revoked membership in role. Must be an existing user or role. |
| options | Optional parameters. |
| 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.
| role | Name of the role in which membership will be revoked. Must be an existing role. | |
| member | Name of the user or role that will be revoked membership in role. Must be an existing user or role. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| ShowGraphResponse showGraph | ( | const ShowGraphRequest & | request_ | ) | const |
Shows information and characteristics of graphs that exist on the graph server.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowGraphResponse& showGraph | ( | const ShowGraphRequest & | request_, |
| ShowGraphResponse & | response_ | ||
| ) | const |
Shows information and characteristics of graphs that exist on the graph server.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| graphName | Name of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. |
| options | Optional parameters.
|
| 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.
| graphName | Name of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ShowProcResponse showProc | ( | const ShowProcRequest & | request_ | ) | const |
Shows information about a proc.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowProcResponse& showProc | ( | const ShowProcRequest & | request_, |
| ShowProcResponse & | response_ | ||
| ) | const |
Shows information about a proc.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowProcResponse showProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a proc.
| procName | Name 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. |
| options | Optional parameters.
|
| ShowProcResponse& showProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowProcResponse & | response_ | ||
| ) | const |
Shows information about a proc.
| procName | Name 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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).
| [in] | request_ | Request object containing the parameters for 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).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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).
| runId | The 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. |
| options | Optional parameters.
|
| 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).
| runId | The 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ShowResourceGroupsResponse showResourceGroups | ( | const ShowResourceGroupsRequest & | request_ | ) | const |
Requests resource group properties.
Returns detailed information about the requested resource groups.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowResourceGroupsResponse& showResourceGroups | ( | const ShowResourceGroupsRequest & | request_, |
| ShowResourceGroupsResponse & | response_ | ||
| ) | const |
Requests resource group properties.
Returns detailed information about the requested resource groups.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| names | List of names of groups to be shown. A single entry with an empty string returns all groups. |
| options | Optional parameters.
|
| 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.
| names | List of names of groups to be shown. A single entry with an empty string returns all groups. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ShowResourceStatisticsResponse showResourceStatistics | ( | const ShowResourceStatisticsRequest & | request_ | ) | const |
Requests various statistics for storage/memory tiers and resource groups.
Returns statistics on a per-rank basis.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters. |
| 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.
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| names | A 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. |
| options | Optional parameters. |
| 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.
| names | A 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. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSqlProcResponse showSqlProc | ( | const ShowSqlProcRequest & | request_ | ) | const |
Shows information about SQL procedures, including the full definition of each requested procedure.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowSqlProcResponse& showSqlProc | ( | const ShowSqlProcRequest & | request_, |
| ShowSqlProcResponse & | response_ | ||
| ) | const |
Shows information about SQL procedures, including the full definition of each requested procedure.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| procedureName | Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. |
| options | Optional parameters.
|
| 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.
| procedureName | Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ShowStatisticsResponse showStatistics | ( | const ShowStatisticsRequest & | request_ | ) | const |
Retrieves the collected column statistics for the specified table.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowStatisticsResponse& showStatistics | ( | const ShowStatisticsRequest & | request_, |
| ShowStatisticsResponse & | response_ | ||
| ) | const |
Retrieves the collected column statistics for the specified table.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableNames | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. |
| options | Optional parameters. |
| 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.
| tableNames | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters.
|
| 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.
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters, currently unused. |
| 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.
| options | Optional parameters, currently unused. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| options | Optional parameters, currently unused. |
| 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.
| options | Optional parameters, currently unused. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableName | Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned. |
| options | Optional parameters.
|
| 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.
| tableName | Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTableMetadataResponse showTableMetadata | ( | const ShowTableMetadataRequest & | request_ | ) | const |
Retrieves the user provided metadata for the specified tables.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowTableMetadataResponse& showTableMetadata | ( | const ShowTableMetadataRequest & | request_, |
| ShowTableMetadataResponse & | response_ | ||
| ) | const |
Retrieves the user provided metadata for the specified tables.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| tableNames | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. |
| options | Optional parameters. |
| 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.
| tableNames | Tables whose metadata will be fetched. All provided tables must exist, or an error is returned. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| typeId | Type id returned by a call to /create/type. |
| label | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| options | Optional parameters. |
| 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.
| typeId | Type id returned by a call to /create/type. | |
| label | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTriggersResponse showTriggers | ( | const ShowTriggersRequest & | request_ | ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowTriggersResponse& showTriggers | ( | const ShowTriggersRequest & | request_, |
| ShowTriggersResponse & | response_ | ||
| ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| triggerIds | List of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers. |
| options | Optional parameters. |
| 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.
| triggerIds | List of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers. | |
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| typeId | Type Id returned in response to a call to /create/type. |
| label | Option string that was supplied by user in a call to /create/type. |
| options | Optional parameters.
|
| 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.
| typeId | Type Id returned in response to a call to /create/type. | |
| label | Option string that was supplied by user in a call to /create/type. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| graphName | Name of the graph resource to solve. |
| weightsOnEdges | Additional 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. |
| restrictions | Additional 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'). |
| solverType | The type of solver to use for the graph.
|
| sourceNodes | It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets. |
| destinationNodes | It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets. |
| solutionTable | Name of the table to store the solution. |
| options | Additional parameters
|
| 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.
| graphName | Name of the graph resource to solve. | |
| weightsOnEdges | Additional 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. | |
| restrictions | Additional 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'). | |
| solverType | The type of solver to use for the graph.
| |
| sourceNodes | It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for source nodes. For BACKHAUL_ROUTING, this list depicts the fixed assets. | |
| destinationNodes | It can be one of the nodal identifiers - e.g: 'NODE_WKTPOINT' for destination (target) nodes. For BACKHAUL_ROUTING, this list depicts the remote assets. | |
| solutionTable | Name of the table to store the solution. | |
| options | Additional parameters
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| <TRequest> | The type of object being added. |
| [in] | request_ | Request object containing the parameters for the operation. |
Definition at line 22605 of file GPUdbFunctions.hpp.
| 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.
| <TRequest> | The type of object being added. |
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
Definition at line 22658 of file GPUdbFunctions.hpp.
| 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.
| <TRequest> | The type of object being added. |
| tableName | Table to be updated. Must be a currently existing table and not a collection or view. |
| expressions | A list of the actual predicates, one for each update; format should follow the guidelines /filter. |
| newValuesMaps | List 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. |
| data | An 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. |
| options | Optional parameters.
|
Definition at line 22795 of file GPUdbFunctions.hpp.
| 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.
| <TRequest> | The type of object being added. |
| tableName | Table to be updated. Must be a currently existing table and not a collection or view. | |
| expressions | A list of the actual predicates, one for each update; format should follow the guidelines /filter. | |
| newValuesMaps | List 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. | |
| data | An 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. | |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
| tableName | Name of the view on which the update operation will be performed. Must be an existing view. |
| worldTableName | Name of the table containing the complete series (track) information. |
| viewName | name of the view containing the series (tracks) which have to be updated. |
| reserved | |
| options | Optional parameters. |
| 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.
| tableName | Name of the view on which the update operation will be performed. Must be an existing view. | |
| worldTableName | Name of the table containing the complete series (track) information. | |
| viewName | name of the view containing the series (tracks) which have to be updated. | |
| reserved | ||
| options | Optional parameters. | |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| tableName | Name of the table containing the data to be drawn as a chart. |
| xColumnNames | Names of the columns containing the data mapped to the x axis of a chart. |
| yColumnNames | Names of the columns containing the data mapped to the y axis of a chart. |
| minX | Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| maxX | Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. |
| minY | Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| maxY | Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. |
| width | Width of the generated image in pixels. |
| height | Height of the generated image in pixels. |
| bgColor | Background color of the generated image. |
| styleOptions | Rendering style options for a chart.
|
| options | Optional parameters.
|
| 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.
| tableName | Name of the table containing the data to be drawn as a chart. | |
| xColumnNames | Names of the columns containing the data mapped to the x axis of a chart. | |
| yColumnNames | Names of the columns containing the data mapped to the y axis of a chart. | |
| minX | Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. | |
| maxX | Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0. | |
| minY | Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. | |
| maxY | Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0. | |
| width | Width of the generated image in pixels. | |
| height | Height of the generated image in pixels. | |
| bgColor | Background color of the generated image. | |
| styleOptions | Rendering style options for a chart.
| |
| options | Optional parameters.
| |
| [out] | response_ | Response object containing the results of the operation. |
| 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.
| [in] | request_ | Request object containing the parameters for 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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results 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 | ||
| ) | 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.
| graphName | Name of the graph on which the isochrone is to be computed. |
| sourceNode | Starting vertex on the underlying graph from/to which the isochrones are created. |
| maxSolutionRadius | Extent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius. |
| weightsOnEdges | Additional 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). |
| restrictions | Additional 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'). |
| numLevels | Number of equally-separated isochrones to compute. |
| generateImage | If set to true, generates a PNG image of the isochrones in the response. The default value is gpudb::visualize_isochrone_true. |
| levelsTable | Name of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated. |
| styleOptions | Various style related options of the isochrone image.
|
| solveOptions | Solver specific parameters
|
| contourOptions | Solver specific parameters
|
| options | Additional parameters
|
| 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.
| graphName | Name of the graph on which the isochrone is to be computed. | |
| sourceNode | Starting vertex on the underlying graph from/to which the isochrones are created. | |
| maxSolutionRadius | Extent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius. | |
| weightsOnEdges | Additional 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). | |
| restrictions | Additional 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'). | |
| numLevels | Number of equally-separated isochrones to compute. | |
| generateImage | If set to true, generates a PNG image of the isochrones in the response. The default value is gpudb::visualize_isochrone_true. | |
| levelsTable | Name of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated. | |
| styleOptions | Various style related options of the isochrone image.
| |
| solveOptions | Solver specific parameters
| |
| contourOptions | Solver specific parameters
| |
| options | Additional parameters
| |
| [out] | response_ | Response object containing the results of the operation. |
1.8.5 
