- Generated by
1.8.15
|
GPUdb C++ API
Version 7.2.2.4
|
#include <gpudb/GPUdb.hpp>
Inherits noncopyable.
Classes | |
| class | Options |
Public Types | |
| enum | HASynchronicityMode { DEFAULT = 0, NONE, SYNCHRONOUS, SYNCHRONOUS_PARALLEL, ASYNCHRONOUS, ASYNCHRONOUS_PARALLEL } |
| A enumeration of high-availability synchronicity override modes. More... | |
Public Member Functions | |
| GPUdb (const HttpUrl &url, const Options &options=Options()) | |
| Pass a single HttpURL and options to instantiate a GPUdb object. More... | |
| GPUdb (const std::string &url, const Options &options=Options()) | |
| Pass a single or multiple, comma-separated URLs as a string and optional options to instantiate a GPUdb object. More... | |
| GPUdb (const std::vector< HttpUrl > &urls, const Options &options=Options()) | |
| Pass multiple HttpURLs and optional options to instantiate a GPUdb object. More... | |
| GPUdb (const std::vector< std::string > &urls, const Options &options=Options()) | |
| Pass multiple strings, each containing a single URL, and optional options to instantiate a GPUdb object. More... | |
| ~GPUdb () | |
| Destructor. More... | |
| const HttpUrl & | getUrl () const |
| const std::vector< HttpUrl > & | getUrls () const |
| const HttpUrl & | getHmUrl () const |
| const std::vector< HttpUrl > & | getHmUrls () const |
| boost::asio::ssl::context * | getSslContext () const |
| bool | getBypassSslCertCheck () const |
| const std::string & | getUsername () const |
| const std::string & | getPassword () const |
| const std::string & | getOauthToken () const |
| const std::string & | getPrimaryURL () const |
| Return a string containing the URL for the primary cluster; empty string otherwise. More... | |
| bool | getUseSnappy () const |
| size_t | getThreadCount () const |
| avro::ExecutorPtr | getExecutor () const |
| const std::map< std::string, std::string > & | getHttpHeaders () const |
| HASynchronicityMode | getHASyncMode () const |
| size_t | getTimeout () const |
| long | execute (const std::string &sql) |
| This method is used to execute a SQL statement (e.g., DML, DDL). More... | |
| long | execute (const std::string &sql, const std::string ¶meters) |
| This method is used to execute a SQL statement (e.g., DML, DDL). More... | |
| long | execute (const std::string &sql, const std::string ¶meters, const std::map< std::string, std::string > &options) |
| This method is used to execute a SQL statement (e.g., DML, DDL). More... | |
| template<typename T > | |
| long | execute (const std::string &sql, const std::vector< T > ¶meters) |
| template<typename T > | |
| long | execute (const std::string &sql, const std::vector< T > ¶meters, const std::map< std::string, std::string > &options) |
| void | setHASyncMode (HASynchronicityMode mode) |
| Sets the high-availability synchronization mode which will override the default mode. More... | |
| void | addHttpHeader (const std::string &header, const std::string &value) |
| Adds an HTTP header to the map of additional HTTP headers to send to GPUdb with each request. More... | |
| void | removeHttpHeader (const std::string &header) |
| Removes the given HTTP header from the map of additional HTTP headers to send to GPUdb with each request. More... | |
| void | updateHostManagerPort () |
| Update the host manager port by inquiring the server. More... | |
| template<typename TRequest , typename TResponse > | |
| TResponse & | submitRequest (const HttpUrl &url, const TRequest &request, TResponse &response, const bool enableCompression=false) const |
| template<typename TRequest , typename TResponse > | |
| TResponse & | submitRequest (const std::string &endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const |
| template<typename TRequest , typename TResponse > | |
| TResponse & | submitRequest (const char *endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const |
| template<typename TRequest , typename TResponse > | |
| TResponse & | submitRequestToHostManager (const std::string &endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const |
| Submit an HTTP request to the host manager. More... | |
| template<typename TRequest , typename TResponse > | |
| TResponse & | submitRequestToHostManager (const char *endpoint, const TRequest &request, TResponse &response, const bool enableCompression=false) const |
| Submit an HTTP request to the host manager. More... | |
| AdminAddHostResponse | adminAddHost (const AdminAddHostRequest &request_) const |
| Adds a host to an existing cluster. More... | |
| AdminAddHostResponse & | adminAddHost (const AdminAddHostRequest &request_, AdminAddHostResponse &response_) const |
| Adds a host to an existing cluster. More... | |
| AdminAddHostResponse | adminAddHost (const std::string &hostAddress, const std::map< std::string, std::string > &options) const |
| Adds a host to an existing cluster. More... | |
| AdminAddHostResponse & | adminAddHost (const std::string &hostAddress, const std::map< std::string, std::string > &options, AdminAddHostResponse &response_) const |
| Adds a host to an existing cluster. More... | |
| AdminAddRanksResponse | adminAddRanks (const AdminAddRanksRequest &request_) const |
| Add one or more ranks to an existing Kinetica cluster. More... | |
| AdminAddRanksResponse & | adminAddRanks (const AdminAddRanksRequest &request_, AdminAddRanksResponse &response_) const |
| Add one or more ranks to an existing 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 ranks to an existing 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 ranks to an existing Kinetica cluster. More... | |
| AdminAlterHostResponse | adminAlterHost (const AdminAlterHostRequest &request_) const |
| Alter properties on an existing host in the cluster. More... | |
| AdminAlterHostResponse & | adminAlterHost (const AdminAlterHostRequest &request_, AdminAlterHostResponse &response_) const |
| Alter properties on an existing host in the cluster. More... | |
| AdminAlterHostResponse | adminAlterHost (const std::string &host, const std::map< std::string, std::string > &options) const |
| Alter properties on an existing host in the cluster. More... | |
| AdminAlterHostResponse & | adminAlterHost (const std::string &host, const std::map< std::string, std::string > &options, AdminAlterHostResponse &response_) const |
| Alter properties on an existing host in the 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... | |
| AdminBackupBeginResponse | adminBackupBegin (const AdminBackupBeginRequest &request_) const |
| Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. More... | |
| AdminBackupBeginResponse & | adminBackupBegin (const AdminBackupBeginRequest &request_, AdminBackupBeginResponse &response_) const |
| Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. More... | |
| AdminBackupBeginResponse | adminBackupBegin (const std::map< std::string, std::string > &options) const |
| Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. More... | |
| AdminBackupBeginResponse & | adminBackupBegin (const std::map< std::string, std::string > &options, AdminBackupBeginResponse &response_) const |
| Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. More... | |
| AdminBackupEndResponse | adminBackupEnd (const AdminBackupEndRequest &request_) const |
| Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete. More... | |
| AdminBackupEndResponse & | adminBackupEnd (const AdminBackupEndRequest &request_, AdminBackupEndResponse &response_) const |
| Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete. More... | |
| AdminBackupEndResponse | adminBackupEnd (const std::map< std::string, std::string > &options) const |
| Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete. More... | |
| AdminBackupEndResponse & | adminBackupEnd (const std::map< std::string, std::string > &options, AdminBackupEndResponse &response_) const |
| Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete. More... | |
| AdminHaRefreshResponse | adminHaRefresh (const AdminHaRefreshRequest &request_) const |
| Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes. More... | |
| AdminHaRefreshResponse & | adminHaRefresh (const AdminHaRefreshRequest &request_, AdminHaRefreshResponse &response_) const |
| Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes. More... | |
| AdminHaRefreshResponse | adminHaRefresh (const std::map< std::string, std::string > &options) const |
| Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes. More... | |
| AdminHaRefreshResponse & | adminHaRefresh (const std::map< std::string, std::string > &options, AdminHaRefreshResponse &response_) const |
| Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes. 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 data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks. More... | |
| AdminRebalanceResponse & | adminRebalance (const AdminRebalanceRequest &request_, AdminRebalanceResponse &response_) const |
| Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks. More... | |
| AdminRebalanceResponse | adminRebalance (const std::map< std::string, std::string > &options) const |
| Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks. More... | |
| AdminRebalanceResponse & | adminRebalance (const std::map< std::string, std::string > &options, AdminRebalanceResponse &response_) const |
| Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks. More... | |
| AdminRemoveHostResponse | adminRemoveHost (const AdminRemoveHostRequest &request_) const |
| Removes a host from an existing cluster. More... | |
| AdminRemoveHostResponse & | adminRemoveHost (const AdminRemoveHostRequest &request_, AdminRemoveHostResponse &response_) const |
| Removes a host from an existing cluster. More... | |
| AdminRemoveHostResponse | adminRemoveHost (const std::string &host, const std::map< std::string, std::string > &options) const |
| Removes a host from an existing cluster. More... | |
| AdminRemoveHostResponse & | adminRemoveHost (const std::string &host, const std::map< std::string, std::string > &options, AdminRemoveHostResponse &response_) const |
| Removes a host from an existing cluster. More... | |
| AdminRemoveRanksResponse | adminRemoveRanks (const AdminRemoveRanksRequest &request_) const |
| Remove one or more ranks from an existing Kinetica cluster. More... | |
| AdminRemoveRanksResponse & | adminRemoveRanks (const AdminRemoveRanksRequest &request_, AdminRemoveRanksResponse &response_) const |
| Remove one or more ranks from an existing Kinetica cluster. More... | |
| AdminRemoveRanksResponse | adminRemoveRanks (const std::vector< std::string > &ranks, const std::map< std::string, std::string > &options) const |
| Remove one or more ranks from an existing Kinetica cluster. More... | |
| AdminRemoveRanksResponse & | adminRemoveRanks (const std::vector< std::string > &ranks, const std::map< std::string, std::string > &options, AdminRemoveRanksResponse &response_) const |
| Remove one or more ranks from an existing Kinetica cluster. More... | |
| AdminRepairTableResponse | adminRepairTable (const AdminRepairTableRequest &request_) const |
| Manually repair a corrupted table. More... | |
| AdminRepairTableResponse & | adminRepairTable (const AdminRepairTableRequest &request_, AdminRepairTableResponse &response_) const |
| Manually repair a corrupted table. More... | |
| AdminRepairTableResponse | adminRepairTable (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options) const |
| Manually repair a corrupted table. More... | |
| AdminRepairTableResponse & | adminRepairTable (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options, AdminRepairTableResponse &response_) const |
| Manually repair a corrupted table. 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... | |
| AdminSwitchoverResponse | adminSwitchover (const AdminSwitchoverRequest &request_) const |
| Manually switch over one or more processes to another host. More... | |
| AdminSwitchoverResponse & | adminSwitchover (const AdminSwitchoverRequest &request_, AdminSwitchoverResponse &response_) const |
| Manually switch over one or more processes to another host. More... | |
| AdminSwitchoverResponse | adminSwitchover (const std::vector< std::string > &processes, const std::vector< std::string > &destinations, const std::map< std::string, std::string > &options) const |
| Manually switch over one or more processes to another host. More... | |
| AdminSwitchoverResponse & | adminSwitchover (const std::vector< std::string > &processes, const std::vector< std::string > &destinations, const std::map< std::string, std::string > &options, AdminSwitchoverResponse &response_) const |
| Manually switch over one or more processes to another host. 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... | |
| AlterCredentialResponse | alterCredential (const AlterCredentialRequest &request_) const |
| Alter the properties of an existing credential. More... | |
| AlterCredentialResponse & | alterCredential (const AlterCredentialRequest &request_, AlterCredentialResponse &response_) const |
| Alter the properties of an existing credential. More... | |
| AlterCredentialResponse | alterCredential (const std::string &credentialName, const std::map< std::string, std::string > &credentialUpdatesMap, const std::map< std::string, std::string > &options) const |
| Alter the properties of an existing credential. More... | |
| AlterCredentialResponse & | alterCredential (const std::string &credentialName, const std::map< std::string, std::string > &credentialUpdatesMap, const std::map< std::string, std::string > &options, AlterCredentialResponse &response_) const |
| Alter the properties of an existing credential. More... | |
| AlterDatasinkResponse | alterDatasink (const AlterDatasinkRequest &request_) const |
| Alters the properties of an existing data sink More... | |
| AlterDatasinkResponse & | alterDatasink (const AlterDatasinkRequest &request_, AlterDatasinkResponse &response_) const |
| Alters the properties of an existing data sink More... | |
| AlterDatasinkResponse | alterDatasink (const std::string &name, const std::map< std::string, std::string > &datasinkUpdatesMap, const std::map< std::string, std::string > &options) const |
| Alters the properties of an existing data sink More... | |
| AlterDatasinkResponse & | alterDatasink (const std::string &name, const std::map< std::string, std::string > &datasinkUpdatesMap, const std::map< std::string, std::string > &options, AlterDatasinkResponse &response_) const |
| Alters the properties of an existing data sink More... | |
| AlterDatasourceResponse | alterDatasource (const AlterDatasourceRequest &request_) const |
| Alters the properties of an existing data source More... | |
| AlterDatasourceResponse & | alterDatasource (const AlterDatasourceRequest &request_, AlterDatasourceResponse &response_) const |
| Alters the properties of an existing data source More... | |
| AlterDatasourceResponse | alterDatasource (const std::string &name, const std::map< std::string, std::string > &datasourceUpdatesMap, const std::map< std::string, std::string > &options) const |
| Alters the properties of an existing data source More... | |
| AlterDatasourceResponse & | alterDatasource (const std::string &name, const std::map< std::string, std::string > &datasourceUpdatesMap, const std::map< std::string, std::string > &options, AlterDatasourceResponse &response_) const |
| Alters the properties of an existing data source More... | |
| AlterDirectoryResponse | alterDirectory (const AlterDirectoryRequest &request_) const |
| Alters an existing directory in KiFS. More... | |
| AlterDirectoryResponse & | alterDirectory (const AlterDirectoryRequest &request_, AlterDirectoryResponse &response_) const |
| Alters an existing directory in KiFS. More... | |
| AlterDirectoryResponse | alterDirectory (const std::string &directoryName, const std::map< std::string, std::string > &directoryUpdatesMap, const std::map< std::string, std::string > &options) const |
| Alters an existing directory in KiFS. More... | |
| AlterDirectoryResponse & | alterDirectory (const std::string &directoryName, const std::map< std::string, std::string > &directoryUpdatesMap, const std::map< std::string, std::string > &options, AlterDirectoryResponse &response_) const |
| Alters an existing directory in KiFS. More... | |
| AlterEnvironmentResponse | alterEnvironment (const AlterEnvironmentRequest &request_) const |
| Alters an existing environment which can be referenced by a user-defined function (UDF). More... | |
| AlterEnvironmentResponse & | alterEnvironment (const AlterEnvironmentRequest &request_, AlterEnvironmentResponse &response_) const |
| Alters an existing environment which can be referenced by a user-defined function (UDF). More... | |
| AlterEnvironmentResponse | alterEnvironment (const std::string &environmentName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options) const |
| Alters an existing environment which can be referenced by a user-defined function (UDF). More... | |
| AlterEnvironmentResponse & | alterEnvironment (const std::string &environmentName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options, AlterEnvironmentResponse &response_) const |
| Alters an existing environment which can be referenced by a user-defined function (UDF). 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... | |
| AlterSchemaResponse | alterSchema (const AlterSchemaRequest &request_) const |
| Used to change the name of a SQL-style schema, specified in schemaName. More... | |
| AlterSchemaResponse & | alterSchema (const AlterSchemaRequest &request_, AlterSchemaResponse &response_) const |
| Used to change the name of a SQL-style schema, specified in schemaName. More... | |
| AlterSchemaResponse | alterSchema (const std::string &schemaName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options) const |
| Used to change the name of a SQL-style schema, specified in schemaName. More... | |
| AlterSchemaResponse & | alterSchema (const std::string &schemaName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options, AlterSchemaResponse &response_) const |
| Used to change the name of a SQL-style schema, specified in schemaName. More... | |
| AlterSystemPropertiesResponse | alterSystemProperties (const AlterSystemPropertiesRequest &request_) const |
| The alterSystemProperties 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 alterSystemProperties endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. More... | |
| AlterSystemPropertiesResponse | alterSystemProperties (const std::map< std::string, std::string > &propertyUpdatesMap, const std::map< std::string, std::string > &options) const |
| The alterSystemProperties 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 alterSystemProperties 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 or view. More... | |
| AlterTableResponse & | alterTable (const AlterTableRequest &request_, AlterTableResponse &response_) const |
| Apply various modifications to a table or view. 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 or view. 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 or view. 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... | |
| AlterTableMonitorResponse | alterTableMonitor (const AlterTableMonitorRequest &request_) const |
| Alters a table monitor previously created with createTableMonitor. More... | |
| AlterTableMonitorResponse & | alterTableMonitor (const AlterTableMonitorRequest &request_, AlterTableMonitorResponse &response_) const |
| Alters a table monitor previously created with createTableMonitor. More... | |
| AlterTableMonitorResponse | alterTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &monitorUpdatesMap, const std::map< std::string, std::string > &options) const |
| Alters a table monitor previously created with createTableMonitor. More... | |
| AlterTableMonitorResponse & | alterTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &monitorUpdatesMap, const std::map< std::string, std::string > &options, AlterTableMonitorResponse &response_) const |
| Alters a table monitor previously created with createTableMonitor. 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... | |
| AlterVideoResponse | alterVideo (const AlterVideoRequest &request_) const |
| Alters a video. More... | |
| AlterVideoResponse & | alterVideo (const AlterVideoRequest &request_, AlterVideoResponse &response_) const |
| Alters a video. More... | |
| AlterVideoResponse | alterVideo (const std::string &path, const std::map< std::string, std::string > &options) const |
| Alters a video. More... | |
| AlterVideoResponse & | alterVideo (const std::string &path, const std::map< std::string, std::string > &options, AlterVideoResponse &response_) const |
| Alters a video. More... | |
| AlterWalResponse | alterWal (const AlterWalRequest &request_) const |
| Alters table wal settings. More... | |
| AlterWalResponse & | alterWal (const AlterWalRequest &request_, AlterWalResponse &response_) const |
| Alters table wal settings. More... | |
| AlterWalResponse | alterWal (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options) const |
| Alters table wal settings. More... | |
| AlterWalResponse & | alterWal (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options, AlterWalResponse &response_) const |
| Alters table wal settings. 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 createTableMonitor. More... | |
| ClearTableMonitorResponse & | clearTableMonitor (const ClearTableMonitorRequest &request_, ClearTableMonitorResponse &response_) const |
| Deactivates a table monitor previously created with createTableMonitor. More... | |
| ClearTableMonitorResponse | clearTableMonitor (const std::string &topicId, const std::map< std::string, std::string > &options) const |
| Deactivates a table monitor previously created with createTableMonitor. 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 createTableMonitor. 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... | |
| CreateCredentialResponse | createCredential (const CreateCredentialRequest &request_) const |
| Create a new credential. More... | |
| CreateCredentialResponse & | createCredential (const CreateCredentialRequest &request_, CreateCredentialResponse &response_) const |
| Create a new credential. More... | |
| CreateCredentialResponse | createCredential (const std::string &credentialName, const std::string &type, const std::string &identity, const std::string &secret, const std::map< std::string, std::string > &options) const |
| Create a new credential. More... | |
| CreateCredentialResponse & | createCredential (const std::string &credentialName, const std::string &type, const std::string &identity, const std::string &secret, const std::map< std::string, std::string > &options, CreateCredentialResponse &response_) const |
| Create a new credential. More... | |
| CreateDatasinkResponse | createDatasink (const CreateDatasinkRequest &request_) const |
| Creates a data sink, which contains the destination information for a data sink that is external to the database. More... | |
| CreateDatasinkResponse & | createDatasink (const CreateDatasinkRequest &request_, CreateDatasinkResponse &response_) const |
| Creates a data sink, which contains the destination information for a data sink that is external to the database. More... | |
| CreateDatasinkResponse | createDatasink (const std::string &name, const std::string &destination, const std::map< std::string, std::string > &options) const |
| Creates a data sink, which contains the destination information for a data sink that is external to the database. More... | |
| CreateDatasinkResponse & | createDatasink (const std::string &name, const std::string &destination, const std::map< std::string, std::string > &options, CreateDatasinkResponse &response_) const |
| Creates a data sink, which contains the destination information for a data sink that is external to the database. More... | |
| CreateDatasourceResponse | createDatasource (const CreateDatasourceRequest &request_) const |
| Creates a data source, which contains the location and connection information for a data store that is external to the database. More... | |
| CreateDatasourceResponse & | createDatasource (const CreateDatasourceRequest &request_, CreateDatasourceResponse &response_) const |
| Creates a data source, which contains the location and connection information for a data store that is external to the database. More... | |
| CreateDatasourceResponse | createDatasource (const std::string &name, const std::string &location, const std::string &userName, const std::string &password, const std::map< std::string, std::string > &options) const |
| Creates a data source, which contains the location and connection information for a data store that is external to the database. More... | |
| CreateDatasourceResponse & | createDatasource (const std::string &name, const std::string &location, const std::string &userName, const std::string &password, const std::map< std::string, std::string > &options, CreateDatasourceResponse &response_) const |
| Creates a data source, which contains the location and connection information for a data store that is external to the database. More... | |
| CreateDirectoryResponse | createDirectory (const CreateDirectoryRequest &request_) const |
| Creates a new directory in KiFS. More... | |
| CreateDirectoryResponse & | createDirectory (const CreateDirectoryRequest &request_, CreateDirectoryResponse &response_) const |
| Creates a new directory in KiFS. More... | |
| CreateDirectoryResponse | createDirectory (const std::string &directoryName, const std::map< std::string, std::string > &options) const |
| Creates a new directory in KiFS. More... | |
| CreateDirectoryResponse & | createDirectory (const std::string &directoryName, const std::map< std::string, std::string > &options, CreateDirectoryResponse &response_) const |
| Creates a new directory in KiFS. More... | |
| CreateEnvironmentResponse | createEnvironment (const CreateEnvironmentRequest &request_) const |
| Creates a new environment which can be used by user-defined functions (UDF). More... | |
| CreateEnvironmentResponse & | createEnvironment (const CreateEnvironmentRequest &request_, CreateEnvironmentResponse &response_) const |
| Creates a new environment which can be used by user-defined functions (UDF). More... | |
| CreateEnvironmentResponse | createEnvironment (const std::string &environmentName, const std::map< std::string, std::string > &options) const |
| Creates a new environment which can be used by user-defined functions (UDF). More... | |
| CreateEnvironmentResponse & | createEnvironment (const std::string &environmentName, const std::map< std::string, std::string > &options, CreateEnvironmentResponse &response_) const |
| Creates a new environment which can be used by user-defined functions (UDF). 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 functions (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 functions (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 functions (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 functions (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... | |
| CreateSchemaResponse | createSchema (const CreateSchemaRequest &request_) const |
| Creates a SQL-style schema. More... | |
| CreateSchemaResponse & | createSchema (const CreateSchemaRequest &request_, CreateSchemaResponse &response_) const |
| Creates a SQL-style schema. More... | |
| CreateSchemaResponse | createSchema (const std::string &schemaName, const std::map< std::string, std::string > &options) const |
| Creates a SQL-style schema. More... | |
| CreateSchemaResponse & | createSchema (const std::string &schemaName, const std::map< std::string, std::string > &options, CreateSchemaResponse &response_) const |
| Creates a SQL-style schema. More... | |
| CreateTableResponse | createTable (const CreateTableRequest &request_) const |
| Creates a new table. More... | |
| CreateTableResponse & | createTable (const CreateTableRequest &request_, CreateTableResponse &response_) const |
| Creates a new table. More... | |
| CreateTableResponse | createTable (const std::string &tableName, const std::string &typeId, const std::map< std::string, std::string > &options) const |
| Creates a new table. 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. More... | |
| CreateTableExternalResponse | createTableExternal (const CreateTableExternalRequest &request_) const |
| Creates a new external table, which is a local database object whose source data is located externally to the database. More... | |
| CreateTableExternalResponse & | createTableExternal (const CreateTableExternalRequest &request_, CreateTableExternalResponse &response_) const |
| Creates a new external table, which is a local database object whose source data is located externally to the database. More... | |
| CreateTableExternalResponse | createTableExternal (const std::string &tableName, const std::vector< std::string > &filepaths, const std::map< std::string, std::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options) const |
| Creates a new external table, which is a local database object whose source data is located externally to the database. More... | |
| CreateTableExternalResponse & | createTableExternal (const std::string &tableName, const std::vector< std::string > &filepaths, const std::map< std::string, std::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options, CreateTableExternalResponse &response_) const |
| Creates a new external table, which is a local database object whose source data is located externally to the database. 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 of a table. More... | |
| CreateTypeResponse & | createType (const CreateTypeRequest &request_, CreateTypeResponse &response_) const |
| Creates a new type describing the layout 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 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 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... | |
| CreateVideoResponse | createVideo (const CreateVideoRequest &request_) const |
| Creates a job to generate a sequence of raster images that visualize data over a specified time. More... | |
| CreateVideoResponse & | createVideo (const CreateVideoRequest &request_, CreateVideoResponse &response_) const |
| Creates a job to generate a sequence of raster images that visualize data over a specified time. More... | |
| CreateVideoResponse | createVideo (const std::string &attribute, const std::string &begin, const double durationSeconds, const std::string &end, const double framesPerSecond, const std::string &style, const std::string &path, const std::string &styleParameters, const std::map< std::string, std::string > &options) const |
| Creates a job to generate a sequence of raster images that visualize data over a specified time. More... | |
| CreateVideoResponse & | createVideo (const std::string &attribute, const std::string &begin, const double durationSeconds, const std::string &end, const double framesPerSecond, const std::string &style, const std::string &path, const std::string &styleParameters, const std::map< std::string, std::string > &options, CreateVideoResponse &response_) const |
| Creates a job to generate a sequence of raster images that visualize data over a specified time. More... | |
| DeleteDirectoryResponse | deleteDirectory (const DeleteDirectoryRequest &request_) const |
| Deletes a directory from KiFS. More... | |
| DeleteDirectoryResponse & | deleteDirectory (const DeleteDirectoryRequest &request_, DeleteDirectoryResponse &response_) const |
| Deletes a directory from KiFS. More... | |
| DeleteDirectoryResponse | deleteDirectory (const std::string &directoryName, const std::map< std::string, std::string > &options) const |
| Deletes a directory from KiFS. More... | |
| DeleteDirectoryResponse & | deleteDirectory (const std::string &directoryName, const std::map< std::string, std::string > &options, DeleteDirectoryResponse &response_) const |
| Deletes a directory from KiFS. More... | |
| DeleteFilesResponse | deleteFiles (const DeleteFilesRequest &request_) const |
| Deletes one or more files from KiFS. More... | |
| DeleteFilesResponse & | deleteFiles (const DeleteFilesRequest &request_, DeleteFilesResponse &response_) const |
| Deletes one or more files from KiFS. More... | |
| DeleteFilesResponse | deleteFiles (const std::vector< std::string > &fileNames, const std::map< std::string, std::string > &options) const |
| Deletes one or more files from KiFS. More... | |
| DeleteFilesResponse & | deleteFiles (const std::vector< std::string > &fileNames, const std::map< std::string, std::string > &options, DeleteFilesResponse &response_) const |
| Deletes one or more files from KiFS. 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... | |
| DownloadFilesResponse | downloadFiles (const DownloadFilesRequest &request_) const |
| Downloads one or more files from KiFS. More... | |
| DownloadFilesResponse & | downloadFiles (const DownloadFilesRequest &request_, DownloadFilesResponse &response_) const |
| Downloads one or more files from KiFS. More... | |
| DownloadFilesResponse | downloadFiles (const std::vector< std::string > &fileNames, const std::vector< int64_t > &readOffsets, const std::vector< int64_t > &readLengths, const std::map< std::string, std::string > &options) const |
| Downloads one or more files from KiFS. More... | |
| DownloadFilesResponse & | downloadFiles (const std::vector< std::string > &fileNames, const std::vector< int64_t > &readOffsets, const std::vector< int64_t > &readLengths, const std::map< std::string, std::string > &options, DownloadFilesResponse &response_) const |
| Downloads one or more files from KiFS. More... | |
| DropCredentialResponse | dropCredential (const DropCredentialRequest &request_) const |
| Drop an existing credential. More... | |
| DropCredentialResponse & | dropCredential (const DropCredentialRequest &request_, DropCredentialResponse &response_) const |
| Drop an existing credential. More... | |
| DropCredentialResponse | dropCredential (const std::string &credentialName, const std::map< std::string, std::string > &options) const |
| Drop an existing credential. More... | |
| DropCredentialResponse & | dropCredential (const std::string &credentialName, const std::map< std::string, std::string > &options, DropCredentialResponse &response_) const |
| Drop an existing credential. More... | |
| DropDatasinkResponse | dropDatasink (const DropDatasinkRequest &request_) const |
| Drops an existing data sink. More... | |
| DropDatasinkResponse & | dropDatasink (const DropDatasinkRequest &request_, DropDatasinkResponse &response_) const |
| Drops an existing data sink. More... | |
| DropDatasinkResponse | dropDatasink (const std::string &name, const std::map< std::string, std::string > &options) const |
| Drops an existing data sink. More... | |
| DropDatasinkResponse & | dropDatasink (const std::string &name, const std::map< std::string, std::string > &options, DropDatasinkResponse &response_) const |
| Drops an existing data sink. More... | |
| DropDatasourceResponse | dropDatasource (const DropDatasourceRequest &request_) const |
| Drops an existing data source. More... | |
| DropDatasourceResponse & | dropDatasource (const DropDatasourceRequest &request_, DropDatasourceResponse &response_) const |
| Drops an existing data source. More... | |
| DropDatasourceResponse | dropDatasource (const std::string &name, const std::map< std::string, std::string > &options) const |
| Drops an existing data source. More... | |
| DropDatasourceResponse & | dropDatasource (const std::string &name, const std::map< std::string, std::string > &options, DropDatasourceResponse &response_) const |
| Drops an existing data source. More... | |
| DropEnvironmentResponse | dropEnvironment (const DropEnvironmentRequest &request_) const |
| Drop an existing user-defined function (UDF) environment. More... | |
| DropEnvironmentResponse & | dropEnvironment (const DropEnvironmentRequest &request_, DropEnvironmentResponse &response_) const |
| Drop an existing user-defined function (UDF) environment. More... | |
| DropEnvironmentResponse | dropEnvironment (const std::string &environmentName, const std::map< std::string, std::string > &options) const |
| Drop an existing user-defined function (UDF) environment. More... | |
| DropEnvironmentResponse & | dropEnvironment (const std::string &environmentName, const std::map< std::string, std::string > &options, DropEnvironmentResponse &response_) const |
| Drop an existing user-defined function (UDF) environment. More... | |
| DropSchemaResponse | dropSchema (const DropSchemaRequest &request_) const |
| Drops an existing SQL-style schema, specified in schemaName. More... | |
| DropSchemaResponse & | dropSchema (const DropSchemaRequest &request_, DropSchemaResponse &response_) const |
| Drops an existing SQL-style schema, specified in schemaName. More... | |
| DropSchemaResponse | dropSchema (const std::string &schemaName, const std::map< std::string, std::string > &options) const |
| Drops an existing SQL-style schema, specified in schemaName. More... | |
| DropSchemaResponse & | dropSchema (const std::string &schemaName, const std::map< std::string, std::string > &options, DropSchemaResponse &response_) const |
| Drops an existing SQL-style schema, specified in schemaName. 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 |
| Execute a SQL statement (query, DML, or DDL). More... | |
| RawExecuteSqlResponse & | executeSqlRaw (const ExecuteSqlRequest &request_, RawExecuteSqlResponse &response_) const |
| Execute a SQL statement (query, DML, or DDL). More... | |
| ExecuteSqlResponse | executeSql (const ExecuteSqlRequest &request_) const |
| Execute a SQL statement (query, DML, or DDL). More... | |
| ExecuteSqlResponse & | executeSql (const ExecuteSqlRequest &request_, ExecuteSqlResponse &response_) const |
| Execute a SQL statement (query, DML, or DDL). 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 |
| Execute a SQL statement (query, DML, or DDL). 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 |
| Execute a SQL statement (query, DML, or DDL). More... | |
| ExportQueryMetricsResponse | exportQueryMetrics (const ExportQueryMetricsRequest &request_) const |
| Export query metrics to a given destination. More... | |
| ExportQueryMetricsResponse & | exportQueryMetrics (const ExportQueryMetricsRequest &request_, ExportQueryMetricsResponse &response_) const |
| Export query metrics to a given destination. More... | |
| ExportQueryMetricsResponse | exportQueryMetrics (const std::map< std::string, std::string > &options) const |
| Export query metrics to a given destination. More... | |
| ExportQueryMetricsResponse & | exportQueryMetrics (const std::map< std::string, std::string > &options, ExportQueryMetricsResponse &response_) const |
| Export query metrics to a given destination. More... | |
| ExportRecordsToFilesResponse | exportRecordsToFiles (const ExportRecordsToFilesRequest &request_) const |
| Export records from a table to files. More... | |
| ExportRecordsToFilesResponse & | exportRecordsToFiles (const ExportRecordsToFilesRequest &request_, ExportRecordsToFilesResponse &response_) const |
| Export records from a table to files. More... | |
| ExportRecordsToFilesResponse | exportRecordsToFiles (const std::string &tableName, const std::string &filepath, const std::map< std::string, std::string > &options) const |
| Export records from a table to files. More... | |
| ExportRecordsToFilesResponse & | exportRecordsToFiles (const std::string &tableName, const std::string &filepath, const std::map< std::string, std::string > &options, ExportRecordsToFilesResponse &response_) const |
| Export records from a table to files. More... | |
| ExportRecordsToTableResponse | exportRecordsToTable (const ExportRecordsToTableRequest &request_) const |
| Exports records from source table to the specified target table in an external database. More... | |
| ExportRecordsToTableResponse & | exportRecordsToTable (const ExportRecordsToTableRequest &request_, ExportRecordsToTableResponse &response_) const |
| Exports records from source table to the specified target table in an external database. More... | |
| ExportRecordsToTableResponse | exportRecordsToTable (const std::string &tableName, const std::string &remoteQuery, const std::map< std::string, std::string > &options) const |
| Exports records from source table to the specified target table in an external database. More... | |
| ExportRecordsToTableResponse & | exportRecordsToTable (const std::string &tableName, const std::string &remoteQuery, const std::map< std::string, std::string > &options, ExportRecordsToTableResponse &response_) const |
| Exports records from source table to the specified target table in an external database. 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 or view. More... | |
| FilterByGeometryResponse & | filterByGeometry (const FilterByGeometryRequest &request_, FilterByGeometryResponse &response_) const |
| Applies a geometry filter against a geospatial geometry column in a given table 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 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 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. circular NAI). 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. circular NAI). 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. circular NAI). 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. circular NAI). 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. circular NAI). 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. circular NAI). 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. circular NAI). 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. circular NAI). 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 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 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 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 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... | |
| GrantPermissionResponse | grantPermission (const GrantPermissionRequest &request_) const |
| Grant user or role the specified permission on the specified object. More... | |
| GrantPermissionResponse & | grantPermission (const GrantPermissionRequest &request_, GrantPermissionResponse &response_) const |
| Grant user or role the specified permission on the specified object. More... | |
| GrantPermissionResponse | grantPermission (const std::string &principal, const std::string &object, const std::string &objectType, const std::string &permission, const std::map< std::string, std::string > &options) const |
| Grant user or role the specified permission on the specified object. More... | |
| GrantPermissionResponse & | grantPermission (const std::string &principal, const std::string &object, const std::string &objectType, const std::string &permission, const std::map< std::string, std::string > &options, GrantPermissionResponse &response_) const |
| Grant user or role the specified permission on the specified object. More... | |
| GrantPermissionCredentialResponse | grantPermissionCredential (const GrantPermissionCredentialRequest &request_) const |
| Grants a credential-level permission to a user or role. More... | |
| GrantPermissionCredentialResponse & | grantPermissionCredential (const GrantPermissionCredentialRequest &request_, GrantPermissionCredentialResponse &response_) const |
| Grants a credential-level permission to a user or role. More... | |
| GrantPermissionCredentialResponse | grantPermissionCredential (const std::string &name, const std::string &permission, const std::string &credentialName, const std::map< std::string, std::string > &options) const |
| Grants a credential-level permission to a user or role. More... | |
| GrantPermissionCredentialResponse & | grantPermissionCredential (const std::string &name, const std::string &permission, const std::string &credentialName, const std::map< std::string, std::string > &options, GrantPermissionCredentialResponse &response_) const |
| Grants a credential-level permission to a user or role. More... | |
| GrantPermissionDatasourceResponse | grantPermissionDatasource (const GrantPermissionDatasourceRequest &request_) const |
| Grants a data source permission to a user or role. More... | |
| GrantPermissionDatasourceResponse & | grantPermissionDatasource (const GrantPermissionDatasourceRequest &request_, GrantPermissionDatasourceResponse &response_) const |
| Grants a data source permission to a user or role. More... | |
| GrantPermissionDatasourceResponse | grantPermissionDatasource (const std::string &name, const std::string &permission, const std::string &datasourceName, const std::map< std::string, std::string > &options) const |
| Grants a data source permission to a user or role. More... | |
| GrantPermissionDatasourceResponse & | grantPermissionDatasource (const std::string &name, const std::string &permission, const std::string &datasourceName, const std::map< std::string, std::string > &options, GrantPermissionDatasourceResponse &response_) const |
| Grants a data source permission to a user or role. More... | |
| GrantPermissionDirectoryResponse | grantPermissionDirectory (const GrantPermissionDirectoryRequest &request_) const |
| Grants a KiFS directory-level permission to a user or role. More... | |
| GrantPermissionDirectoryResponse & | grantPermissionDirectory (const GrantPermissionDirectoryRequest &request_, GrantPermissionDirectoryResponse &response_) const |
| Grants a KiFS directory-level permission to a user or role. More... | |
| GrantPermissionDirectoryResponse | grantPermissionDirectory (const std::string &name, const std::string &permission, const std::string &directoryName, const std::map< std::string, std::string > &options) const |
| Grants a KiFS directory-level permission to a user or role. More... | |
| GrantPermissionDirectoryResponse & | grantPermissionDirectory (const std::string &name, const std::string &permission, const std::string &directoryName, const std::map< std::string, std::string > &options, GrantPermissionDirectoryResponse &response_) const |
| Grants a KiFS directory-level permission to a user or role. 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... | |
| HasPermissionResponse | hasPermission (const HasPermissionRequest &request_) const |
| Checks if the specified user has the specified permission on the specified object. More... | |
| HasPermissionResponse & | hasPermission (const HasPermissionRequest &request_, HasPermissionResponse &response_) const |
| Checks if the specified user has the specified permission on the specified object. More... | |
| HasPermissionResponse | hasPermission (const std::string &principal, const std::string &object, const std::string &objectType, const std::string &permission, const std::map< std::string, std::string > &options) const |
| Checks if the specified user has the specified permission on the specified object. More... | |
| HasPermissionResponse & | hasPermission (const std::string &principal, const std::string &object, const std::string &objectType, const std::string &permission, const std::map< std::string, std::string > &options, HasPermissionResponse &response_) const |
| Checks if the specified user has the specified permission on the specified object. 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... | |
| HasRoleResponse | hasRole (const HasRoleRequest &request_) const |
| Checks if the specified user has the specified role. More... | |
| HasRoleResponse & | hasRole (const HasRoleRequest &request_, HasRoleResponse &response_) const |
| Checks if the specified user has the specified role. More... | |
| HasRoleResponse | hasRole (const std::string &principal, const std::string &role, const std::map< std::string, std::string > &options) const |
| Checks if the specified user has the specified role. More... | |
| HasRoleResponse & | hasRole (const std::string &principal, const std::string &role, const std::map< std::string, std::string > &options, HasRoleResponse &response_) const |
| Checks if the specified user has the specified role. More... | |
| HasSchemaResponse | hasSchema (const HasSchemaRequest &request_) const |
| Checks for the existence of a schema with the given name. More... | |
| HasSchemaResponse & | hasSchema (const HasSchemaRequest &request_, HasSchemaResponse &response_) const |
| Checks for the existence of a schema with the given name. More... | |
| HasSchemaResponse | hasSchema (const std::string &schemaName, const std::map< std::string, std::string > &options) const |
| Checks for the existence of a schema with the given name. More... | |
| HasSchemaResponse & | hasSchema (const std::string &schemaName, const std::map< std::string, std::string > &options, HasSchemaResponse &response_) const |
| Checks for the existence of a schema 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 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 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::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options) const |
| Reads from one or more files 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::map< std::string, std::string > > &modifyColumns, 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 and inserts the data into a new or existing table. More... | |
| InsertRecordsFromPayloadResponse | insertRecordsFromPayload (const InsertRecordsFromPayloadRequest &request_) const |
| Reads from the given text-based or binary payload and inserts the data into a new or existing table. More... | |
| InsertRecordsFromPayloadResponse & | insertRecordsFromPayload (const InsertRecordsFromPayloadRequest &request_, InsertRecordsFromPayloadResponse &response_) const |
| Reads from the given text-based or binary payload and inserts the data into a new or existing table. More... | |
| InsertRecordsFromPayloadResponse | insertRecordsFromPayload (const std::string &tableName, const std::string &dataText, const std::vector< uint8_t > &dataBytes, const std::map< std::string, std::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options) const |
| Reads from the given text-based or binary payload and inserts the data into a new or existing table. More... | |
| InsertRecordsFromPayloadResponse & | insertRecordsFromPayload (const std::string &tableName, const std::string &dataText, const std::vector< uint8_t > &dataBytes, const std::map< std::string, std::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options, InsertRecordsFromPayloadResponse &response_) const |
| Reads from the given text-based or binary payload and inserts the data into a new or existing table. More... | |
| InsertRecordsFromQueryResponse | insertRecordsFromQuery (const InsertRecordsFromQueryRequest &request_) const |
| Computes remote query result and inserts the result data into a new or existing table. More... | |
| InsertRecordsFromQueryResponse & | insertRecordsFromQuery (const InsertRecordsFromQueryRequest &request_, InsertRecordsFromQueryResponse &response_) const |
| Computes remote query result and inserts the result data into a new or existing table. More... | |
| InsertRecordsFromQueryResponse | insertRecordsFromQuery (const std::string &tableName, const std::string &remoteQuery, const std::map< std::string, std::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options) const |
| Computes remote query result and inserts the result data into a new or existing table. More... | |
| InsertRecordsFromQueryResponse & | insertRecordsFromQuery (const std::string &tableName, const std::string &remoteQuery, const std::map< std::string, std::map< std::string, std::string > > &modifyColumns, const std::map< std::string, std::string > &createTableOptions, const std::map< std::string, std::string > &options, InsertRecordsFromQueryResponse &response_) const |
| Computes remote query result and inserts the result 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. an image) to represent data points when data is rendered visually. More... | |
| 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. 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. an image) to represent data points when data is rendered visually. 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. an image) to represent data points when data is rendered visually. 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 graph generated a-priori by createGraph 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 graph generated a-priori by createGraph 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 graph generated a-priori by createGraph 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 graph generated a-priori by createGraph 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... | |
| RepartitionGraphResponse | repartitionGraph (const RepartitionGraphRequest &request_) const |
| Rebalances an existing partitioned graph. More... | |
| RepartitionGraphResponse & | repartitionGraph (const RepartitionGraphRequest &request_, RepartitionGraphResponse &response_) const |
| Rebalances an existing partitioned graph. More... | |
| RepartitionGraphResponse | repartitionGraph (const std::string &graphName, const std::map< std::string, std::string > &options) const |
| Rebalances an existing partitioned graph. More... | |
| RepartitionGraphResponse & | repartitionGraph (const std::string &graphName, const std::map< std::string, std::string > &options, RepartitionGraphResponse &response_) const |
| Rebalances an existing partitioned graph. More... | |
| RevokePermissionResponse | revokePermission (const RevokePermissionRequest &request_) const |
| Revoke user or role the specified permission on the specified object. More... | |
| RevokePermissionResponse & | revokePermission (const RevokePermissionRequest &request_, RevokePermissionResponse &response_) const |
| Revoke user or role the specified permission on the specified object. More... | |
| RevokePermissionResponse | revokePermission (const std::string &principal, const std::string &object, const std::string &objectType, const std::string &permission, const std::map< std::string, std::string > &options) const |
| Revoke user or role the specified permission on the specified object. More... | |
| RevokePermissionResponse & | revokePermission (const std::string &principal, const std::string &object, const std::string &objectType, const std::string &permission, const std::map< std::string, std::string > &options, RevokePermissionResponse &response_) const |
| Revoke user or role the specified permission on the specified object. More... | |
| RevokePermissionCredentialResponse | revokePermissionCredential (const RevokePermissionCredentialRequest &request_) const |
| Revokes a credential-level permission from a user or role. More... | |
| RevokePermissionCredentialResponse & | revokePermissionCredential (const RevokePermissionCredentialRequest &request_, RevokePermissionCredentialResponse &response_) const |
| Revokes a credential-level permission from a user or role. More... | |
| RevokePermissionCredentialResponse | revokePermissionCredential (const std::string &name, const std::string &permission, const std::string &credentialName, const std::map< std::string, std::string > &options) const |
| Revokes a credential-level permission from a user or role. More... | |
| RevokePermissionCredentialResponse & | revokePermissionCredential (const std::string &name, const std::string &permission, const std::string &credentialName, const std::map< std::string, std::string > &options, RevokePermissionCredentialResponse &response_) const |
| Revokes a credential-level permission from a user or role. More... | |
| RevokePermissionDatasourceResponse | revokePermissionDatasource (const RevokePermissionDatasourceRequest &request_) const |
| Revokes a data source permission from a user or role. More... | |
| RevokePermissionDatasourceResponse & | revokePermissionDatasource (const RevokePermissionDatasourceRequest &request_, RevokePermissionDatasourceResponse &response_) const |
| Revokes a data source permission from a user or role. More... | |
| RevokePermissionDatasourceResponse | revokePermissionDatasource (const std::string &name, const std::string &permission, const std::string &datasourceName, const std::map< std::string, std::string > &options) const |
| Revokes a data source permission from a user or role. More... | |
| RevokePermissionDatasourceResponse & | revokePermissionDatasource (const std::string &name, const std::string &permission, const std::string &datasourceName, const std::map< std::string, std::string > &options, RevokePermissionDatasourceResponse &response_) const |
| Revokes a data source permission from a user or role. More... | |
| RevokePermissionDirectoryResponse | revokePermissionDirectory (const RevokePermissionDirectoryRequest &request_) const |
| Revokes a KiFS directory-level permission from a user or role. More... | |
| RevokePermissionDirectoryResponse & | revokePermissionDirectory (const RevokePermissionDirectoryRequest &request_, RevokePermissionDirectoryResponse &response_) const |
| Revokes a KiFS directory-level permission from a user or role. More... | |
| RevokePermissionDirectoryResponse | revokePermissionDirectory (const std::string &name, const std::string &permission, const std::string &directoryName, const std::map< std::string, std::string > &options) const |
| Revokes a KiFS directory-level permission from a user or role. More... | |
| RevokePermissionDirectoryResponse & | revokePermissionDirectory (const std::string &name, const std::string &permission, const std::string &directoryName, const std::map< std::string, std::string > &options, RevokePermissionDirectoryResponse &response_) const |
| Revokes a KiFS directory-level permission from a user or role. 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... | |
| ShowCredentialResponse | showCredential (const ShowCredentialRequest &request_) const |
| Shows information about a specified credential or all credentials. More... | |
| ShowCredentialResponse & | showCredential (const ShowCredentialRequest &request_, ShowCredentialResponse &response_) const |
| Shows information about a specified credential or all credentials. More... | |
| ShowCredentialResponse | showCredential (const std::string &credentialName, const std::map< std::string, std::string > &options) const |
| Shows information about a specified credential or all credentials. More... | |
| ShowCredentialResponse & | showCredential (const std::string &credentialName, const std::map< std::string, std::string > &options, ShowCredentialResponse &response_) const |
| Shows information about a specified credential or all credentials. More... | |
| ShowDatasinkResponse | showDatasink (const ShowDatasinkRequest &request_) const |
| Shows information about a specified data sink or all data sinks. More... | |
| ShowDatasinkResponse & | showDatasink (const ShowDatasinkRequest &request_, ShowDatasinkResponse &response_) const |
| Shows information about a specified data sink or all data sinks. More... | |
| ShowDatasinkResponse | showDatasink (const std::string &name, const std::map< std::string, std::string > &options) const |
| Shows information about a specified data sink or all data sinks. More... | |
| ShowDatasinkResponse & | showDatasink (const std::string &name, const std::map< std::string, std::string > &options, ShowDatasinkResponse &response_) const |
| Shows information about a specified data sink or all data sinks. More... | |
| ShowDatasourceResponse | showDatasource (const ShowDatasourceRequest &request_) const |
| Shows information about a specified data source or all data sources. More... | |
| ShowDatasourceResponse & | showDatasource (const ShowDatasourceRequest &request_, ShowDatasourceResponse &response_) const |
| Shows information about a specified data source or all data sources. More... | |
| ShowDatasourceResponse | showDatasource (const std::string &name, const std::map< std::string, std::string > &options) const |
| Shows information about a specified data source or all data sources. More... | |
| ShowDatasourceResponse & | showDatasource (const std::string &name, const std::map< std::string, std::string > &options, ShowDatasourceResponse &response_) const |
| Shows information about a specified data source or all data sources. More... | |
| ShowDirectoriesResponse | showDirectories (const ShowDirectoriesRequest &request_) const |
| Shows information about directories in KiFS. More... | |
| ShowDirectoriesResponse & | showDirectories (const ShowDirectoriesRequest &request_, ShowDirectoriesResponse &response_) const |
| Shows information about directories in KiFS. More... | |
| ShowDirectoriesResponse | showDirectories (const std::string &directoryName, const std::map< std::string, std::string > &options) const |
| Shows information about directories in KiFS. More... | |
| ShowDirectoriesResponse & | showDirectories (const std::string &directoryName, const std::map< std::string, std::string > &options, ShowDirectoriesResponse &response_) const |
| Shows information about directories in KiFS. More... | |
| ShowEnvironmentResponse | showEnvironment (const ShowEnvironmentRequest &request_) const |
| Shows information about a specified user-defined function (UDF) environment or all environments. More... | |
| ShowEnvironmentResponse & | showEnvironment (const ShowEnvironmentRequest &request_, ShowEnvironmentResponse &response_) const |
| Shows information about a specified user-defined function (UDF) environment or all environments. More... | |
| ShowEnvironmentResponse | showEnvironment (const std::string &environmentName, const std::map< std::string, std::string > &options) const |
| Shows information about a specified user-defined function (UDF) environment or all environments. More... | |
| ShowEnvironmentResponse & | showEnvironment (const std::string &environmentName, const std::map< std::string, std::string > &options, ShowEnvironmentResponse &response_) const |
| Shows information about a specified user-defined function (UDF) environment or all environments. More... | |
| ShowFilesResponse | showFiles (const ShowFilesRequest &request_) const |
| Shows information about files in KiFS. More... | |
| ShowFilesResponse & | showFiles (const ShowFilesRequest &request_, ShowFilesResponse &response_) const |
| Shows information about files in KiFS. More... | |
| ShowFilesResponse | showFiles (const std::vector< std::string > &paths, const std::map< std::string, std::string > &options) const |
| Shows information about files in KiFS. More... | |
| ShowFilesResponse & | showFiles (const std::vector< std::string > &paths, const std::map< std::string, std::string > &options, ShowFilesResponse &response_) const |
| Shows information about files in KiFS. 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... | |
| ShowResourceObjectsResponse | showResourceObjects (const ShowResourceObjectsRequest &request_) const |
| Returns information about the internal sub-components (tiered objects) which use resources of the system. More... | |
| ShowResourceObjectsResponse & | showResourceObjects (const ShowResourceObjectsRequest &request_, ShowResourceObjectsResponse &response_) const |
| Returns information about the internal sub-components (tiered objects) which use resources of the system. More... | |
| ShowResourceObjectsResponse | showResourceObjects (const std::map< std::string, std::string > &options) const |
| Returns information about the internal sub-components (tiered objects) which use resources of the system. More... | |
| ShowResourceObjectsResponse & | showResourceObjects (const std::map< std::string, std::string > &options, ShowResourceObjectsResponse &response_) const |
| Returns information about the internal sub-components (tiered objects) which use resources of the system. 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... | |
| ShowSchemaResponse | showSchema (const ShowSchemaRequest &request_) const |
| Retrieves information about a schema (or all schemas), as specified in schemaName. More... | |
| ShowSchemaResponse & | showSchema (const ShowSchemaRequest &request_, ShowSchemaResponse &response_) const |
| Retrieves information about a schema (or all schemas), as specified in schemaName. More... | |
| ShowSchemaResponse | showSchema (const std::string &schemaName, const std::map< std::string, std::string > &options) const |
| Retrieves information about a schema (or all schemas), as specified in schemaName. More... | |
| ShowSchemaResponse & | showSchema (const std::string &schemaName, const std::map< std::string, std::string > &options, ShowSchemaResponse &response_) const |
| Retrieves information about a schema (or all schemas), as specified in schemaName. 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(s). More... | |
| ShowStatisticsResponse & | showStatistics (const ShowStatisticsRequest &request_, ShowStatisticsResponse &response_) const |
| Retrieves the collected column statistics for the specified table(s). 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(s). 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(s). 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 schema, specified in tableName. More... | |
| ShowTableResponse & | showTable (const ShowTableRequest &request_, ShowTableResponse &response_) const |
| Retrieves detailed information about a table, view, or schema, 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 schema, 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 schema, 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... | |
| ShowTableMonitorsResponse | showTableMonitors (const ShowTableMonitorsRequest &request_) const |
| Show table monitors and their properties. More... | |
| ShowTableMonitorsResponse & | showTableMonitors (const ShowTableMonitorsRequest &request_, ShowTableMonitorsResponse &response_) const |
| Show table monitors and their properties. More... | |
| ShowTableMonitorsResponse | showTableMonitors (const std::vector< std::string > &monitorIds, const std::map< std::string, std::string > &options) const |
| Show table monitors and their properties. More... | |
| ShowTableMonitorsResponse & | showTableMonitors (const std::vector< std::string > &monitorIds, const std::map< std::string, std::string > &options, ShowTableMonitorsResponse &response_) const |
| Show table monitors and their properties. 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... | |
| ShowVideoResponse | showVideo (const ShowVideoRequest &request_) const |
| Retrieves information about rendered videos. More... | |
| ShowVideoResponse & | showVideo (const ShowVideoRequest &request_, ShowVideoResponse &response_) const |
| Retrieves information about rendered videos. More... | |
| ShowVideoResponse | showVideo (const std::vector< std::string > &paths, const std::map< std::string, std::string > &options) const |
| Retrieves information about rendered videos. More... | |
| ShowVideoResponse & | showVideo (const std::vector< std::string > &paths, const std::map< std::string, std::string > &options, ShowVideoResponse &response_) const |
| Retrieves information about rendered videos. More... | |
| ShowWalResponse | showWal (const ShowWalRequest &request_) const |
| Requests table wal properties. More... | |
| ShowWalResponse & | showWal (const ShowWalRequest &request_, ShowWalResponse &response_) const |
| Requests table wal properties. More... | |
| ShowWalResponse | showWal (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options) const |
| Requests table wal properties. More... | |
| ShowWalResponse & | showWal (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options, ShowWalResponse &response_) const |
| Requests table wal properties. 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... | |
| UploadFilesResponse | uploadFiles (const UploadFilesRequest &request_) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesResponse & | uploadFiles (const UploadFilesRequest &request_, UploadFilesResponse &response_) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesResponse | uploadFiles (const std::vector< std::string > &fileNames, const std::vector< std::vector< uint8_t > > &fileData, const std::map< std::string, std::string > &options) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesResponse & | uploadFiles (const std::vector< std::string > &fileNames, const std::vector< std::vector< uint8_t > > &fileData, const std::map< std::string, std::string > &options, UploadFilesResponse &response_) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesFromurlResponse | uploadFilesFromurl (const UploadFilesFromurlRequest &request_) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesFromurlResponse & | uploadFilesFromurl (const UploadFilesFromurlRequest &request_, UploadFilesFromurlResponse &response_) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesFromurlResponse | uploadFilesFromurl (const std::vector< std::string > &fileNames, const std::vector< std::string > &urls, const std::map< std::string, std::string > &options) const |
| Uploads one or more files to KiFS. More... | |
| UploadFilesFromurlResponse & | uploadFilesFromurl (const std::vector< std::string > &fileNames, const std::vector< std::string > &urls, const std::map< std::string, std::string > &options, UploadFilesFromurlResponse &response_) const |
| Uploads one or more files to KiFS. 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... | |
| void | addKnownType (const std::string &typeId, const avro::DecoderPtr &decoder) |
| template<typename T > | |
| void | addKnownType (const std::string &typeId) |
| template<typename T > | |
| void | addKnownType (const std::string &typeId, const std::string &schemaString) |
| template<typename T > | |
| void | addKnownType (const std::string &typeId, const ::avro::ValidSchema &schema) |
| void | addKnownTypeFromTable (const std::string &tableName, const avro::DecoderPtr &decoder) |
| template<typename T > | |
| void | addKnownTypeFromTable (const std::string &tableName) |
| template<typename T > | |
| void | addKnownTypeFromTable (const std::string &tableName, const std::string &schemaString) |
| template<typename T > | |
| void | addKnownTypeFromTable (const std::string &tableName, const ::avro::ValidSchema &schema) |
| template<> | |
| GetRecordsResponse< boost::any > | getRecords (const GetRecordsRequest &request_) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsResponse< boost::any > & | getRecords (const GetRecordsRequest &request_, GetRecordsResponse< boost::any > &response_) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsResponse< boost::any > | getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsResponse< boost::any > & | getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< boost::any > &response_) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > | getRecordsBySeries (const GetRecordsBySeriesRequest &request_) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > & | getRecordsBySeries (const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< boost::any > &response_) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > | getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > & | getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< boost::any > &response_) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > | getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > & | getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< boost::any > &response_) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > | getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > & | getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< boost::any > &response_) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsResponse< boost::any > | getRecords (const GetRecordsRequest &request_) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsResponse< boost::any > & | getRecords (const GetRecordsRequest &request_, GetRecordsResponse< boost::any > &response_) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsResponse< boost::any > | getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsResponse< boost::any > & | getRecords (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsResponse< boost::any > &response_) const |
| Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > | getRecordsBySeries (const GetRecordsBySeriesRequest &request_) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > & | getRecordsBySeries (const GetRecordsBySeriesRequest &request_, GetRecordsBySeriesResponse< boost::any > &response_) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > | getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsBySeriesResponse< boost::any > & | getRecordsBySeries (const std::string &tableName, const std::string &worldTableName, const int32_t offset, const int32_t limit, const std::map< std::string, std::string > &options, GetRecordsBySeriesResponse< boost::any > &response_) const |
| Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > | getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > & | getRecordsFromCollection (const GetRecordsFromCollectionRequest &request_, GetRecordsFromCollectionResponse< boost::any > &response_) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > | getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const |
| Retrieves records from a collection. More... | |
| template<> | |
| GetRecordsFromCollectionResponse< boost::any > & | getRecordsFromCollection (const std::string &tableName, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options, GetRecordsFromCollectionResponse< boost::any > &response_) const |
| Retrieves records from a collection. More... | |
Static Public Member Functions | |
| static std::string | getApiVersion () |
Static Public Attributes | |
| static const int64_t | END_OF_SET = -9999 |
| static const std::string | DB_CONNECTION_RESET_ERROR_MESSAGE |
| Special error messages indicating that a connection failure happened (generally should trigger a high-availability failover if applicable) More... | |
| static const std::string | DB_CONNECTION_REFUSED_ERROR_MESSAGE |
| static const std::string | DB_EXITING_ERROR_MESSAGE |
| static const std::string | DB_OFFLINE_ERROR_MESSAGE |
| static const std::string | DB_SYSTEM_LIMITED_ERROR_MESSAGE |
| static const std::string | DB_HM_OFFLINE_ERROR_MESSAGE |
| static const std::string | HEADER_AUTHORIZATION |
| Headers used internally; MUST add each of them to PROTECTED_HEADERS in the .cpp file. More... | |
| static const std::string | HEADER_CONTENT_TYPE |
| static const std::string | HEADER_CONTENT_LENGTH |
| static const std::string | HEADER_HA_SYNC_MODE |
A enumeration of high-availability synchronicity override modes.
Pass a single HttpURL and options to instantiate a GPUdb object.
| [in] | url | An HttpURL object containing the single host URL for the client. If no primary URL is specified via the options, the given URL will be used as the primary URL. |
| [in] | options | An optional GPUdb::Options object containing options, e.g. primary cluster URL, used to the create the GPUdb object. |
Pass a single or multiple, comma-separated URLs as a string and optional options to instantiate a GPUdb object.
| [in] | url | An std::string containing the one host URL or a comma-separated string with multiple host URLs for the client. For example 'http://172.42.40.1:9191,,http://172.42.40.2:9191'. If a single URL is given, and no primary URL is specified via the options, the given URL will be used as the primary URL. |
| [in] | options | An optional GPUdb::Options object containing options, e.g. primary cluster URL, used to the create the GPUdb object. |
Pass multiple HttpURLs and optional options to instantiate a GPUdb object.
| [in] | urls | The host URLs for the client. If a single URL is given, and no primary URL is specified via the options, the given URL will be used as the primary URL. |
| [in] | options | An optional GPUdb::Options object containing options, e.g. primary cluster URL, used to the create the GPUdb object. |
| gpudb::GPUdb::GPUdb | ( | const std::vector< std::string > & | urls, |
| const Options & | options = Options() |
||
| ) |
Pass multiple strings, each containing a single URL, and optional options to instantiate a GPUdb object.
| [in] | urls | The host URLs for the client. Each string must contain a single valid URL. If a single URL is given, and no primary URL is specified via the options, the given URL will be used as the primary URL. |
| [in] | options | An optional GPUdb::Options object containing options, e.g. primary cluster URL, used to the create the GPUdb object. |
| gpudb::GPUdb::~GPUdb | ( | ) |
Destructor.
| void gpudb::GPUdb::addHttpHeader | ( | const std::string & | header, |
| const std::string & | value | ||
| ) |
Adds an HTTP header to the map of additional HTTP headers to send to GPUdb with each request.
If the header is already in the map, its value is replaced with the specified value. The user is not allowed to modify the following headers:
| header | the HTTP header |
| value | the value of the HTTP header |
See getHttpHeaders() See removeHttpHeader(const std::string&)
| void gpudb::GPUdb::addKnownType | ( | const std::string & | typeId, |
| const avro::DecoderPtr & | decoder | ||
| ) |
|
inline |
|
inline |
|
inline |
| void gpudb::GPUdb::addKnownTypeFromTable | ( | const std::string & | tableName, |
| const avro::DecoderPtr & | decoder | ||
| ) |
|
inline |
|
inline |
|
inline |
| AdminAddHostResponse gpudb::GPUdb::adminAddHost | ( | const AdminAddHostRequest & | request_ | ) | const |
| AdminAddHostResponse& gpudb::GPUdb::adminAddHost | ( | const AdminAddHostRequest & | request_, |
| AdminAddHostResponse & | response_ | ||
| ) | const |
Adds a host to an existing cluster.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminAddHostResponse gpudb::GPUdb::adminAddHost | ( | const std::string & | hostAddress, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Adds a host to an existing cluster.
| [in] | hostAddress | IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added. |
| [in] | options | Optional parameters.
|
| AdminAddHostResponse& gpudb::GPUdb::adminAddHost | ( | const std::string & | hostAddress, |
| const std::map< std::string, std::string > & | options, | ||
| AdminAddHostResponse & | response_ | ||
| ) | const |
Adds a host to an existing cluster.
| [in] | hostAddress | IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminAddRanksResponse gpudb::GPUdb::adminAddRanks | ( | const AdminAddRanksRequest & | request_ | ) | const |
Add one or more ranks to an existing Kinetica cluster.
The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use adminRebalance.
The database must be offline for this operation, see adminOffline
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 createJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminAddRanksResponse& gpudb::GPUdb::adminAddRanks | ( | const AdminAddRanksRequest & | request_, |
| AdminAddRanksResponse & | response_ | ||
| ) | const |
Add one or more ranks to an existing Kinetica cluster.
The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use adminRebalance.
The database must be offline for this operation, see adminOffline
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 createJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminAddRanksResponse gpudb::GPUdb::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 ranks to an existing Kinetica cluster.
The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use adminRebalance.
The database must be offline for this operation, see adminOffline
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 createJob.
| [in] | hosts | Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use adminAddHost. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, hosts could look like '["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the configParams. |
| [in] | configParams | Array of maps containing configuration parameters to apply to the new ranks found in hosts. For example, '{"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"}'. Currently, the available parameters are rank-specific parameters in the Network, Hardware, Text Search, and RAM Tiered Storage sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by hosts instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in configParams as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the hosts. This array must either be completely empty or have the same number of elements as the hosts. An empty configParams array will result in the new ranks being set with default parameters. |
| [in] | options | Optional parameters.
|
| AdminAddRanksResponse& gpudb::GPUdb::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 ranks to an existing Kinetica cluster.
The new ranks will not contain any data initially (other than replicated tables) and will not be assigned any shards. To rebalance data and shards across the cluster, use adminRebalance.
The database must be offline for this operation, see adminOffline
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 createJob.
| [in] | hosts | Array of host IP addresses (matching a hostN.address from the gpudb.conf file), or host identifiers (e.g. 'host0' from the gpudb.conf file), on which to add ranks to the cluster. The hosts must already be in the cluster. If needed beforehand, to add a new host to the cluster use adminAddHost. Include the same entry as many times as there are ranks to add to the cluster, e.g., if two ranks on host 172.123.45.67 should be added, hosts could look like '["172.123.45.67", "172.123.45.67"]'. All ranks will be added simultaneously, i.e. they're not added in the order of this array. Each entry in this array corresponds to the entry at the same index in the configParams. |
| [in] | configParams | Array of maps containing configuration parameters to apply to the new ranks found in hosts. For example, '{"rank.gpu":"2", "tier.ram.rank.limit":"10000000000"}'. Currently, the available parameters are rank-specific parameters in the Network, Hardware, Text Search, and RAM Tiered Storage sections in the gpudb.conf file, with the key exception of the 'rankN.host' settings in the Network section that will be determined by hosts instead. Though many of these configuration parameters typically are affixed with 'rankN' in the gpudb.conf file (where N is the rank number), the 'N' should be omitted in configParams as the new rank number(s) are not allocated until the ranks have been added to the cluster. Each entry in this array corresponds to the entry at the same index in the hosts. This array must either be completely empty or have the same number of elements as the hosts. An empty configParams array will result in the new ranks being set with default parameters. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminAlterHostResponse gpudb::GPUdb::adminAlterHost | ( | const AdminAlterHostRequest & | request_ | ) | const |
| AdminAlterHostResponse& gpudb::GPUdb::adminAlterHost | ( | const AdminAlterHostRequest & | request_, |
| AdminAlterHostResponse & | response_ | ||
| ) | const |
Alter properties on an existing host in the cluster.
Currently, the only property that can be altered is a hosts ability to accept failover processes.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminAlterHostResponse gpudb::GPUdb::adminAlterHost | ( | const std::string & | host, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alter properties on an existing host in the cluster.
Currently, the only property that can be altered is a hosts ability to accept failover processes.
| [in] | host | Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf |
| [in] | options | Optional parameters.
|
| AdminAlterHostResponse& gpudb::GPUdb::adminAlterHost | ( | const std::string & | host, |
| const std::map< std::string, std::string > & | options, | ||
| AdminAlterHostResponse & | response_ | ||
| ) | const |
Alter properties on an existing host in the cluster.
Currently, the only property that can be altered is a hosts ability to accept failover processes.
| [in] | host | Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminAlterJobsResponse gpudb::GPUdb::adminAlterJobs | ( | const AdminAlterJobsRequest & | request_ | ) | const |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminAlterJobsResponse& gpudb::GPUdb::adminAlterJobs | ( | const AdminAlterJobsRequest & | request_, |
| AdminAlterJobsResponse & | response_ | ||
| ) | const |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminAlterJobsResponse gpudb::GPUdb::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.
| [in] | jobIds | Jobs to be modified. |
| [in] | action | Action to be performed on the jobs specified by job_ids. Supported values: |
| [in] | options | Optional parameters.
|
| AdminAlterJobsResponse& gpudb::GPUdb::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.
| [in] | jobIds | Jobs to be modified. |
| [in] | action | Action to be performed on the jobs specified by job_ids. Supported values: |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminBackupBeginResponse gpudb::GPUdb::adminBackupBegin | ( | const AdminBackupBeginRequest & | request_ | ) | const |
Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete.
When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using adminBackupEnd.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminBackupBeginResponse& gpudb::GPUdb::adminBackupBegin | ( | const AdminBackupBeginRequest & | request_, |
| AdminBackupBeginResponse & | response_ | ||
| ) | const |
Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete.
When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using adminBackupEnd.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminBackupBeginResponse gpudb::GPUdb::adminBackupBegin | ( | const std::map< std::string, std::string > & | options | ) | const |
Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete.
When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using adminBackupEnd.
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminBackupBeginResponse& gpudb::GPUdb::adminBackupBegin | ( | const std::map< std::string, std::string > & | options, |
| AdminBackupBeginResponse & | response_ | ||
| ) | const |
Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete.
When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using adminBackupEnd.
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminBackupEndResponse gpudb::GPUdb::adminBackupEnd | ( | const AdminBackupEndRequest & | request_ | ) | const |
| AdminBackupEndResponse& gpudb::GPUdb::adminBackupEnd | ( | const AdminBackupEndRequest & | request_, |
| AdminBackupEndResponse & | response_ | ||
| ) | const |
Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminBackupEndResponse gpudb::GPUdb::adminBackupEnd | ( | const std::map< std::string, std::string > & | options | ) | const |
Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete.
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminBackupEndResponse& gpudb::GPUdb::adminBackupEnd | ( | const std::map< std::string, std::string > & | options, |
| AdminBackupEndResponse & | response_ | ||
| ) | const |
Restores the system to normal operating mode after a backup has completed, allowing any queries that were blocked to complete.
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminHaRefreshResponse gpudb::GPUdb::adminHaRefresh | ( | const AdminHaRefreshRequest & | request_ | ) | const |
Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes.
Additionally the cluster is put into read-only while HA is restarting.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminHaRefreshResponse& gpudb::GPUdb::adminHaRefresh | ( | const AdminHaRefreshRequest & | request_, |
| AdminHaRefreshResponse & | response_ | ||
| ) | const |
Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes.
Additionally the cluster is put into read-only while HA is restarting.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminHaRefreshResponse gpudb::GPUdb::adminHaRefresh | ( | const std::map< std::string, std::string > & | options | ) | const |
Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes.
Additionally the cluster is put into read-only while HA is restarting.
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminHaRefreshResponse& gpudb::GPUdb::adminHaRefresh | ( | const std::map< std::string, std::string > & | options, |
| AdminHaRefreshResponse & | response_ | ||
| ) | const |
Restarts the HA processing on the given cluster as a mechanism of accepting breaking HA conf changes.
Additionally the cluster is put into read-only while HA is restarting.
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminOfflineResponse gpudb::GPUdb::adminOffline | ( | const AdminOfflineRequest & | request_ | ) | const |
| AdminOfflineResponse& gpudb::GPUdb::adminOffline | ( | const AdminOfflineRequest & | request_, |
| AdminOfflineResponse & | response_ | ||
| ) | const |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminOfflineResponse gpudb::GPUdb::adminOffline | ( | const bool | offline, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| [in] | offline | Set to true if desired state is offline. Supported values:
|
| [in] | options | Optional parameters.
|
| AdminOfflineResponse& gpudb::GPUdb::adminOffline | ( | const bool | offline, |
| const std::map< std::string, std::string > & | options, | ||
| AdminOfflineResponse & | response_ | ||
| ) | const |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
| [in] | offline | Set to true if desired state is offline. Supported values:
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminRebalanceResponse gpudb::GPUdb::adminRebalance | ( | const AdminRebalanceRequest & | request_ | ) | const |
Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.
The database must be offline for this operation, see adminOffline
NOTE: Replicated data will not move as a result of this call
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminRebalanceResponse& gpudb::GPUdb::adminRebalance | ( | const AdminRebalanceRequest & | request_, |
| AdminRebalanceResponse & | response_ | ||
| ) | const |
Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.
The database must be offline for this operation, see adminOffline
NOTE: Replicated data will not move as a result of this call
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminRebalanceResponse gpudb::GPUdb::adminRebalance | ( | const std::map< std::string, std::string > & | options | ) | const |
Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.
The database must be offline for this operation, see adminOffline
NOTE: Replicated data will not move as a result of this call
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | options | Optional parameters.
|
| AdminRebalanceResponse& gpudb::GPUdb::adminRebalance | ( | const std::map< std::string, std::string > & | options, |
| AdminRebalanceResponse & | response_ | ||
| ) | const |
Rebalance the data in the cluster so that all nodes contain an equal number of records approximately and/or rebalance the shards to be equally distributed (as much as possible) across all the ranks.
The database must be offline for this operation, see adminOffline
NOTE: Replicated data will not move as a result of this call
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminRemoveHostResponse gpudb::GPUdb::adminRemoveHost | ( | const AdminRemoveHostRequest & | request_ | ) | const |
Removes a host from an existing cluster.
If the host to be removed has any ranks running on it, the ranks must be removed using adminRemoveRanks or manually switched over to a new host using adminSwitchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using adminSwitchover.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminRemoveHostResponse& gpudb::GPUdb::adminRemoveHost | ( | const AdminRemoveHostRequest & | request_, |
| AdminRemoveHostResponse & | response_ | ||
| ) | const |
Removes a host from an existing cluster.
If the host to be removed has any ranks running on it, the ranks must be removed using adminRemoveRanks or manually switched over to a new host using adminSwitchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using adminSwitchover.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminRemoveHostResponse gpudb::GPUdb::adminRemoveHost | ( | const std::string & | host, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Removes a host from an existing cluster.
If the host to be removed has any ranks running on it, the ranks must be removed using adminRemoveRanks or manually switched over to a new host using adminSwitchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using adminSwitchover.
| [in] | host | Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf |
| [in] | options | Optional parameters.
|
| AdminRemoveHostResponse& gpudb::GPUdb::adminRemoveHost | ( | const std::string & | host, |
| const std::map< std::string, std::string > & | options, | ||
| AdminRemoveHostResponse & | response_ | ||
| ) | const |
Removes a host from an existing cluster.
If the host to be removed has any ranks running on it, the ranks must be removed using adminRemoveRanks or manually switched over to a new host using adminSwitchover prior to host removal. If the host to be removed has the graph server or SQL planner running on it, these must be manually switched over to a new host using adminSwitchover.
| [in] | host | Identifies the host this applies to. Can be the host address, or formatted as 'hostN' where N is the host number as specified in gpudb.conf |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminRemoveRanksResponse gpudb::GPUdb::adminRemoveRanks | ( | const AdminRemoveRanksRequest & | request_ | ) | const |
Remove one or more ranks from an existing Kinetica cluster.
All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.
The database must be offline for this operation, see adminOffline
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminRemoveRanksResponse& gpudb::GPUdb::adminRemoveRanks | ( | const AdminRemoveRanksRequest & | request_, |
| AdminRemoveRanksResponse & | response_ | ||
| ) | const |
Remove one or more ranks from an existing Kinetica cluster.
All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.
The database must be offline for this operation, see adminOffline
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminRemoveRanksResponse gpudb::GPUdb::adminRemoveRanks | ( | const std::vector< std::string > & | ranks, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Remove one or more ranks from an existing Kinetica cluster.
All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.
The database must be offline for this operation, see adminOffline
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | ranks | Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using adminSwitchover). At least one worker rank must be left in the cluster after the operation. |
| [in] | options | Optional parameters.
|
| AdminRemoveRanksResponse& gpudb::GPUdb::adminRemoveRanks | ( | const std::vector< std::string > & | ranks, |
| const std::map< std::string, std::string > & | options, | ||
| AdminRemoveRanksResponse & | response_ | ||
| ) | const |
Remove one or more ranks from an existing Kinetica cluster.
All data will be rebalanced to other ranks before the rank(s) is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.
The database must be offline for this operation, see adminOffline
This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
| [in] | ranks | Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using adminSwitchover). At least one worker rank must be left in the cluster after the operation. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminRepairTableResponse gpudb::GPUdb::adminRepairTable | ( | const AdminRepairTableRequest & | request_ | ) | const |
| AdminRepairTableResponse& gpudb::GPUdb::adminRepairTable | ( | const AdminRepairTableRequest & | request_, |
| AdminRepairTableResponse & | response_ | ||
| ) | const |
Manually repair a corrupted table.
Returns information about affected tables.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminRepairTableResponse gpudb::GPUdb::adminRepairTable | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Manually repair a corrupted table.
Returns information about affected tables.
| [in] | tableNames | List of tables to query. An asterisk returns all tables. |
| [in] | options | Optional parameters.
|
| AdminRepairTableResponse& gpudb::GPUdb::adminRepairTable | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options, | ||
| AdminRepairTableResponse & | response_ | ||
| ) | const |
Manually repair a corrupted table.
Returns information about affected tables.
| [in] | tableNames | List of tables to query. An asterisk returns all tables. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowAlertsResponse gpudb::GPUdb::adminShowAlerts | ( | const AdminShowAlertsRequest & | request_ | ) | const |
| AdminShowAlertsResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminShowAlertsResponse& gpudb::GPUdb::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.
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowClusterOperationsResponse gpudb::GPUdb::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& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | historyIndex | Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminShowClusterOperationsResponse& gpudb::GPUdb::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.
| [in] | historyIndex | Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowJobsResponse gpudb::GPUdb::adminShowJobs | ( | const AdminShowJobsRequest & | request_ | ) | const |
| AdminShowJobsResponse& gpudb::GPUdb::adminShowJobs | ( | const AdminShowJobsRequest & | request_, |
| AdminShowJobsResponse & | response_ | ||
| ) | const |
| AdminShowJobsResponse gpudb::GPUdb::adminShowJobs | ( | const std::map< std::string, std::string > & | options | ) | const |
Get a list of the current jobs in GPUdb.
| [in] | options | Optional parameters.
|
| AdminShowJobsResponse& gpudb::GPUdb::adminShowJobs | ( | const std::map< std::string, std::string > & | options, |
| AdminShowJobsResponse & | response_ | ||
| ) | const |
Get a list of the current jobs in GPUdb.
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowShardsResponse gpudb::GPUdb::adminShowShards | ( | const AdminShowShardsRequest & | request_ | ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminShowShardsResponse& gpudb::GPUdb::adminShowShards | ( | const AdminShowShardsRequest & | request_, |
| AdminShowShardsResponse & | response_ | ||
| ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShowShardsResponse gpudb::GPUdb::adminShowShards | ( | const std::map< std::string, std::string > & | options | ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminShowShardsResponse& gpudb::GPUdb::adminShowShards | ( | const std::map< std::string, std::string > & | options, |
| AdminShowShardsResponse & | response_ | ||
| ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminShutdownResponse gpudb::GPUdb::adminShutdown | ( | const AdminShutdownRequest & | request_ | ) | const |
| AdminShutdownResponse& gpudb::GPUdb::adminShutdown | ( | const AdminShutdownRequest & | request_, |
| AdminShutdownResponse & | response_ | ||
| ) | const |
| AdminShutdownResponse gpudb::GPUdb::adminShutdown | ( | const std::string & | exitType, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Exits the database server application.
| [in] | exitType | Reserved for future use. User can pass an empty string. |
| [in] | authorization | No longer used. User can pass an empty string. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AdminShutdownResponse& gpudb::GPUdb::adminShutdown | ( | const std::string & | exitType, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options, | ||
| AdminShutdownResponse & | response_ | ||
| ) | const |
Exits the database server application.
| [in] | exitType | Reserved for future use. User can pass an empty string. |
| [in] | authorization | No longer used. User can pass an empty string. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminSwitchoverResponse gpudb::GPUdb::adminSwitchover | ( | const AdminSwitchoverRequest & | request_ | ) | const |
Manually switch over one or more processes to another host.
Individual ranks or entire hosts may be moved to another host.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminSwitchoverResponse& gpudb::GPUdb::adminSwitchover | ( | const AdminSwitchoverRequest & | request_, |
| AdminSwitchoverResponse & | response_ | ||
| ) | const |
Manually switch over one or more processes to another host.
Individual ranks or entire hosts may be moved to another host.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminSwitchoverResponse gpudb::GPUdb::adminSwitchover | ( | const std::vector< std::string > & | processes, |
| const std::vector< std::string > & | destinations, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Manually switch over one or more processes to another host.
Individual ranks or entire hosts may be moved to another host.
| [in] | processes | Indicates the process identifier to switch over to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host[N].address' or 'rank[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations. |
| [in] | destinations | Indicates to which host to switch over each corresponding process given in processes. Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host[N].address'. Each entry in this array will receive the corresponding process entry at the same index in processes. |
| [in] | options | Optional parameters.
|
| AdminSwitchoverResponse& gpudb::GPUdb::adminSwitchover | ( | const std::vector< std::string > & | processes, |
| const std::vector< std::string > & | destinations, | ||
| const std::map< std::string, std::string > & | options, | ||
| AdminSwitchoverResponse & | response_ | ||
| ) | const |
Manually switch over one or more processes to another host.
Individual ranks or entire hosts may be moved to another host.
| [in] | processes | Indicates the process identifier to switch over to another host. Options are 'hostN' and 'rankN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host[N].address' or 'rank[N].host'. If 'hostN' is provided, all processes on that host will be moved to another host. Each entry in this array will be switched over to the corresponding host entry at the same index in destinations. |
| [in] | destinations | Indicates to which host to switch over each corresponding process given in processes. Each index must be specified as 'hostN' where 'N' corresponds to the number associated with a host or rank in the Network section of the gpudb.conf file; e.g., 'host[N].address'. Each entry in this array will receive the corresponding process entry at the same index in processes. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AdminVerifyDbResponse gpudb::GPUdb::adminVerifyDb | ( | const AdminVerifyDbRequest & | request_ | ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
| [in] | request_ | Request object containing the parameters for the operation. |
| AdminVerifyDbResponse& gpudb::GPUdb::adminVerifyDb | ( | const AdminVerifyDbRequest & | request_, |
| AdminVerifyDbResponse & | response_ | ||
| ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AdminVerifyDbResponse gpudb::GPUdb::adminVerifyDb | ( | const std::map< std::string, std::string > & | options | ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
| [in] | options | Optional parameters.
|
| AdminVerifyDbResponse& gpudb::GPUdb::adminVerifyDb | ( | const std::map< std::string, std::string > & | options, |
| AdminVerifyDbResponse & | response_ | ||
| ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AggregateConvexHullResponse gpudb::GPUdb::aggregateConvexHull | ( | const AggregateConvexHullRequest & | request_ | ) | const |
| AggregateConvexHullResponse& gpudb::GPUdb::aggregateConvexHull | ( | const AggregateConvexHullRequest & | request_, |
| AggregateConvexHullResponse & | response_ | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateConvexHullResponse gpudb::GPUdb::aggregateConvexHull | ( | const std::string & | tableName, |
| const std::string & | xColumnName, | ||
| const std::string & | yColumnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
| [in] | tableName | Name of table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | xColumnName | Name of the column containing the x coordinates of the points for the operation being performed. |
| [in] | yColumnName | Name of the column containing the y coordinates of the points for the operation being performed. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AggregateConvexHullResponse& gpudb::GPUdb::aggregateConvexHull | ( | const std::string & | tableName, |
| const std::string & | xColumnName, | ||
| const std::string & | yColumnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateConvexHullResponse & | response_ | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
| [in] | tableName | Name of table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | xColumnName | Name of the column containing the x coordinates of the points for the operation being performed. |
| [in] | yColumnName | Name of the column containing the y coordinates of the points for the operation being performed. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateGroupByResponse gpudb::GPUdb::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& gpudb::GPUdb::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 gpudb::GPUdb::aggregateGroupBy | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table 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] | tableName | Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnNames | List of one or more column names, expressions, and aggregate expressions. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options | Optional parameters.
|
| AggregateGroupByResponse& gpudb::GPUdb::aggregateGroupBy | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateGroupByResponse & | response_ | ||
| ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table 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] | tableName | Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnNames | List of one or more column names, expressions, and aggregate expressions. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RawAggregateGroupByResponse gpudb::GPUdb::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& gpudb::GPUdb::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 gpudb::GPUdb::aggregateHistogram | ( | const AggregateHistogramRequest & | request_ | ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
| [in] | request_ | Request object containing the parameters for the operation. |
| AggregateHistogramResponse& gpudb::GPUdb::aggregateHistogram | ( | const AggregateHistogramRequest & | request_, |
| AggregateHistogramResponse & | response_ | ||
| ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateHistogramResponse gpudb::GPUdb::aggregateHistogram | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const double | start, | ||
| const double | end, | ||
| const double | interval, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a column or an expression of one or more column names over which the histogram will be calculated. |
| [in] | start | Lower end value of the histogram interval, inclusive. |
| [in] | end | Upper end value of the histogram interval, inclusive. |
| [in] | interval | The size of each bin within the start and end parameters. |
| [in] | options | Optional parameters.
|
| AggregateHistogramResponse& gpudb::GPUdb::aggregateHistogram | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const double | start, | ||
| const double | end, | ||
| const double | interval, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateHistogramResponse & | response_ | ||
| ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a column or an expression of one or more column names over which the histogram will be calculated. |
| [in] | start | Lower end value of the histogram interval, inclusive. |
| [in] | end | Upper end value of the histogram interval, inclusive. |
| [in] | interval | The size of each bin within the start and end parameters. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AggregateKMeansResponse gpudb::GPUdb::aggregateKMeans | ( | const AggregateKMeansRequest & | request_ | ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| [in] | request_ | Request object containing the parameters for the operation. |
| AggregateKMeansResponse& gpudb::GPUdb::aggregateKMeans | ( | const AggregateKMeansRequest & | request_, |
| AggregateKMeansResponse & | response_ | ||
| ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateKMeansResponse gpudb::GPUdb::aggregateKMeans | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int32_t | k, | ||
| const double | tolerance, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | 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. |
| [in] | k | The number of mean points to be determined by the algorithm. |
| [in] | tolerance | Stop iterating when the distances between successive points is less than the given tolerance. |
| [in] | options | Optional parameters.
|
| AggregateKMeansResponse& gpudb::GPUdb::aggregateKMeans | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int32_t | k, | ||
| const double | tolerance, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateKMeansResponse & | response_ | ||
| ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | 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. |
| [in] | k | The number of mean points to be determined by the algorithm. |
| [in] | tolerance | Stop iterating when the distances between successive points is less than the given tolerance. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AggregateMinMaxResponse gpudb::GPUdb::aggregateMinMax | ( | const AggregateMinMaxRequest & | request_ | ) | const |
| AggregateMinMaxResponse& gpudb::GPUdb::aggregateMinMax | ( | const AggregateMinMaxRequest & | request_, |
| AggregateMinMaxResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateMinMaxResponse gpudb::GPUdb::aggregateMinMax | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a column or an expression of one or more column on which the min-max will be calculated. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AggregateMinMaxResponse& gpudb::GPUdb::aggregateMinMax | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateMinMaxResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a column or an expression of one or more column on which the min-max will be calculated. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateMinMaxGeometryResponse gpudb::GPUdb::aggregateMinMaxGeometry | ( | const AggregateMinMaxGeometryRequest & | request_ | ) | const |
| AggregateMinMaxGeometryResponse& gpudb::GPUdb::aggregateMinMaxGeometry | ( | const AggregateMinMaxGeometryRequest & | request_, |
| AggregateMinMaxGeometryResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateMinMaxGeometryResponse gpudb::GPUdb::aggregateMinMaxGeometry | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a geospatial geometry column on which the min-max will be calculated. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AggregateMinMaxGeometryResponse& gpudb::GPUdb::aggregateMinMaxGeometry | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateMinMaxGeometryResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a geospatial geometry column on which the min-max will be calculated. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateStatisticsResponse gpudb::GPUdb::aggregateStatistics | ( | const AggregateStatisticsRequest & | request_ | ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column to be specified in weight_column_name. 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 additional_column_names. 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& gpudb::GPUdb::aggregateStatistics | ( | const AggregateStatisticsRequest & | request_, |
| AggregateStatisticsResponse & | response_ | ||
| ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column to be specified in weight_column_name. 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 additional_column_names. 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 gpudb::GPUdb::aggregateStatistics | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::string & | stats, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column to be specified in weight_column_name. 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 additional_column_names. 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] | tableName | Name of the table on which the statistics operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of the primary column for which the statistics are to be calculated. |
| [in] | stats | Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
|
| [in] | options | Optional parameters.
|
| AggregateStatisticsResponse& gpudb::GPUdb::aggregateStatistics | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::string & | stats, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateStatisticsResponse & | response_ | ||
| ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column to be specified in weight_column_name. 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 additional_column_names. 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] | tableName | Name of the table on which the statistics operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of the primary column for which the statistics are to be calculated. |
| [in] | stats | Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AggregateStatisticsByRangeResponse gpudb::GPUdb::aggregateStatisticsByRange | ( | const AggregateStatisticsByRangeRequest & | request_ | ) | const |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in weight_column_name. 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, 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& gpudb::GPUdb::aggregateStatisticsByRange | ( | const AggregateStatisticsByRangeRequest & | request_, |
| AggregateStatisticsByRangeResponse & | response_ | ||
| ) | const |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in weight_column_name. 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, 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 gpudb::GPUdb::aggregateStatisticsByRange | ( | const std::string & | tableName, |
| const std::string & | selectExpression, | ||
| const std::string & | columnName, | ||
| const std::string & | valueColumnName, | ||
| const std::string & | stats, | ||
| const double | start, | ||
| const double | end, | ||
| const double | interval, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in weight_column_name. 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, 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] | tableName | Name of the table on which the ranged-statistics operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | selectExpression | For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''. |
| [in] | columnName | Name of the binning-column used to divide the set samples into bins. |
| [in] | valueColumnName | Name of the value-column for which statistics are to be computed. |
| [in] | 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. |
| [in] | start | The lower bound of the binning-column. |
| [in] | end | The upper bound of the binning-column. |
| [in] | 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)). |
| [in] | options | Map of optional parameters:
|
| AggregateStatisticsByRangeResponse& gpudb::GPUdb::aggregateStatisticsByRange | ( | const std::string & | tableName, |
| const std::string & | selectExpression, | ||
| const std::string & | columnName, | ||
| const std::string & | valueColumnName, | ||
| const std::string & | stats, | ||
| const double | start, | ||
| const double | end, | ||
| const double | interval, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateStatisticsByRangeResponse & | response_ | ||
| ) | const |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in weight_column_name. 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, 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] | tableName | Name of the table on which the ranged-statistics operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | selectExpression | For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''. |
| [in] | columnName | Name of the binning-column used to divide the set samples into bins. |
| [in] | valueColumnName | Name of the value-column for which statistics are to be computed. |
| [in] | 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. |
| [in] | start | The lower bound of the binning-column. |
| [in] | end | The upper bound of the binning-column. |
| [in] | 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)). |
| [in] | options | Map of optional parameters:
|
| [out] | response_ | Response object containing the results of the operation. |
| AggregateUniqueResponse gpudb::GPUdb::aggregateUnique | ( | const AggregateUniqueRequest & | request_ | ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or 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 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:
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& gpudb::GPUdb::aggregateUnique | ( | const AggregateUniqueRequest & | request_, |
| AggregateUniqueResponse & | response_ | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or 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 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:
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 gpudb::GPUdb::aggregateUnique | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or 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 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:
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] | tableName | Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of the column or an expression containing one or more column names on which the unique function would be applied. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options | Optional parameters.
|
| AggregateUniqueResponse& gpudb::GPUdb::aggregateUnique | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateUniqueResponse & | response_ | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or 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 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:
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] | tableName | Name of an existing table or view on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of the column or an expression containing one or more column names on which the unique function would be applied. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RawAggregateUniqueResponse gpudb::GPUdb::aggregateUniqueRaw | ( | const AggregateUniqueRequest & | request_ | ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or 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 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:
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& gpudb::GPUdb::aggregateUniqueRaw | ( | const AggregateUniqueRequest & | request_, |
| RawAggregateUniqueResponse & | response_ | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or 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 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:
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 gpudb::GPUdb::aggregateUnpivot | ( | const AggregateUnpivotRequest & | request_ | ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| [in] | request_ | Request object containing the parameters for the operation. |
| AggregateUnpivotResponse& gpudb::GPUdb::aggregateUnpivot | ( | const AggregateUnpivotRequest & | request_, |
| AggregateUnpivotResponse & | response_ | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AggregateUnpivotResponse gpudb::GPUdb::aggregateUnpivot | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const std::string & | variableColumnName, | ||
| const std::string & | valueColumnName, | ||
| const std::vector< std::string > & | pivotedColumns, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnNames | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
| [in] | variableColumnName | Specifies the variable/parameter column name. The default value is ''. |
| [in] | valueColumnName | Specifies the value column name. The default value is ''. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| AggregateUnpivotResponse& gpudb::GPUdb::aggregateUnpivot | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const std::string & | variableColumnName, | ||
| const std::string & | valueColumnName, | ||
| const std::vector< std::string > & | pivotedColumns, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateUnpivotResponse & | response_ | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| [in] | tableName | Name of the table on which the operation will be performed. Must be an existing table/view, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnNames | List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table. |
| [in] | variableColumnName | Specifies the variable/parameter column name. The default value is ''. |
| [in] | valueColumnName | Specifies the value column name. The default value is ''. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RawAggregateUnpivotResponse gpudb::GPUdb::aggregateUnpivotRaw | ( | const AggregateUnpivotRequest & | request_ | ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| [in] | request_ | Request object containing the parameters for the operation. |
| RawAggregateUnpivotResponse& gpudb::GPUdb::aggregateUnpivotRaw | ( | const AggregateUnpivotRequest & | request_, |
| RawAggregateUnpivotResponse & | response_ | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterCredentialResponse gpudb::GPUdb::alterCredential | ( | const AlterCredentialRequest & | request_ | ) | const |
Alter the properties of an existing credential.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterCredentialResponse& gpudb::GPUdb::alterCredential | ( | const AlterCredentialRequest & | request_, |
| AlterCredentialResponse & | response_ | ||
| ) | const |
Alter the properties of an existing credential.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterCredentialResponse gpudb::GPUdb::alterCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | credentialUpdatesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alter the properties of an existing credential.
| [in] | credentialName | Name of the credential to be altered. Must be an existing credential. |
| [in] | credentialUpdatesMap | Map containing the properties of the credential to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| AlterCredentialResponse& gpudb::GPUdb::alterCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | credentialUpdatesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterCredentialResponse & | response_ | ||
| ) | const |
Alter the properties of an existing credential.
| [in] | credentialName | Name of the credential to be altered. Must be an existing credential. |
| [in] | credentialUpdatesMap | Map containing the properties of the credential to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterDatasinkResponse gpudb::GPUdb::alterDatasink | ( | const AlterDatasinkRequest & | request_ | ) | const |
| AlterDatasinkResponse& gpudb::GPUdb::alterDatasink | ( | const AlterDatasinkRequest & | request_, |
| AlterDatasinkResponse & | response_ | ||
| ) | const |
| AlterDatasinkResponse gpudb::GPUdb::alterDatasink | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | datasinkUpdatesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters the properties of an existing data sink
| [in] | name | Name of the data sink to be altered. Must be an existing data sink. |
| [in] | datasinkUpdatesMap | Map containing the properties of the data sink to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| AlterDatasinkResponse& gpudb::GPUdb::alterDatasink | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | datasinkUpdatesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterDatasinkResponse & | response_ | ||
| ) | const |
Alters the properties of an existing data sink
| [in] | name | Name of the data sink to be altered. Must be an existing data sink. |
| [in] | datasinkUpdatesMap | Map containing the properties of the data sink to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterDatasourceResponse gpudb::GPUdb::alterDatasource | ( | const AlterDatasourceRequest & | request_ | ) | const |
Alters the properties of an existing data source
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterDatasourceResponse& gpudb::GPUdb::alterDatasource | ( | const AlterDatasourceRequest & | request_, |
| AlterDatasourceResponse & | response_ | ||
| ) | const |
Alters the properties of an existing data source
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterDatasourceResponse gpudb::GPUdb::alterDatasource | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | datasourceUpdatesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters the properties of an existing data source
| [in] | name | Name of the data source to be altered. Must be an existing data source. |
| [in] | datasourceUpdatesMap | Map containing the properties of the data source to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| AlterDatasourceResponse& gpudb::GPUdb::alterDatasource | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | datasourceUpdatesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterDatasourceResponse & | response_ | ||
| ) | const |
Alters the properties of an existing data source
| [in] | name | Name of the data source to be altered. Must be an existing data source. |
| [in] | datasourceUpdatesMap | Map containing the properties of the data source to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterDirectoryResponse gpudb::GPUdb::alterDirectory | ( | const AlterDirectoryRequest & | request_ | ) | const |
| AlterDirectoryResponse& gpudb::GPUdb::alterDirectory | ( | const AlterDirectoryRequest & | request_, |
| AlterDirectoryResponse & | response_ | ||
| ) | const |
| AlterDirectoryResponse gpudb::GPUdb::alterDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | directoryUpdatesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters an existing directory in KiFS.
| [in] | directoryName | Name of the directory in KiFS to be altered. |
| [in] | directoryUpdatesMap | Map containing the properties of the directory to be altered. Error if empty.
|
| [in] | options | Optional parameters. The default value is an empty map. |
| AlterDirectoryResponse& gpudb::GPUdb::alterDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | directoryUpdatesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterDirectoryResponse & | response_ | ||
| ) | const |
Alters an existing directory in KiFS.
| [in] | directoryName | Name of the directory in KiFS to be altered. |
| [in] | directoryUpdatesMap | Map containing the properties of the directory to be altered. Error if empty.
|
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterEnvironmentResponse gpudb::GPUdb::alterEnvironment | ( | const AlterEnvironmentRequest & | request_ | ) | const |
Alters an existing environment which can be referenced by a user-defined function (UDF).
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterEnvironmentResponse& gpudb::GPUdb::alterEnvironment | ( | const AlterEnvironmentRequest & | request_, |
| AlterEnvironmentResponse & | response_ | ||
| ) | const |
Alters an existing environment which can be referenced by a user-defined function (UDF).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterEnvironmentResponse gpudb::GPUdb::alterEnvironment | ( | const std::string & | environmentName, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters an existing environment which can be referenced by a user-defined function (UDF).
| [in] | environmentName | Name of the environment to be altered. |
| [in] | action | Modification operation to be applied. Supported values:
|
| [in] | value | The value of the modification, depending on action. For example, if action is install_package, this would be the python package name. If action is install_requirements, this would be the path of a requirements file from which to install packages. If an external data source is specified in datasource_name, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS. |
| [in] | options | Optional parameters.
|
| AlterEnvironmentResponse& gpudb::GPUdb::alterEnvironment | ( | const std::string & | environmentName, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterEnvironmentResponse & | response_ | ||
| ) | const |
Alters an existing environment which can be referenced by a user-defined function (UDF).
| [in] | environmentName | Name of the environment to be altered. |
| [in] | action | Modification operation to be applied. Supported values:
|
| [in] | value | The value of the modification, depending on action. For example, if action is install_package, this would be the python package name. If action is install_requirements, this would be the path of a requirements file from which to install packages. If an external data source is specified in datasource_name, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in KiFS. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AlterResourceGroupResponse gpudb::GPUdb::alterResourceGroup | ( | const AlterResourceGroupRequest & | request_ | ) | const |
| AlterResourceGroupResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | name | Name of the group to be altered. Must be an existing resource group name or an empty string when used inconjunction with the is_default_group option. |
| [in] | 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'}}.
|
| [in] | 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. Supported values:
|
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| AlterResourceGroupResponse& gpudb::GPUdb::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.
| [in] | name | Name of the group to be altered. Must be an existing resource group name or an empty string when used inconjunction with the is_default_group option. |
| [in] | 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'}}.
|
| [in] | 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. Supported values:
|
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AlterRoleResponse gpudb::GPUdb::alterRole | ( | const AlterRoleRequest & | request_ | ) | const |
| AlterRoleResponse& gpudb::GPUdb::alterRole | ( | const AlterRoleRequest & | request_, |
| AlterRoleResponse & | response_ | ||
| ) | const |
| AlterRoleResponse gpudb::GPUdb::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.
| [in] | name | Name of the role to be altered. Must be an existing role. |
| [in] | action | Modification operation to be applied to the role. Supported values:
|
| [in] | value | The value of the modification, depending on action. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AlterRoleResponse& gpudb::GPUdb::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.
| [in] | name | Name of the role to be altered. Must be an existing role. |
| [in] | action | Modification operation to be applied to the role. Supported values:
|
| [in] | value | The value of the modification, depending on action. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterSchemaResponse gpudb::GPUdb::alterSchema | ( | const AlterSchemaRequest & | request_ | ) | const |
Used to change the name of a SQL-style schema, specified in schemaName.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterSchemaResponse& gpudb::GPUdb::alterSchema | ( | const AlterSchemaRequest & | request_, |
| AlterSchemaResponse & | response_ | ||
| ) | const |
Used to change the name of a SQL-style schema, specified in schemaName.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterSchemaResponse gpudb::GPUdb::alterSchema | ( | const std::string & | schemaName, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Used to change the name of a SQL-style schema, specified in schemaName.
| [in] | schemaName | Name of the schema to be altered. |
| [in] | action | Modification operation to be applied. Supported values:
|
| [in] | value | The value of the modification, depending on action. For now the only value of action is rename_schema. In this case the value is the new name of the schema. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AlterSchemaResponse& gpudb::GPUdb::alterSchema | ( | const std::string & | schemaName, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterSchemaResponse & | response_ | ||
| ) | const |
Used to change the name of a SQL-style schema, specified in schemaName.
| [in] | schemaName | Name of the schema to be altered. |
| [in] | action | Modification operation to be applied. Supported values:
|
| [in] | value | The value of the modification, depending on action. For now the only value of action is rename_schema. In this case the value is the new name of the schema. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterSystemPropertiesResponse gpudb::GPUdb::alterSystemProperties | ( | const AlterSystemPropertiesRequest & | request_ | ) | const |
The alterSystemProperties 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& gpudb::GPUdb::alterSystemProperties | ( | const AlterSystemPropertiesRequest & | request_, |
| AlterSystemPropertiesResponse & | response_ | ||
| ) | const |
The alterSystemProperties 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 gpudb::GPUdb::alterSystemProperties | ( | const std::map< std::string, std::string > & | propertyUpdatesMap, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
The alterSystemProperties 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] | propertyUpdatesMap | Map containing the properties of the system to be updated. Error if empty.
|
| [in] | options | Optional parameters.
|
| AlterSystemPropertiesResponse& gpudb::GPUdb::alterSystemProperties | ( | const std::map< std::string, std::string > & | propertyUpdatesMap, |
| const std::map< std::string, std::string > & | options, | ||
| AlterSystemPropertiesResponse & | response_ | ||
| ) | const |
The alterSystemProperties 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] | propertyUpdatesMap | Map containing the properties of the system to be updated. Error if empty.
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableResponse gpudb::GPUdb::alterTable | ( | const AlterTableRequest & | request_ | ) | const |
Apply various modifications to a table or view.
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 dictionary encoded or not.
External tables cannot be modified except for their refresh method.
Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. 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 or an external table.
Set the time-to-live (TTL). This can be applied to tables or views.
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.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterTableResponse& gpudb::GPUdb::alterTable | ( | const AlterTableRequest & | request_, |
| AlterTableResponse & | response_ | ||
| ) | const |
Apply various modifications to a table or view.
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 dictionary encoded or not.
External tables cannot be modified except for their refresh method.
Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. 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 or an external table.
Set the time-to-live (TTL). This can be applied to tables or views.
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.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableResponse gpudb::GPUdb::alterTable | ( | const std::string & | tableName, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Apply various modifications to a table or view.
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 dictionary encoded or not.
External tables cannot be modified except for their refresh method.
Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. 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 or an external table.
Set the time-to-live (TTL). This can be applied to tables or views.
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.
| [in] | tableName | Table on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view. |
| [in] | action | Modification operation to be applied. Supported values:
|
| [in] | 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. |
| [in] | options | Optional parameters.
|
| AlterTableResponse& gpudb::GPUdb::alterTable | ( | const std::string & | tableName, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterTableResponse & | response_ | ||
| ) | const |
Apply various modifications to a table or view.
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 dictionary encoded or not.
External tables cannot be modified except for their refresh method.
Create or delete a column, low-cardinality index, chunk skip, geospatial, CAGRA, or HNSW index. 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 or an external table.
Set the time-to-live (TTL). This can be applied to tables or views.
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.
| [in] | tableName | Table on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view. |
| [in] | action | Modification operation to be applied. Supported values:
|
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableColumnsResponse gpudb::GPUdb::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, including whether it is dictionary encoded or not.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterTableColumnsResponse& gpudb::GPUdb::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, including whether it is dictionary encoded or not.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableColumnsResponse gpudb::GPUdb::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, including whether it is dictionary encoded or not.
| [in] | tableName | Table on which the operation will be performed. Must be an existing table or view, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | 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'}] |
| [in] | options | Optional parameters. |
| AlterTableColumnsResponse& gpudb::GPUdb::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, including whether it is dictionary encoded or not.
| [in] | tableName | Table on which the operation will be performed. Must be an existing table or view, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | 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'}] |
| [in] | options | Optional parameters. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableMetadataResponse gpudb::GPUdb::alterTableMetadata | ( | const AlterTableMetadataRequest & | request_ | ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterTableMetadataResponse& gpudb::GPUdb::alterTableMetadata | ( | const AlterTableMetadataRequest & | request_, |
| AlterTableMetadataResponse & | response_ | ||
| ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableMetadataResponse gpudb::GPUdb::alterTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | metadataMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
| [in] | tableNames | Names of the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned. |
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AlterTableMetadataResponse& gpudb::GPUdb::alterTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | metadataMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterTableMetadataResponse & | response_ | ||
| ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
| [in] | tableNames | Names of the tables whose metadata will be updated, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned. |
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableMonitorResponse gpudb::GPUdb::alterTableMonitor | ( | const AlterTableMonitorRequest & | request_ | ) | const |
Alters a table monitor previously created with createTableMonitor.
| [in] | request_ | Request object containing the parameters for the operation. |
| AlterTableMonitorResponse& gpudb::GPUdb::alterTableMonitor | ( | const AlterTableMonitorRequest & | request_, |
| AlterTableMonitorResponse & | response_ | ||
| ) | const |
Alters a table monitor previously created with createTableMonitor.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTableMonitorResponse gpudb::GPUdb::alterTableMonitor | ( | const std::string & | topicId, |
| const std::map< std::string, std::string > & | monitorUpdatesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters a table monitor previously created with createTableMonitor.
| [in] | topicId | The topic ID returned by createTableMonitor. |
| [in] | monitorUpdatesMap | Map containing the properties of the table monitor to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| AlterTableMonitorResponse& gpudb::GPUdb::alterTableMonitor | ( | const std::string & | topicId, |
| const std::map< std::string, std::string > & | monitorUpdatesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterTableMonitorResponse & | response_ | ||
| ) | const |
Alters a table monitor previously created with createTableMonitor.
| [in] | topicId | The topic ID returned by createTableMonitor. |
| [in] | monitorUpdatesMap | Map containing the properties of the table monitor to be updated. Error if empty.
|
| [in] | options | Optional parameters. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterTierResponse gpudb::GPUdb::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& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | name | Name of the tier to be altered. Must be an existing tier group name. |
| [in] | options | Optional parameters.
|
| AlterTierResponse& gpudb::GPUdb::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.
| [in] | name | Name of the tier to be altered. Must be an existing tier group name. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AlterUserResponse gpudb::GPUdb::alterUser | ( | const AlterUserRequest & | request_ | ) | const |
| AlterUserResponse& gpudb::GPUdb::alterUser | ( | const AlterUserRequest & | request_, |
| AlterUserResponse & | response_ | ||
| ) | const |
| AlterUserResponse gpudb::GPUdb::alterUser | ( | const std::string & | name, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters a user.
| [in] | name | Name of the user to be altered. Must be an existing user. |
| [in] | action | Modification operation to be applied to the user. Supported values:
|
| [in] | value | The value of the modification, depending on action. |
| [in] | options | Optional parameters. The default value is an empty map. |
| AlterUserResponse& gpudb::GPUdb::alterUser | ( | const std::string & | name, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterUserResponse & | response_ | ||
| ) | const |
Alters a user.
| [in] | name | Name of the user to be altered. Must be an existing user. |
| [in] | action | Modification operation to be applied to the user. Supported values:
|
| [in] | value | The value of the modification, depending on action. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterVideoResponse gpudb::GPUdb::alterVideo | ( | const AlterVideoRequest & | request_ | ) | const |
| AlterVideoResponse& gpudb::GPUdb::alterVideo | ( | const AlterVideoRequest & | request_, |
| AlterVideoResponse & | response_ | ||
| ) | const |
| AlterVideoResponse gpudb::GPUdb::alterVideo | ( | const std::string & | path, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters a video.
| [in] | path | Fully-qualified KiFS path to the video to be altered. |
| [in] | options | Optional parameters.
|
| AlterVideoResponse& gpudb::GPUdb::alterVideo | ( | const std::string & | path, |
| const std::map< std::string, std::string > & | options, | ||
| AlterVideoResponse & | response_ | ||
| ) | const |
Alters a video.
| [in] | path | Fully-qualified KiFS path to the video to be altered. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AlterWalResponse gpudb::GPUdb::alterWal | ( | const AlterWalRequest & | request_ | ) | const |
| AlterWalResponse& gpudb::GPUdb::alterWal | ( | const AlterWalRequest & | request_, |
| AlterWalResponse & | response_ | ||
| ) | const |
Alters table wal settings.
Returns information about the requested table wal modifications.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AlterWalResponse gpudb::GPUdb::alterWal | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters table wal settings.
Returns information about the requested table wal modifications.
| [in] | tableNames | List of tables to modify. An asterisk changes the system settings. |
| [in] | options | Optional parameters.
|
| AlterWalResponse& gpudb::GPUdb::alterWal | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options, | ||
| AlterWalResponse & | response_ | ||
| ) | const |
Alters table wal settings.
Returns information about the requested table wal modifications.
| [in] | tableNames | List of tables to modify. An asterisk changes the system settings. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| AppendRecordsResponse gpudb::GPUdb::appendRecords | ( | const AppendRecordsRequest & | request_ | ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
| [in] | request_ | Request object containing the parameters for the operation. |
| AppendRecordsResponse& gpudb::GPUdb::appendRecords | ( | const AppendRecordsRequest & | request_, |
| AppendRecordsResponse & | response_ | ||
| ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| AppendRecordsResponse gpudb::GPUdb::appendRecords | ( | const std::string & | tableName, |
| const std::string & | sourceTableName, | ||
| const std::map< std::string, std::string > & | fieldMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
| [in] | tableName | The table name for the records to be appended, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | sourceTableName | The source table name to get records from, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table name. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| AppendRecordsResponse& gpudb::GPUdb::appendRecords | ( | const std::string & | tableName, |
| const std::string & | sourceTableName, | ||
| const std::map< std::string, std::string > & | fieldMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AppendRecordsResponse & | response_ | ||
| ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
| [in] | tableName | The table name for the records to be appended, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | sourceTableName | The source table name to get records from, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table name. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ClearStatisticsResponse gpudb::GPUdb::clearStatistics | ( | const ClearStatisticsRequest & | request_ | ) | const |
| ClearStatisticsResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | tableName | Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. The default value is ''. |
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ClearStatisticsResponse& gpudb::GPUdb::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.
| [in] | tableName | Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. The default value is ''. |
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ClearTableResponse gpudb::GPUdb::clearTable | ( | const ClearTableRequest & | request_ | ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
| [in] | request_ | Request object containing the parameters for the operation. |
| ClearTableResponse& gpudb::GPUdb::clearTable | ( | const ClearTableRequest & | request_, |
| ClearTableResponse & | response_ | ||
| ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ClearTableResponse gpudb::GPUdb::clearTable | ( | const std::string & | tableName, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
| [in] | tableName | Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. 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'. The default value is ''. |
| [in] | authorization | No longer used. User can pass an empty string. The default value is ''. |
| [in] | options | Optional parameters.
|
| ClearTableResponse& gpudb::GPUdb::clearTable | ( | const std::string & | tableName, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options, | ||
| ClearTableResponse & | response_ | ||
| ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
| [in] | tableName | Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. 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'. The default value is ''. |
| [in] | authorization | No longer used. User can pass an empty string. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ClearTableMonitorResponse gpudb::GPUdb::clearTableMonitor | ( | const ClearTableMonitorRequest & | request_ | ) | const |
Deactivates a table monitor previously created with createTableMonitor.
| [in] | request_ | Request object containing the parameters for the operation. |
| ClearTableMonitorResponse& gpudb::GPUdb::clearTableMonitor | ( | const ClearTableMonitorRequest & | request_, |
| ClearTableMonitorResponse & | response_ | ||
| ) | const |
Deactivates a table monitor previously created with createTableMonitor.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ClearTableMonitorResponse gpudb::GPUdb::clearTableMonitor | ( | const std::string & | topicId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deactivates a table monitor previously created with createTableMonitor.
| [in] | topicId | The topic ID returned by createTableMonitor. |
| [in] | options | Optional parameters.
|
| ClearTableMonitorResponse& gpudb::GPUdb::clearTableMonitor | ( | const std::string & | topicId, |
| const std::map< std::string, std::string > & | options, | ||
| ClearTableMonitorResponse & | response_ | ||
| ) | const |
Deactivates a table monitor previously created with createTableMonitor.
| [in] | topicId | The topic ID returned by createTableMonitor. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ClearTriggerResponse gpudb::GPUdb::clearTrigger | ( | const ClearTriggerRequest & | request_ | ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
| [in] | request_ | Request object containing the parameters for the operation. |
| ClearTriggerResponse& gpudb::GPUdb::clearTrigger | ( | const ClearTriggerRequest & | request_, |
| ClearTriggerResponse & | response_ | ||
| ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ClearTriggerResponse gpudb::GPUdb::clearTrigger | ( | const std::string & | triggerId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
| [in] | triggerId | ID for the trigger to be deactivated. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ClearTriggerResponse& gpudb::GPUdb::clearTrigger | ( | const std::string & | triggerId, |
| const std::map< std::string, std::string > & | options, | ||
| ClearTriggerResponse & | response_ | ||
| ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
| [in] | triggerId | ID for the trigger to be deactivated. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CollectStatisticsResponse gpudb::GPUdb::collectStatistics | ( | const CollectStatisticsRequest & | request_ | ) | const |
| CollectStatisticsResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | tableName | Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | columnNames | List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). |
| [in] | options | Optional parameters. The default value is an empty map. |
| CollectStatisticsResponse& gpudb::GPUdb::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.
| [in] | tableName | Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | columnNames | List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateCredentialResponse gpudb::GPUdb::createCredential | ( | const CreateCredentialRequest & | request_ | ) | const |
Create a new credential.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateCredentialResponse& gpudb::GPUdb::createCredential | ( | const CreateCredentialRequest & | request_, |
| CreateCredentialResponse & | response_ | ||
| ) | const |
Create a new credential.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateCredentialResponse gpudb::GPUdb::createCredential | ( | const std::string & | credentialName, |
| const std::string & | type, | ||
| const std::string & | identity, | ||
| const std::string & | secret, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Create a new credential.
| [in] | credentialName | Name of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name. |
| [in] | type | Type of the credential to be created. Supported values:
|
| [in] | identity | User of the credential to be created. |
| [in] | secret | Password of the credential to be created. |
| [in] | options | Optional parameters. The default value is an empty map. |
| CreateCredentialResponse& gpudb::GPUdb::createCredential | ( | const std::string & | credentialName, |
| const std::string & | type, | ||
| const std::string & | identity, | ||
| const std::string & | secret, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateCredentialResponse & | response_ | ||
| ) | const |
Create a new credential.
| [in] | credentialName | Name of the credential to be created. Must contain only letters, digits, and underscores, and cannot begin with a digit. Must not match an existing credential name. |
| [in] | type | Type of the credential to be created. Supported values:
|
| [in] | identity | User of the credential to be created. |
| [in] | secret | Password of the credential to be created. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateDatasinkResponse gpudb::GPUdb::createDatasink | ( | const CreateDatasinkRequest & | request_ | ) | const |
| CreateDatasinkResponse& gpudb::GPUdb::createDatasink | ( | const CreateDatasinkRequest & | request_, |
| CreateDatasinkResponse & | response_ | ||
| ) | const |
Creates a data sink, which contains the destination information for a data sink that is external to the database.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateDatasinkResponse gpudb::GPUdb::createDatasink | ( | const std::string & | name, |
| const std::string & | destination, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a data sink, which contains the destination information for a data sink that is external to the database.
| [in] | name | Name of the data sink to be created. |
| [in] | destination | Destination for the output data in format 'storage_provider_type://path[:port]'. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'. |
| [in] | options | Optional parameters.
|
| CreateDatasinkResponse& gpudb::GPUdb::createDatasink | ( | const std::string & | name, |
| const std::string & | destination, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateDatasinkResponse & | response_ | ||
| ) | const |
Creates a data sink, which contains the destination information for a data sink that is external to the database.
| [in] | name | Name of the data sink to be created. |
| [in] | destination | Destination for the output data in format 'storage_provider_type://path[:port]'. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateDatasourceResponse gpudb::GPUdb::createDatasource | ( | const CreateDatasourceRequest & | request_ | ) | const |
Creates a data source, which contains the location and connection information for a data store that is external to the database.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateDatasourceResponse& gpudb::GPUdb::createDatasource | ( | const CreateDatasourceRequest & | request_, |
| CreateDatasourceResponse & | response_ | ||
| ) | const |
Creates a data source, which contains the location and connection information for a data store that is external to the database.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateDatasourceResponse gpudb::GPUdb::createDatasource | ( | const std::string & | name, |
| const std::string & | location, | ||
| const std::string & | userName, | ||
| const std::string & | password, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a data source, which contains the location and connection information for a data store that is external to the database.
| [in] | name | Name of the data source to be created. |
| [in] | location | Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'. |
| [in] | userName | Name of the remote system user; may be an empty string |
| [in] | password | Password for the remote system user; may be an empty string |
| [in] | options | Optional parameters.
|
| CreateDatasourceResponse& gpudb::GPUdb::createDatasource | ( | const std::string & | name, |
| const std::string & | location, | ||
| const std::string & | userName, | ||
| const std::string & | password, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateDatasourceResponse & | response_ | ||
| ) | const |
Creates a data source, which contains the location and connection information for a data store that is external to the database.
| [in] | name | Name of the data source to be created. |
| [in] | location | Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'. |
| [in] | userName | Name of the remote system user; may be an empty string |
| [in] | password | Password for the remote system user; may be an empty string |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateDirectoryResponse gpudb::GPUdb::createDirectory | ( | const CreateDirectoryRequest & | request_ | ) | const |
Creates a new directory in KiFS.
The new directory serves as a location in which the user can upload files using uploadFiles.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateDirectoryResponse& gpudb::GPUdb::createDirectory | ( | const CreateDirectoryRequest & | request_, |
| CreateDirectoryResponse & | response_ | ||
| ) | const |
Creates a new directory in KiFS.
The new directory serves as a location in which the user can upload files using uploadFiles.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateDirectoryResponse gpudb::GPUdb::createDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new directory in KiFS.
The new directory serves as a location in which the user can upload files using uploadFiles.
| [in] | directoryName | Name of the directory in KiFS to be created. |
| [in] | options | Optional parameters.
|
| CreateDirectoryResponse& gpudb::GPUdb::createDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateDirectoryResponse & | response_ | ||
| ) | const |
Creates a new directory in KiFS.
The new directory serves as a location in which the user can upload files using uploadFiles.
| [in] | directoryName | Name of the directory in KiFS to be created. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateEnvironmentResponse gpudb::GPUdb::createEnvironment | ( | const CreateEnvironmentRequest & | request_ | ) | const |
Creates a new environment which can be used by user-defined functions (UDF).
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateEnvironmentResponse& gpudb::GPUdb::createEnvironment | ( | const CreateEnvironmentRequest & | request_, |
| CreateEnvironmentResponse & | response_ | ||
| ) | const |
Creates a new environment which can be used by user-defined functions (UDF).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateEnvironmentResponse gpudb::GPUdb::createEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new environment which can be used by user-defined functions (UDF).
| [in] | environmentName | Name of the environment to be created. |
| [in] | options | Optional parameters. The default value is an empty map. |
| CreateEnvironmentResponse& gpudb::GPUdb::createEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateEnvironmentResponse & | response_ | ||
| ) | const |
Creates a new environment which can be used by user-defined functions (UDF).
| [in] | environmentName | Name of the environment to be created. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateGraphResponse gpudb::GPUdb::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 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& gpudb::GPUdb::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 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 gpudb::GPUdb::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 Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to generate. |
| [in] | 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. Supported values:
|
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| CreateGraphResponse& gpudb::GPUdb::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 Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to generate. |
| [in] | 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. Supported values:
|
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateJobResponse gpudb::GPUdb::createJob | ( | const CreateJobRequest & | request_ | ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateJobResponse& gpudb::GPUdb::createJob | ( | const CreateJobRequest & | request_, |
| CreateJobResponse & | response_ | ||
| ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateJobResponse gpudb::GPUdb::createJob | ( | const std::string & | endpoint, |
| const std::string & | requestEncoding, | ||
| const std::vector< uint8_t > & | data, | ||
| const std::string & | dataStr, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
| [in] | endpoint | Indicates which endpoint to execute, e.g. '/alter/table'. |
| [in] | requestEncoding | The encoding of the request payload for the job. Supported values: The default value is create_job_binary. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| CreateJobResponse& gpudb::GPUdb::createJob | ( | const std::string & | endpoint, |
| const std::string & | requestEncoding, | ||
| const std::vector< uint8_t > & | data, | ||
| const std::string & | dataStr, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateJobResponse & | response_ | ||
| ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
| [in] | endpoint | Indicates which endpoint to execute, e.g. '/alter/table'. |
| [in] | requestEncoding | The encoding of the request payload for the job. Supported values: The default value is create_job_binary. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateJoinTableResponse gpudb::GPUdb::createJoinTable | ( | const CreateJoinTableRequest & | request_ | ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateJoinTableResponse& gpudb::GPUdb::createJoinTable | ( | const CreateJoinTableRequest & | request_, |
| CreateJoinTableResponse & | response_ | ||
| ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateJoinTableResponse gpudb::GPUdb::createJoinTable | ( | const std::string & | joinTableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
| [in] | joinTableName | Name of the join table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | tableNames | The list of table names composing the join, each in [schema_name.]table_name format, using standard name resolution rules. Corresponds to a SQL statement FROM clause. |
| [in] | 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. |
| [in] | expressions | An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| CreateJoinTableResponse& gpudb::GPUdb::createJoinTable | ( | const std::string & | joinTableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateJoinTableResponse & | response_ | ||
| ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
| [in] | joinTableName | Name of the join table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | tableNames | The list of table names composing the join, each in [schema_name.]table_name format, using standard name resolution rules. Corresponds to a SQL statement FROM clause. |
| [in] | 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. |
| [in] | expressions | An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateMaterializedViewResponse gpudb::GPUdb::createMaterializedView | ( | const CreateMaterializedViewRequest & | request_ | ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateMaterializedViewResponse& gpudb::GPUdb::createMaterializedView | ( | const CreateMaterializedViewRequest & | request_, |
| CreateMaterializedViewResponse & | response_ | ||
| ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateMaterializedViewResponse gpudb::GPUdb::createMaterializedView | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| [in] | tableName | Name of the table to be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | options | Optional parameters.
|
| CreateMaterializedViewResponse& gpudb::GPUdb::createMaterializedView | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateMaterializedViewResponse & | response_ | ||
| ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
| [in] | tableName | Name of the table to be created that is the top-level table of the materialized view, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateProcResponse gpudb::GPUdb::createProc | ( | const CreateProcRequest & | request_ | ) | const |
Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateProcResponse& gpudb::GPUdb::createProc | ( | const CreateProcRequest & | request_, |
| CreateProcResponse & | response_ | ||
| ) | const |
Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateProcResponse gpudb::GPUdb::createProc | ( | const std::string & | procName, |
| const std::string & | executionMode, | ||
| const std::map< std::string, std::vector< uint8_t > > & | files, | ||
| const std::string & | command, | ||
| const std::vector< std::string > & | args, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.
| [in] | procName | Name of the proc to be created. Must not be the name of a currently existing proc. |
| [in] | executionMode | The execution mode of the proc. Supported values:
|
| [in] | 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. Files may be loaded from existing files in KiFS. Those file names should be prefixed with the uri kifs:// and the values in the map should be empty. The default value is an empty map. |
| [in] | 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. The default value is ''. |
| [in] | args | An array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| CreateProcResponse& gpudb::GPUdb::createProc | ( | const std::string & | procName, |
| const std::string & | executionMode, | ||
| const std::map< std::string, std::vector< uint8_t > > & | files, | ||
| const std::string & | command, | ||
| const std::vector< std::string > & | args, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateProcResponse & | response_ | ||
| ) | const |
Creates an instance (proc) of the user-defined functions (UDF) specified by the given command, options, and files, and makes it available for execution.
| [in] | procName | Name of the proc to be created. Must not be the name of a currently existing proc. |
| [in] | executionMode | The execution mode of the proc. Supported values:
|
| [in] | 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. Files may be loaded from existing files in KiFS. Those file names should be prefixed with the uri kifs:// and the values in the map should be empty. The default value is an empty map. |
| [in] | 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. The default value is ''. |
| [in] | args | An array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateProjectionResponse gpudb::GPUdb::createProjection | ( | const CreateProjectionRequest & | request_ | ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumn.
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& gpudb::GPUdb::createProjection | ( | const CreateProjectionRequest & | request_, |
| CreateProjectionResponse & | response_ | ||
| ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumn.
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 gpudb::GPUdb::createProjection | ( | const std::string & | tableName, |
| const std::string & | projectionName, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumn.
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] | tableName | Name of the existing table on which the projection is to be applied, in [schema_name.]table_name format, using standard name resolution rules. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions. |
| [in] | projectionName | Name of the projection to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | 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'. |
| [in] | options | Optional parameters.
|
| CreateProjectionResponse& gpudb::GPUdb::createProjection | ( | const std::string & | tableName, |
| const std::string & | projectionName, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateProjectionResponse & | response_ | ||
| ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumn.
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] | tableName | Name of the existing table on which the projection is to be applied, in [schema_name.]table_name format, using standard name resolution rules. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions. |
| [in] | projectionName | Name of the projection to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | 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'. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateResourceGroupResponse gpudb::GPUdb::createResourceGroup | ( | const CreateResourceGroupRequest & | request_ | ) | const |
| CreateResourceGroupResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | 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. |
| [in] | 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'}}.
|
| [in] | 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. Supported values: |
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| CreateResourceGroupResponse& gpudb::GPUdb::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.
| [in] | 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. |
| [in] | 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'}}.
|
| [in] | 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. Supported values: |
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateRoleResponse gpudb::GPUdb::createRole | ( | const CreateRoleRequest & | request_ | ) | const |
| CreateRoleResponse& gpudb::GPUdb::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 gpudb::GPUdb::createRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new role.
| [in] | 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. |
| [in] | options | Optional parameters.
|
| CreateRoleResponse& gpudb::GPUdb::createRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| CreateRoleResponse & | response_ | ||
| ) | const |
Creates a new role.
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateSchemaResponse gpudb::GPUdb::createSchema | ( | const CreateSchemaRequest & | request_ | ) | const |
Creates a SQL-style schema.
Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateSchemaResponse& gpudb::GPUdb::createSchema | ( | const CreateSchemaRequest & | request_, |
| CreateSchemaResponse & | response_ | ||
| ) | const |
Creates a SQL-style schema.
Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateSchemaResponse gpudb::GPUdb::createSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a SQL-style schema.
Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.
| [in] | schemaName | Name of the schema to be created. Has the same naming restrictions as tables. |
| [in] | options | Optional parameters.
|
| CreateSchemaResponse& gpudb::GPUdb::createSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateSchemaResponse & | response_ | ||
| ) | const |
Creates a SQL-style schema.
Schemas are containers for tables and views. Multiple tables and views can be defined with the same name in different schemas.
| [in] | schemaName | Name of the schema to be created. Has the same naming restrictions as tables. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateTableResponse gpudb::GPUdb::createTable | ( | const CreateTableRequest & | request_ | ) | const |
Creates a new table.
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 createType).
A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateTableResponse& gpudb::GPUdb::createTable | ( | const CreateTableRequest & | request_, |
| CreateTableResponse & | response_ | ||
| ) | const |
Creates a new table.
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 createType).
A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateTableResponse gpudb::GPUdb::createTable | ( | const std::string & | tableName, |
| const std::string & | typeId, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new table.
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 createType).
A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.
| [in] | tableName | Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option. |
| [in] | typeId | ID of a currently registered type. All objects added to the newly created table will be of this type. |
| [in] | options | Optional parameters.
|
| CreateTableResponse& gpudb::GPUdb::createTable | ( | const std::string & | tableName, |
| const std::string & | typeId, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTableResponse & | response_ | ||
| ) | const |
Creates a new table.
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 createType).
A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.
| [in] | tableName | Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option. |
| [in] | typeId | ID of a currently registered type. All objects added to the newly created table will be of this type. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateTableExternalResponse gpudb::GPUdb::createTableExternal | ( | const CreateTableExternalRequest & | request_ | ) | const |
Creates a new external table, which is a local database object whose source data is located externally to the database.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
The external table can have its structure defined explicitly, via createTableOptions, which contains many of the options from createTable; or defined implicitly, inferred from the source data.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateTableExternalResponse& gpudb::GPUdb::createTableExternal | ( | const CreateTableExternalRequest & | request_, |
| CreateTableExternalResponse & | response_ | ||
| ) | const |
Creates a new external table, which is a local database object whose source data is located externally to the database.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
The external table can have its structure defined explicitly, via createTableOptions, which contains many of the options from createTable; or defined implicitly, inferred from the source data.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateTableExternalResponse gpudb::GPUdb::createTableExternal | ( | const std::string & | tableName, |
| const std::vector< std::string > & | filepaths, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new external table, which is a local database object whose source data is located externally to the database.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
The external table can have its structure defined explicitly, via createTableOptions, which contains many of the options from createTable; or defined implicitly, inferred from the source data.
| [in] | tableName | Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | filepaths | A list of file paths from which data will be sourced; For paths in KiFS, use the uri prefix of kifs:// followed by the path to a file or directory. File matching by prefix is supported, e.g. kifs://dir/file would match dir/file_1 and dir/file_2. When prefix matching is used, the path must start with a full, valid KiFS directory name. If an external data source is specified in datasource_name, these file paths must resolve to accessible files at that data source location. Prefix matching is supported. If the data source is hdfs, prefixes must be aligned with directories, i.e. partial file names will not match. If no data source is specified, the files are assumed to be local to the database and must all be accessible to the gpudb user, residing on the path (or relative to the path) specified by the external files directory in the Kinetica configuration file. Wildcards (*) can be used to specify a group of files. Prefix matching is supported, the prefixes must be aligned with directories. 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 (|). |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options from createTable, allowing the structure of the table to be defined independently of the data source.
|
| [in] | options | Optional parameters.
|
| CreateTableExternalResponse& gpudb::GPUdb::createTableExternal | ( | const std::string & | tableName, |
| const std::vector< std::string > & | filepaths, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTableExternalResponse & | response_ | ||
| ) | const |
Creates a new external table, which is a local database object whose source data is located externally to the database.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
The external table can have its structure defined explicitly, via createTableOptions, which contains many of the options from createTable; or defined implicitly, inferred from the source data.
| [in] | tableName | Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | filepaths | A list of file paths from which data will be sourced; For paths in KiFS, use the uri prefix of kifs:// followed by the path to a file or directory. File matching by prefix is supported, e.g. kifs://dir/file would match dir/file_1 and dir/file_2. When prefix matching is used, the path must start with a full, valid KiFS directory name. If an external data source is specified in datasource_name, these file paths must resolve to accessible files at that data source location. Prefix matching is supported. If the data source is hdfs, prefixes must be aligned with directories, i.e. partial file names will not match. If no data source is specified, the files are assumed to be local to the database and must all be accessible to the gpudb user, residing on the path (or relative to the path) specified by the external files directory in the Kinetica configuration file. Wildcards (*) can be used to specify a group of files. Prefix matching is supported, the prefixes must be aligned with directories. 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 (|). |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options from createTable, allowing the structure of the table to be defined independently of the data source.
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateTableMonitorResponse gpudb::GPUdb::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 clearTableMonitor.
For more information on table monitors, see Table Monitors.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateTableMonitorResponse& gpudb::GPUdb::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 clearTableMonitor.
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 gpudb::GPUdb::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 clearTableMonitor.
For more information on table monitors, see Table Monitors.
| [in] | tableName | Name of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | options | Optional parameters.
|
| CreateTableMonitorResponse& gpudb::GPUdb::createTableMonitor | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateTableMonitorResponse & | response_ | ||
| ) | const |
Creates a monitor that watches for 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 clearTableMonitor.
For more information on table monitors, see Table Monitors.
| [in] | tableName | Name of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateTriggerByAreaResponse gpudb::GPUdb::createTriggerByArea | ( | const CreateTriggerByAreaRequest & | request_ | ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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& gpudb::GPUdb::createTriggerByArea | ( | const CreateTriggerByAreaRequest & | request_, |
| CreateTriggerByAreaResponse & | response_ | ||
| ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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 gpudb::GPUdb::createTriggerByArea | ( | const std::string & | requestId, |
| const std::vector< std::string > & | tableNames, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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] | requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| [in] | tableNames | Names of the tables on which the trigger will be activated and maintained, each in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | xColumnName | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
| [in] | 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. |
| [in] | yColumnName | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| CreateTriggerByAreaResponse& gpudb::GPUdb::createTriggerByArea | ( | const std::string & | requestId, |
| const std::vector< std::string > & | tableNames, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTriggerByAreaResponse & | response_ | ||
| ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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] | requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| [in] | tableNames | Names of the tables on which the trigger will be activated and maintained, each in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | xColumnName | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
| [in] | 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. |
| [in] | yColumnName | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateTriggerByRangeResponse gpudb::GPUdb::createTriggerByRange | ( | const CreateTriggerByRangeRequest & | request_ | ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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& gpudb::GPUdb::createTriggerByRange | ( | const CreateTriggerByRangeRequest & | request_, |
| CreateTriggerByRangeResponse & | response_ | ||
| ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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 gpudb::GPUdb::createTriggerByRange | ( | const std::string & | requestId, |
| const std::vector< std::string > & | tableNames, | ||
| const std::string & | columnName, | ||
| const double | min, | ||
| const double | max, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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] | requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| [in] | tableNames | Tables on which the trigger will be active, each in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a numeric column_name on which the trigger is activated. |
| [in] | min | The lower bound (inclusive) for the trigger range. |
| [in] | max | The upper bound (inclusive) for the trigger range. |
| [in] | options | Optional parameters. The default value is an empty map. |
| CreateTriggerByRangeResponse& gpudb::GPUdb::createTriggerByRange | ( | const std::string & | requestId, |
| const std::vector< std::string > & | tableNames, | ||
| const std::string & | columnName, | ||
| const double | min, | ||
| const double | max, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTriggerByRangeResponse & | response_ | ||
| ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via insertRecords with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger 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] | requestId | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| [in] | tableNames | Tables on which the trigger will be active, each in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | columnName | Name of a numeric column_name on which the trigger is activated. |
| [in] | min | The lower bound (inclusive) for the trigger range. |
| [in] | max | The upper bound (inclusive) for the trigger range. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateTypeResponse gpudb::GPUdb::createType | ( | const CreateTypeRequest & | request_ | ) | const |
Creates a new type describing the layout 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 column value (or set of values for the key columns, if using a composite 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:
Properties:
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateTypeResponse& gpudb::GPUdb::createType | ( | const CreateTypeRequest & | request_, |
| CreateTypeResponse & | response_ | ||
| ) | const |
Creates a new type describing the layout 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 column value (or set of values for the key columns, if using a composite 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:
Properties:
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateTypeResponse gpudb::GPUdb::createType | ( | const std::string & | typeDefinition, |
| const std::string & | label, | ||
| const std::map< std::string, std::vector< std::string > > & | properties, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new type describing the layout 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 column value (or set of values for the key columns, if using a composite 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:
Properties:
| [in] | typeDefinition | a JSON string describing the columns of the type to be registered. |
| [in] | label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
| [in] | 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). Valid values are:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| CreateTypeResponse& gpudb::GPUdb::createType | ( | const std::string & | typeDefinition, |
| const std::string & | label, | ||
| const std::map< std::string, std::vector< std::string > > & | properties, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTypeResponse & | response_ | ||
| ) | const |
Creates a new type describing the layout 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 column value (or set of values for the key columns, if using a composite 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:
Properties:
| [in] | typeDefinition | a JSON string describing the columns of the type to be registered. |
| [in] | label | A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas. |
| [in] | 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). Valid values are:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateUnionResponse gpudb::GPUdb::createUnion | ( | const CreateUnionRequest & | request_ | ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| [in] | request_ | Request object containing the parameters for the operation. |
| CreateUnionResponse& gpudb::GPUdb::createUnion | ( | const CreateUnionRequest & | request_, |
| CreateUnionResponse & | response_ | ||
| ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateUnionResponse gpudb::GPUdb::createUnion | ( | const std::string & | tableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputColumnNames, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| [in] | tableName | Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | tableNames | The list of table names to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables. |
| [in] | inputColumnNames | The list of columns from each of the corresponding input tables. |
| [in] | outputColumnNames | The list of names of the columns to be stored in the output table. |
| [in] | options | Optional parameters.
|
| CreateUnionResponse& gpudb::GPUdb::createUnion | ( | const std::string & | tableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputColumnNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateUnionResponse & | response_ | ||
| ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
| [in] | tableName | Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. |
| [in] | tableNames | The list of table names to merge, in [schema_name.]table_name format, using standard name resolution rules. Must contain the names of one or more existing tables. |
| [in] | inputColumnNames | The list of columns from each of the corresponding input tables. |
| [in] | outputColumnNames | The list of names of the columns to be stored in the output table. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateUserExternalResponse gpudb::GPUdb::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& gpudb::GPUdb::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 gpudb::GPUdb::createUserExternal | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| [in] | 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. |
| [in] | options | Optional parameters.
|
| CreateUserExternalResponse& gpudb::GPUdb::createUserExternal | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| CreateUserExternalResponse & | response_ | ||
| ) | const |
Creates a new external user (a user whose credentials are managed by an external LDAP).
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateUserInternalResponse gpudb::GPUdb::createUserInternal | ( | const CreateUserInternalRequest & | request_ | ) | const |
| CreateUserInternalResponse& gpudb::GPUdb::createUserInternal | ( | const CreateUserInternalRequest & | request_, |
| CreateUserInternalResponse & | response_ | ||
| ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateUserInternalResponse gpudb::GPUdb::createUserInternal | ( | const std::string & | name, |
| const std::string & | password, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
| [in] | 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. |
| [in] | password | Initial password of the user to be created. May be an empty string for no password. |
| [in] | options | Optional parameters.
|
| CreateUserInternalResponse& gpudb::GPUdb::createUserInternal | ( | const std::string & | name, |
| const std::string & | password, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateUserInternalResponse & | response_ | ||
| ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
| [in] | 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. |
| [in] | password | Initial password of the user to be created. May be an empty string for no password. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| CreateVideoResponse gpudb::GPUdb::createVideo | ( | const CreateVideoRequest & | request_ | ) | const |
| CreateVideoResponse& gpudb::GPUdb::createVideo | ( | const CreateVideoRequest & | request_, |
| CreateVideoResponse & | response_ | ||
| ) | const |
Creates a job to generate a sequence of raster images that visualize data over a specified time.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| CreateVideoResponse gpudb::GPUdb::createVideo | ( | const std::string & | attribute, |
| const std::string & | begin, | ||
| const double | durationSeconds, | ||
| const std::string & | end, | ||
| const double | framesPerSecond, | ||
| const std::string & | style, | ||
| const std::string & | path, | ||
| const std::string & | styleParameters, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a job to generate a sequence of raster images that visualize data over a specified time.
| [in] | attribute | The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type. |
| [in] | begin | The start point for the video. Accepts an expression evaluable over the attribute. |
| [in] | durationSeconds | Seconds of video to produce |
| [in] | end | The end point for the video. Accepts an expression evaluable over the attribute. |
| [in] | framesPerSecond | The presentation frame rate of the encoded video in frames per second. |
| [in] | style | The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values: |
| [in] | path | Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true. |
| [in] | styleParameters | A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field. |
| [in] | options | Optional parameters.
|
| CreateVideoResponse& gpudb::GPUdb::createVideo | ( | const std::string & | attribute, |
| const std::string & | begin, | ||
| const double | durationSeconds, | ||
| const std::string & | end, | ||
| const double | framesPerSecond, | ||
| const std::string & | style, | ||
| const std::string & | path, | ||
| const std::string & | styleParameters, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateVideoResponse & | response_ | ||
| ) | const |
Creates a job to generate a sequence of raster images that visualize data over a specified time.
| [in] | attribute | The animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type. |
| [in] | begin | The start point for the video. Accepts an expression evaluable over the attribute. |
| [in] | durationSeconds | Seconds of video to produce |
| [in] | end | The end point for the video. Accepts an expression evaluable over the attribute. |
| [in] | framesPerSecond | The presentation frame rate of the encoded video in frames per second. |
| [in] | style | The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values: |
| [in] | path | Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true. |
| [in] | styleParameters | A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DeleteDirectoryResponse gpudb::GPUdb::deleteDirectory | ( | const DeleteDirectoryRequest & | request_ | ) | const |
| DeleteDirectoryResponse& gpudb::GPUdb::deleteDirectory | ( | const DeleteDirectoryRequest & | request_, |
| DeleteDirectoryResponse & | response_ | ||
| ) | const |
| DeleteDirectoryResponse gpudb::GPUdb::deleteDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a directory from KiFS.
| [in] | directoryName | Name of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true |
| [in] | options | Optional parameters.
|
| DeleteDirectoryResponse& gpudb::GPUdb::deleteDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteDirectoryResponse & | response_ | ||
| ) | const |
Deletes a directory from KiFS.
| [in] | directoryName | Name of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DeleteFilesResponse gpudb::GPUdb::deleteFiles | ( | const DeleteFilesRequest & | request_ | ) | const |
| DeleteFilesResponse& gpudb::GPUdb::deleteFiles | ( | const DeleteFilesRequest & | request_, |
| DeleteFilesResponse & | response_ | ||
| ) | const |
| DeleteFilesResponse gpudb::GPUdb::deleteFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes one or more files from KiFS.
| [in] | fileNames | An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. |
| [in] | options | Optional parameters.
|
| DeleteFilesResponse& gpudb::GPUdb::deleteFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteFilesResponse & | response_ | ||
| ) | const |
Deletes one or more files from KiFS.
| [in] | fileNames | An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DeleteGraphResponse gpudb::GPUdb::deleteGraph | ( | const DeleteGraphRequest & | request_ | ) | const |
| DeleteGraphResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | graphName | Name of the graph to be deleted. |
| [in] | options | Optional parameters.
|
| DeleteGraphResponse& gpudb::GPUdb::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.
| [in] | graphName | Name of the graph to be deleted. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DeleteProcResponse gpudb::GPUdb::deleteProc | ( | const DeleteProcRequest & | request_ | ) | const |
| DeleteProcResponse& gpudb::GPUdb::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 gpudb::GPUdb::deleteProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
| [in] | procName | Name of the proc to be deleted. Must be the name of a currently existing proc. |
| [in] | options | Optional parameters. The default value is an empty map. |
| DeleteProcResponse& gpudb::GPUdb::deleteProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteProcResponse & | response_ | ||
| ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
| [in] | procName | Name of the proc to be deleted. Must be the name of a currently existing proc. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteRecordsResponse gpudb::GPUdb::deleteRecords | ( | const DeleteRecordsRequest & | request_ | ) | const |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a 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& gpudb::GPUdb::deleteRecords | ( | const DeleteRecordsRequest & | request_, |
| DeleteRecordsResponse & | response_ | ||
| ) | const |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a 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 gpudb::GPUdb::deleteRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a 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] | tableName | Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| DeleteRecordsResponse& gpudb::GPUdb::deleteRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options, | ||
| DeleteRecordsResponse & | response_ | ||
| ) | const |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a 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] | tableName | Name of the table from which to delete records, in [schema_name.]table_name format, using standard name resolution rules. Must contain the name of an existing table; not applicable to views. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DeleteResourceGroupResponse gpudb::GPUdb::deleteResourceGroup | ( | const DeleteResourceGroupRequest & | request_ | ) | const |
| DeleteResourceGroupResponse& gpudb::GPUdb::deleteResourceGroup | ( | const DeleteResourceGroupRequest & | request_, |
| DeleteResourceGroupResponse & | response_ | ||
| ) | const |
| DeleteResourceGroupResponse gpudb::GPUdb::deleteResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a resource group.
| [in] | name | Name of the resource group to be deleted. |
| [in] | options | Optional parameters.
|
| DeleteResourceGroupResponse& gpudb::GPUdb::deleteResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteResourceGroupResponse & | response_ | ||
| ) | const |
Deletes a resource group.
| [in] | name | Name of the resource group to be deleted. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DeleteRoleResponse gpudb::GPUdb::deleteRole | ( | const DeleteRoleRequest & | request_ | ) | const |
| DeleteRoleResponse& gpudb::GPUdb::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 gpudb::GPUdb::deleteRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing role.
| [in] | name | Name of the role to be deleted. Must be an existing role. |
| [in] | options | Optional parameters. The default value is an empty map. |
| DeleteRoleResponse& gpudb::GPUdb::deleteRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteRoleResponse & | response_ | ||
| ) | const |
Deletes an existing role.
| [in] | name | Name of the role to be deleted. Must be an existing role. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| DeleteUserResponse gpudb::GPUdb::deleteUser | ( | const DeleteUserRequest & | request_ | ) | const |
| DeleteUserResponse& gpudb::GPUdb::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 gpudb::GPUdb::deleteUser | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing user.
| [in] | name | Name of the user to be deleted. Must be an existing user. |
| [in] | options | Optional parameters. The default value is an empty map. |
| DeleteUserResponse& gpudb::GPUdb::deleteUser | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteUserResponse & | response_ | ||
| ) | const |
Deletes an existing user.
| [in] | name | Name of the user to be deleted. Must be an existing user. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| DownloadFilesResponse gpudb::GPUdb::downloadFiles | ( | const DownloadFilesRequest & | request_ | ) | const |
| DownloadFilesResponse& gpudb::GPUdb::downloadFiles | ( | const DownloadFilesRequest & | request_, |
| DownloadFilesResponse & | response_ | ||
| ) | const |
| DownloadFilesResponse gpudb::GPUdb::downloadFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::vector< int64_t > & | readOffsets, | ||
| const std::vector< int64_t > & | readLengths, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Downloads one or more files from KiFS.
| [in] | fileNames | An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. |
| [in] | readOffsets | An array of starting byte offsets from which to read each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readLengths must also not be empty. |
| [in] | readLengths | Array of number of bytes to read from each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readOffsets must also not be empty. |
| [in] | options | Optional parameters.
|
| DownloadFilesResponse& gpudb::GPUdb::downloadFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::vector< int64_t > & | readOffsets, | ||
| const std::vector< int64_t > & | readLengths, | ||
| const std::map< std::string, std::string > & | options, | ||
| DownloadFilesResponse & | response_ | ||
| ) | const |
Downloads one or more files from KiFS.
| [in] | fileNames | An array of the file names to download from KiFS. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. |
| [in] | readOffsets | An array of starting byte offsets from which to read each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readLengths must also not be empty. |
| [in] | readLengths | Array of number of bytes to read from each respective file in fileNames. Must either be empty or the same length as fileNames. If empty, files are downloaded in their entirety. If not empty, readOffsets must also not be empty. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DropCredentialResponse gpudb::GPUdb::dropCredential | ( | const DropCredentialRequest & | request_ | ) | const |
Drop an existing credential.
| [in] | request_ | Request object containing the parameters for the operation. |
| DropCredentialResponse& gpudb::GPUdb::dropCredential | ( | const DropCredentialRequest & | request_, |
| DropCredentialResponse & | response_ | ||
| ) | const |
Drop an existing credential.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DropCredentialResponse gpudb::GPUdb::dropCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drop an existing credential.
| [in] | credentialName | Name of the credential to be dropped. Must be an existing credential. |
| [in] | options | Optional parameters. The default value is an empty map. |
| DropCredentialResponse& gpudb::GPUdb::dropCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options, | ||
| DropCredentialResponse & | response_ | ||
| ) | const |
Drop an existing credential.
| [in] | credentialName | Name of the credential to be dropped. Must be an existing credential. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| DropDatasinkResponse gpudb::GPUdb::dropDatasink | ( | const DropDatasinkRequest & | request_ | ) | const |
Drops an existing data sink.
By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear_table_monitors is true.
| [in] | request_ | Request object containing the parameters for the operation. |
| DropDatasinkResponse& gpudb::GPUdb::dropDatasink | ( | const DropDatasinkRequest & | request_, |
| DropDatasinkResponse & | response_ | ||
| ) | const |
Drops an existing data sink.
By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear_table_monitors is true.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DropDatasinkResponse gpudb::GPUdb::dropDatasink | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drops an existing data sink.
By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear_table_monitors is true.
| [in] | name | Name of the data sink to be dropped. Must be an existing data sink. |
| [in] | options | Optional parameters.
|
| DropDatasinkResponse& gpudb::GPUdb::dropDatasink | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DropDatasinkResponse & | response_ | ||
| ) | const |
Drops an existing data sink.
By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear_table_monitors is true.
| [in] | name | Name of the data sink to be dropped. Must be an existing data sink. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DropDatasourceResponse gpudb::GPUdb::dropDatasource | ( | const DropDatasourceRequest & | request_ | ) | const |
Drops an existing data source.
Any external tables that depend on the data source must be dropped before it can be dropped.
| [in] | request_ | Request object containing the parameters for the operation. |
| DropDatasourceResponse& gpudb::GPUdb::dropDatasource | ( | const DropDatasourceRequest & | request_, |
| DropDatasourceResponse & | response_ | ||
| ) | const |
Drops an existing data source.
Any external tables that depend on the data source must be dropped before it can be dropped.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DropDatasourceResponse gpudb::GPUdb::dropDatasource | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drops an existing data source.
Any external tables that depend on the data source must be dropped before it can be dropped.
| [in] | name | Name of the data source to be dropped. Must be an existing data source. |
| [in] | options | Optional parameters. The default value is an empty map. |
| DropDatasourceResponse& gpudb::GPUdb::dropDatasource | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DropDatasourceResponse & | response_ | ||
| ) | const |
Drops an existing data source.
Any external tables that depend on the data source must be dropped before it can be dropped.
| [in] | name | Name of the data source to be dropped. Must be an existing data source. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| DropEnvironmentResponse gpudb::GPUdb::dropEnvironment | ( | const DropEnvironmentRequest & | request_ | ) | const |
Drop an existing user-defined function (UDF) environment.
| [in] | request_ | Request object containing the parameters for the operation. |
| DropEnvironmentResponse& gpudb::GPUdb::dropEnvironment | ( | const DropEnvironmentRequest & | request_, |
| DropEnvironmentResponse & | response_ | ||
| ) | const |
Drop an existing user-defined function (UDF) environment.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DropEnvironmentResponse gpudb::GPUdb::dropEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drop an existing user-defined function (UDF) environment.
| [in] | environmentName | Name of the environment to be dropped. Must be an existing environment. |
| [in] | options | Optional parameters.
|
| DropEnvironmentResponse& gpudb::GPUdb::dropEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options, | ||
| DropEnvironmentResponse & | response_ | ||
| ) | const |
Drop an existing user-defined function (UDF) environment.
| [in] | environmentName | Name of the environment to be dropped. Must be an existing environment. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| DropSchemaResponse gpudb::GPUdb::dropSchema | ( | const DropSchemaRequest & | request_ | ) | const |
Drops an existing SQL-style schema, specified in schemaName.
| [in] | request_ | Request object containing the parameters for the operation. |
| DropSchemaResponse& gpudb::GPUdb::dropSchema | ( | const DropSchemaRequest & | request_, |
| DropSchemaResponse & | response_ | ||
| ) | const |
Drops an existing SQL-style schema, specified in schemaName.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| DropSchemaResponse gpudb::GPUdb::dropSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drops an existing SQL-style schema, specified in schemaName.
| [in] | schemaName | Name of the schema to be dropped. Must be an existing schema. |
| [in] | options | Optional parameters.
|
| DropSchemaResponse& gpudb::GPUdb::dropSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options, | ||
| DropSchemaResponse & | response_ | ||
| ) | const |
Drops an existing SQL-style schema, specified in schemaName.
| [in] | schemaName | Name of the schema to be dropped. Must be an existing schema. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| long gpudb::GPUdb::execute | ( | const std::string & | sql | ) |
This method is used to execute a SQL statement (e.g., DML, DDL).
It returns the number of rows affected by the statement.
| sql | - The SQL query to execute |
| long gpudb::GPUdb::execute | ( | const std::string & | sql, |
| const std::string & | parameters | ||
| ) |
This method is used to execute a SQL statement (e.g., DML, DDL).
It returns the number of rows affected by the statement.
| sql | - The SQL query to execute |
| parameters | - Query parameters for the SQL query. Can be empty. |
| long gpudb::GPUdb::execute | ( | const std::string & | sql, |
| const std::string & | parameters, | ||
| const std::map< std::string, std::string > & | options | ||
| ) |
This method is used to execute a SQL statement (e.g., DML, DDL).
It returns the number of rows affected by the statement.
| sql | - The SQL query to execute |
| parameters | - Query parameters for the SQL query. Can be empty. |
| options | - Optional parameters for the execute call. |
| long gpudb::GPUdb::execute | ( | const std::string & | sql, |
| const std::vector< T > & | parameters | ||
| ) |
| long gpudb::GPUdb::execute | ( | const std::string & | sql, |
| const std::vector< T > & | parameters, | ||
| const std::map< std::string, std::string > & | options | ||
| ) |
| ExecuteProcResponse gpudb::GPUdb::executeProc | ( | const ExecuteProcRequest & | request_ | ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
If the proc being executed is distributed, inputTableNames & inputColumnNames may be passed to the proc to use for reading data, and outputTableNames may be passed to the proc to use for writing data.
If the proc being executed is non-distributed, these table parameters will be ignored.
| [in] | request_ | Request object containing the parameters for the operation. |
| ExecuteProcResponse& gpudb::GPUdb::executeProc | ( | const ExecuteProcRequest & | request_, |
| ExecuteProcResponse & | response_ | ||
| ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
If the proc being executed is distributed, inputTableNames & inputColumnNames may be passed to the proc to use for reading data, and outputTableNames may be passed to the proc to use for writing data.
If the proc being executed is non-distributed, these table parameters will be ignored.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ExecuteProcResponse gpudb::GPUdb::executeProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | params, | ||
| const std::map< std::string, std::vector< uint8_t > > & | binParams, | ||
| const std::vector< std::string > & | inputTableNames, | ||
| const std::map< std::string, std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputTableNames, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
If the proc being executed is distributed, inputTableNames & inputColumnNames may be passed to the proc to use for reading data, and outputTableNames may be passed to the proc to use for writing data.
If the proc being executed is non-distributed, these table parameters will be ignored.
| [in] | procName | Name of the proc to execute. Must be the name of a currently existing proc. |
| [in] | params | A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty map. |
| [in] | 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. The default value is an empty map. |
| [in] | 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, in [schema_name.]table_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty vector. |
| [in] | 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. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty map. |
| [in] | outputTableNames | Names of the tables to which output data from the proc will be written, each in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. 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. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| ExecuteProcResponse& gpudb::GPUdb::executeProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | params, | ||
| const std::map< std::string, std::vector< uint8_t > > & | binParams, | ||
| const std::vector< std::string > & | inputTableNames, | ||
| const std::map< std::string, std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputTableNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| ExecuteProcResponse & | response_ | ||
| ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
If the proc being executed is distributed, inputTableNames & inputColumnNames may be passed to the proc to use for reading data, and outputTableNames may be passed to the proc to use for writing data.
If the proc being executed is non-distributed, these table parameters will be ignored.
| [in] | procName | Name of the proc to execute. Must be the name of a currently existing proc. |
| [in] | params | A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty map. |
| [in] | 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. The default value is an empty map. |
| [in] | 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, in [schema_name.]table_name format, using standard name resolution rules. If no table names are specified, no data will be passed to the proc. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty vector. |
| [in] | 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. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty map. |
| [in] | outputTableNames | Names of the tables to which output data from the proc will be written, each in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. 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. This parameter is ignored if the proc has a non-distributed execution mode. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ExecuteSqlResponse gpudb::GPUdb::executeSql | ( | const ExecuteSqlRequest & | request_ | ) | const |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
| [in] | request_ | Request object containing the parameters for the operation. |
| ExecuteSqlResponse& gpudb::GPUdb::executeSql | ( | const ExecuteSqlRequest & | request_, |
| ExecuteSqlResponse & | response_ | ||
| ) | const |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ExecuteSqlResponse gpudb::GPUdb::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 |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
| [in] | statement | SQL statement (query, DML, or DDL) to be executed |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | requestSchemaStr | Avro schema of data. The default value is ''. |
| [in] | data | An array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| ExecuteSqlResponse& gpudb::GPUdb::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 |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
| [in] | statement | SQL statement (query, DML, or DDL) to be executed |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | requestSchemaStr | Avro schema of data. The default value is ''. |
| [in] | data | An array of binary-encoded data for the records to be binded to the SQL query. Or use query_parameters to pass the data in JSON format. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RawExecuteSqlResponse gpudb::GPUdb::executeSqlRaw | ( | const ExecuteSqlRequest & | request_ | ) | const |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
| [in] | request_ | Request object containing the parameters for the operation. |
| RawExecuteSqlResponse& gpudb::GPUdb::executeSqlRaw | ( | const ExecuteSqlRequest & | request_, |
| RawExecuteSqlResponse & | response_ | ||
| ) | const |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ExportQueryMetricsResponse gpudb::GPUdb::exportQueryMetrics | ( | const ExportQueryMetricsRequest & | request_ | ) | const |
| ExportQueryMetricsResponse& gpudb::GPUdb::exportQueryMetrics | ( | const ExportQueryMetricsRequest & | request_, |
| ExportQueryMetricsResponse & | response_ | ||
| ) | const |
Export query metrics to a given destination.
Returns query metrics.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ExportQueryMetricsResponse gpudb::GPUdb::exportQueryMetrics | ( | const std::map< std::string, std::string > & | options | ) | const |
Export query metrics to a given destination.
Returns query metrics.
| [in] | options | Optional parameters.
|
| ExportQueryMetricsResponse& gpudb::GPUdb::exportQueryMetrics | ( | const std::map< std::string, std::string > & | options, |
| ExportQueryMetricsResponse & | response_ | ||
| ) | const |
Export query metrics to a given destination.
Returns query metrics.
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ExportRecordsToFilesResponse gpudb::GPUdb::exportRecordsToFiles | ( | const ExportRecordsToFilesRequest & | request_ | ) | const |
Export records from a table to files.
All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see createDatasink.
Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.
All filenames created are returned in the response.
| [in] | request_ | Request object containing the parameters for the operation. |
| ExportRecordsToFilesResponse& gpudb::GPUdb::exportRecordsToFiles | ( | const ExportRecordsToFilesRequest & | request_, |
| ExportRecordsToFilesResponse & | response_ | ||
| ) | const |
Export records from a table to files.
All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see createDatasink.
Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.
All filenames created are returned in the response.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ExportRecordsToFilesResponse gpudb::GPUdb::exportRecordsToFiles | ( | const std::string & | tableName, |
| const std::string & | filepath, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Export records from a table to files.
All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see createDatasink.
Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.
All filenames created are returned in the response.
| [in] | tableName | |
| [in] | filepath | Path to data export target. If filepath has a file extension, it is read as the name of a file. If filepath is a directory, then the source table name with a random UUID appended will be used as the name of each exported file, all written to that directory. If filepath is a filename, then all exported files will have a random UUID appended to the given name. In either case, the target directory specified or implied must exist. The names of all exported files are returned in the response. |
| [in] | options | Optional parameters.
|
| ExportRecordsToFilesResponse& gpudb::GPUdb::exportRecordsToFiles | ( | const std::string & | tableName, |
| const std::string & | filepath, | ||
| const std::map< std::string, std::string > & | options, | ||
| ExportRecordsToFilesResponse & | response_ | ||
| ) | const |
Export records from a table to files.
All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see createDatasink.
Server's local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.
All filenames created are returned in the response.
| [in] | tableName | |
| [in] | filepath | Path to data export target. If filepath has a file extension, it is read as the name of a file. If filepath is a directory, then the source table name with a random UUID appended will be used as the name of each exported file, all written to that directory. If filepath is a filename, then all exported files will have a random UUID appended to the given name. In either case, the target directory specified or implied must exist. The names of all exported files are returned in the response. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ExportRecordsToTableResponse gpudb::GPUdb::exportRecordsToTable | ( | const ExportRecordsToTableRequest & | request_ | ) | const |
| ExportRecordsToTableResponse& gpudb::GPUdb::exportRecordsToTable | ( | const ExportRecordsToTableRequest & | request_, |
| ExportRecordsToTableResponse & | response_ | ||
| ) | const |
Exports records from source table to the specified target table in an external database.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ExportRecordsToTableResponse gpudb::GPUdb::exportRecordsToTable | ( | const std::string & | tableName, |
| const std::string & | remoteQuery, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Exports records from source table to the specified target table in an external database.
| [in] | tableName | Name of the table from which the data will be exported to remote database, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | remoteQuery | Parameterized insert query to export gpudb table data into remote database. The default value is ''. |
| [in] | options | Optional parameters.
|
| ExportRecordsToTableResponse& gpudb::GPUdb::exportRecordsToTable | ( | const std::string & | tableName, |
| const std::string & | remoteQuery, | ||
| const std::map< std::string, std::string > & | options, | ||
| ExportRecordsToTableResponse & | response_ | ||
| ) | const |
Exports records from source table to the specified target table in an external database.
| [in] | tableName | Name of the table from which the data will be exported to remote database, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | remoteQuery | Parameterized insert query to export gpudb table data into remote database. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterResponse gpudb::GPUdb::filter | ( | const FilterRequest & | request_ | ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterResponse& gpudb::GPUdb::filter | ( | const FilterRequest & | request_, |
| FilterResponse & | response_ | ||
| ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterResponse gpudb::GPUdb::filter | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | expression, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | expression | The select expression to filter the specified table. For details see Expressions. |
| [in] | options | Optional parameters.
|
| FilterResponse& gpudb::GPUdb::filter | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | expression, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterResponse & | response_ | ||
| ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | expression | The select expression to filter the specified table. For details see Expressions. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByAreaResponse gpudb::GPUdb::filterByArea | ( | const FilterByAreaRequest & | request_ | ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByAreaResponse& gpudb::GPUdb::filterByArea | ( | const FilterByAreaRequest & | request_, |
| FilterByAreaResponse & | response_ | ||
| ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByAreaResponse gpudb::GPUdb::filterByArea | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | xColumnName | Name of the column containing the x values to be filtered. |
| [in] | xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | yColumnName | Name of the column containing the y values to be filtered. |
| [in] | yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | options | Optional parameters.
|
| FilterByAreaResponse& gpudb::GPUdb::filterByArea | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByAreaResponse & | response_ | ||
| ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | xColumnName | Name of the column containing the x values to be filtered. |
| [in] | xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | yColumnName | Name of the column containing the y values to be filtered. |
| [in] | yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByAreaGeometryResponse gpudb::GPUdb::filterByAreaGeometry | ( | const FilterByAreaGeometryRequest & | request_ | ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByAreaGeometryResponse& gpudb::GPUdb::filterByAreaGeometry | ( | const FilterByAreaGeometryRequest & | request_, |
| FilterByAreaGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByAreaGeometryResponse gpudb::GPUdb::filterByAreaGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the geospatial geometry column to be filtered. |
| [in] | xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | options | Optional parameters.
|
| FilterByAreaGeometryResponse& gpudb::GPUdb::filterByAreaGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByAreaGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the geospatial geometry column to be filtered. |
| [in] | xVector | List of x coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | yVector | List of y coordinates of the vertices of the polygon representing the area to be filtered. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByBoxResponse gpudb::GPUdb::filterByBox | ( | const FilterByBoxRequest & | request_ | ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByBoxResponse& gpudb::GPUdb::filterByBox | ( | const FilterByBoxRequest & | request_, |
| FilterByBoxResponse & | response_ | ||
| ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByBoxResponse gpudb::GPUdb::filterByBox | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const std::string & | yColumnName, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | tableName | Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | xColumnName | Name of the column on which to perform the bounding box query. Must be a valid numeric column. |
| [in] | minX | Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX. |
| [in] | maxX | Upper bound for xColumnName. Must be greater than or equal to minX. |
| [in] | yColumnName | Name of a column on which to perform the bounding box query. Must be a valid numeric column. |
| [in] | minY | Lower bound for yColumnName. Must be less than or equal to maxY. |
| [in] | maxY | Upper bound for yColumnName. Must be greater than or equal to minY. |
| [in] | options | Optional parameters.
|
| FilterByBoxResponse& gpudb::GPUdb::filterByBox | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const std::string & | yColumnName, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByBoxResponse & | response_ | ||
| ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | tableName | Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | xColumnName | Name of the column on which to perform the bounding box query. Must be a valid numeric column. |
| [in] | minX | Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX. |
| [in] | maxX | Upper bound for xColumnName. Must be greater than or equal to minX. |
| [in] | yColumnName | Name of a column on which to perform the bounding box query. Must be a valid numeric column. |
| [in] | minY | Lower bound for yColumnName. Must be less than or equal to maxY. |
| [in] | maxY | Upper bound for yColumnName. Must be greater than or equal to minY. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByBoxGeometryResponse gpudb::GPUdb::filterByBoxGeometry | ( | const FilterByBoxGeometryRequest & | request_ | ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByBoxGeometryResponse& gpudb::GPUdb::filterByBoxGeometry | ( | const FilterByBoxGeometryRequest & | request_, |
| FilterByBoxGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByBoxGeometryResponse gpudb::GPUdb::filterByBoxGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | tableName | Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the geospatial geometry column to be filtered. |
| [in] | minX | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX. |
| [in] | maxX | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX. |
| [in] | minY | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY. |
| [in] | maxY | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY. |
| [in] | options | Optional parameters.
|
| FilterByBoxGeometryResponse& gpudb::GPUdb::filterByBoxGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByBoxGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
| [in] | tableName | Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the geospatial geometry column to be filtered. |
| [in] | minX | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX. |
| [in] | maxX | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX. |
| [in] | minY | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY. |
| [in] | maxY | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByGeometryResponse gpudb::GPUdb::filterByGeometry | ( | const FilterByGeometryRequest & | request_ | ) | const |
| FilterByGeometryResponse& gpudb::GPUdb::filterByGeometry | ( | const FilterByGeometryRequest & | request_, |
| FilterByGeometryResponse & | response_ | ||
| ) | const |
Applies a geometry filter against a geospatial geometry column in a given table 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 gpudb::GPUdb::filterByGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::string & | inputWkt, | ||
| const std::string & | operation, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Applies a geometry filter against a geospatial geometry column in a given table or view.
The filtering geometry is provided by inputWkt.
| [in] | tableName | Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the column to be used in the filter. Must be a geospatial geometry column. |
| [in] | inputWkt | A geometry in WKT format that will be used to filter the objects in tableName. The default value is ''. |
| [in] | operation | The geometric filtering operation to perform. Supported values:
|
| [in] | options | Optional parameters.
|
| FilterByGeometryResponse& gpudb::GPUdb::filterByGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::string & | inputWkt, | ||
| const std::string & | operation, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByGeometryResponse & | response_ | ||
| ) | const |
Applies a geometry filter against a geospatial geometry column in a given table or view.
The filtering geometry is provided by inputWkt.
| [in] | tableName | Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the column to be used in the filter. Must be a geospatial geometry column. |
| [in] | inputWkt | A geometry in WKT format that will be used to filter the objects in tableName. The default value is ''. |
| [in] | operation | The geometric filtering operation to perform. Supported values:
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByListResponse gpudb::GPUdb::filterByList | ( | const FilterByListRequest & | request_ | ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByListResponse& gpudb::GPUdb::filterByList | ( | const FilterByListRequest & | request_, |
| FilterByListResponse & | response_ | ||
| ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByListResponse gpudb::GPUdb::filterByList | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::map< std::string, std::vector< std::string > > & | columnValuesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnValuesMap | List of values for the corresponding column in the table |
| [in] | options | Optional parameters.
|
| FilterByListResponse& gpudb::GPUdb::filterByList | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::map< std::string, std::vector< std::string > > & | columnValuesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByListResponse & | response_ | ||
| ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
| [in] | tableName | Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries). |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnValuesMap | List of values for the corresponding column in the table |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByRadiusResponse gpudb::GPUdb::filterByRadius | ( | const FilterByRadiusRequest & | request_ | ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByRadiusResponse& gpudb::GPUdb::filterByRadius | ( | const FilterByRadiusRequest & | request_, |
| FilterByRadiusResponse & | response_ | ||
| ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByRadiusResponse gpudb::GPUdb::filterByRadius | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | xCenter, | ||
| const std::string & | yColumnName, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| [in] | tableName | Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | xColumnName | Name of the column to be used for the x-coordinate (the longitude) of the center. |
| [in] | 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. |
| [in] | yColumnName | Name of the column to be used for the y-coordinate-the latitude-of the center. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| FilterByRadiusResponse& gpudb::GPUdb::filterByRadius | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | xCenter, | ||
| const std::string & | yColumnName, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByRadiusResponse & | response_ | ||
| ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
| [in] | tableName | Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | xColumnName | Name of the column to be used for the x-coordinate (the longitude) of the center. |
| [in] | 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. |
| [in] | yColumnName | Name of the column to be used for the y-coordinate-the latitude-of the center. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByRadiusGeometryResponse gpudb::GPUdb::filterByRadiusGeometry | ( | const FilterByRadiusGeometryRequest & | request_ | ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByRadiusGeometryResponse& gpudb::GPUdb::filterByRadiusGeometry | ( | const FilterByRadiusGeometryRequest & | request_, |
| FilterByRadiusGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByRadiusGeometryResponse gpudb::GPUdb::filterByRadiusGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | xCenter, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
| [in] | tableName | Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the geospatial geometry column to be filtered. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| FilterByRadiusGeometryResponse& gpudb::GPUdb::filterByRadiusGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | xCenter, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByRadiusGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
| [in] | tableName | Name of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the geospatial geometry column to be filtered. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByRangeResponse gpudb::GPUdb::filterByRange | ( | const FilterByRangeRequest & | request_ | ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByRangeResponse& gpudb::GPUdb::filterByRange | ( | const FilterByRangeRequest & | request_, |
| FilterByRangeResponse & | response_ | ||
| ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByRangeResponse gpudb::GPUdb::filterByRange | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | lowerBound, | ||
| const double | upperBound, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| [in] | tableName | Name of the table on which the filter by range operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of a column on which the operation would be applied. |
| [in] | lowerBound | Value of the lower bound (inclusive). |
| [in] | upperBound | Value of the upper bound (inclusive). |
| [in] | options | Optional parameters.
|
| FilterByRangeResponse& gpudb::GPUdb::filterByRange | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | lowerBound, | ||
| const double | upperBound, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByRangeResponse & | response_ | ||
| ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
| [in] | tableName | Name of the table on which the filter by range operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of a column on which the operation would be applied. |
| [in] | lowerBound | Value of the lower bound (inclusive). |
| [in] | upperBound | Value of the upper bound (inclusive). |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterBySeriesResponse gpudb::GPUdb::filterBySeries | ( | const FilterBySeriesRequest & | request_ | ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterBySeriesResponse& gpudb::GPUdb::filterBySeries | ( | const FilterBySeriesRequest & | request_, |
| FilterBySeriesResponse & | response_ | ||
| ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterBySeriesResponse gpudb::GPUdb::filterBySeries | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | trackId, | ||
| const std::vector< std::string > & | targetTrackIds, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| [in] | tableName | Name of the table on which the filter by track operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table with a track present. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | trackId | The ID of the track which will act as the filtering points. Must be an existing track within the given table. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| FilterBySeriesResponse& gpudb::GPUdb::filterBySeries | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | trackId, | ||
| const std::vector< std::string > & | targetTrackIds, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterBySeriesResponse & | response_ | ||
| ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
| [in] | tableName | Name of the table on which the filter by track operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table with a track present. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | trackId | The ID of the track which will act as the filtering points. Must be an existing track within the given table. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByStringResponse gpudb::GPUdb::filterByString | ( | const FilterByStringRequest & | request_ | ) | const |
Calculates which objects from a table or view match a string expression for the given string columns.
Setting case_sensitive can modify case sensitivity in matching 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& gpudb::GPUdb::filterByString | ( | const FilterByStringRequest & | request_, |
| FilterByStringResponse & | response_ | ||
| ) | const |
Calculates which objects from a table or view match a string expression for the given string columns.
Setting case_sensitive can modify case sensitivity in matching 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 gpudb::GPUdb::filterByString | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | expression, | ||
| const std::string & | mode, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table or view match a string expression for the given string columns.
Setting case_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.
| [in] | tableName | Name of the table on which the filter operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | expression | The expression with which to filter the table. |
| [in] | mode | The string filtering mode to apply. See below for details. Supported values:
|
| [in] | columnNames | List of columns on which to apply the filter. Ignored for search mode. |
| [in] | options | Optional parameters.
|
| FilterByStringResponse& gpudb::GPUdb::filterByString | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | expression, | ||
| const std::string & | mode, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByStringResponse & | response_ | ||
| ) | const |
Calculates which objects from a table or view match a string expression for the given string columns.
Setting case_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.
| [in] | tableName | Name of the table on which the filter operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | expression | The expression with which to filter the table. |
| [in] | mode | The string filtering mode to apply. See below for details. Supported values:
|
| [in] | columnNames | List of columns on which to apply the filter. Ignored for search mode. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByTableResponse gpudb::GPUdb::filterByTable | ( | const FilterByTableRequest & | request_ | ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByTableResponse& gpudb::GPUdb::filterByTable | ( | const FilterByTableRequest & | request_, |
| FilterByTableResponse & | response_ | ||
| ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByTableResponse gpudb::GPUdb::filterByTable | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::string & | sourceTableName, | ||
| const std::string & | sourceTableColumnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| [in] | tableName | Name of the table whose data will be filtered, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the column by whose value the data will be filtered from the table designated by tableName. |
| [in] | sourceTableName | Name of the table whose data will be compared against in the table called tableName, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| FilterByTableResponse& gpudb::GPUdb::filterByTable | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::string & | sourceTableName, | ||
| const std::string & | sourceTableColumnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByTableResponse & | response_ | ||
| ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
| [in] | tableName | Name of the table whose data will be filtered, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | columnName | Name of the column by whose value the data will be filtered from the table designated by tableName. |
| [in] | sourceTableName | Name of the table whose data will be compared against in the table called tableName, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| FilterByValueResponse gpudb::GPUdb::filterByValue | ( | const FilterByValueRequest & | request_ | ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| [in] | request_ | Request object containing the parameters for the operation. |
| FilterByValueResponse& gpudb::GPUdb::filterByValue | ( | const FilterByValueRequest & | request_, |
| FilterByValueResponse & | response_ | ||
| ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| FilterByValueResponse gpudb::GPUdb::filterByValue | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const bool | isString, | ||
| const double | value, | ||
| const std::string & | valueStr, | ||
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| [in] | tableName | Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | isString | Indicates whether the value being searched for is string or numeric. |
| [in] | value | The value to search for. The default value is 0. |
| [in] | valueStr | The string value to search for. The default value is ''. |
| [in] | columnName | Name of a column on which the filter by value would be applied. |
| [in] | options | Optional parameters.
|
| FilterByValueResponse& gpudb::GPUdb::filterByValue | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const bool | isString, | ||
| const double | value, | ||
| const std::string & | valueStr, | ||
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByValueResponse & | response_ | ||
| ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
| [in] | tableName | Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | viewName | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''. |
| [in] | isString | Indicates whether the value being searched for is string or numeric. |
| [in] | value | The value to search for. The default value is 0. |
| [in] | valueStr | The string value to search for. The default value is ''. |
| [in] | columnName | Name of a column on which the filter by value would be applied. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
|
inlinestatic |
| bool gpudb::GPUdb::getBypassSslCertCheck | ( | ) | const |
| avro::ExecutorPtr gpudb::GPUdb::getExecutor | ( | ) | const |
| HASynchronicityMode gpudb::GPUdb::getHASyncMode | ( | ) | const |
| const HttpUrl& gpudb::GPUdb::getHmUrl | ( | ) | const |
| const std::vector<HttpUrl>& gpudb::GPUdb::getHmUrls | ( | ) | const |
| const std::map<std::string, std::string>& gpudb::GPUdb::getHttpHeaders | ( | ) | const |
| GetJobResponse gpudb::GPUdb::getJob | ( | const GetJobRequest & | request_ | ) | const |
Get the status and result of asynchronously running job.
See the createJob 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& gpudb::GPUdb::getJob | ( | const GetJobRequest & | request_, |
| GetJobResponse & | response_ | ||
| ) | const |
Get the status and result of asynchronously running job.
See the createJob 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 gpudb::GPUdb::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 createJob for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
| [in] | jobId | A unique identifier for the job whose status and result is to be fetched. |
| [in] | options | Optional parameters.
|
| GetJobResponse& gpudb::GPUdb::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 createJob for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
| [in] | jobId | A unique identifier for the job whose status and result is to be fetched. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| const std::string& gpudb::GPUdb::getOauthToken | ( | ) | const |
| const std::string& gpudb::GPUdb::getPassword | ( | ) | const |
| const std::string& gpudb::GPUdb::getPrimaryURL | ( | ) | const |
Return a string containing the URL for the primary cluster; empty string otherwise.
| GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords | ( | const GetRecordsRequest & | request_ | ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
| GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords | ( | const GetRecordsRequest & | request_ | ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
| GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords | ( | const GetRecordsRequest & | request_, |
| GetRecordsResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
| GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords | ( | const GetRecordsRequest & | request_, |
| GetRecordsResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
| GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| GetRecordsResponse<boost::any> gpudb::GPUdb::getRecords | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
| GetRecordsResponse<boost::any>& gpudb::GPUdb::getRecords | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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] | tableName | Name of the table or view from which the records will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
| GetRecordsByColumnResponse gpudb::GPUdb::getRecordsByColumn | ( | const GetRecordsByColumnRequest & | request_ | ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection.
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& gpudb::GPUdb::getRecordsByColumn | ( | const GetRecordsByColumnRequest & | request_, |
| GetRecordsByColumnResponse & | response_ | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection.
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 gpudb::GPUdb::getRecordsByColumn | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection.
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] | tableName | Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. |
| [in] | columnNames | The list of column values to retrieve. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| GetRecordsByColumnResponse& gpudb::GPUdb::getRecordsByColumn | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsByColumnResponse & | response_ | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection.
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] | tableName | Name of the table or view on which this operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. |
| [in] | columnNames | The list of column values to retrieve. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
| RawGetRecordsByColumnResponse gpudb::GPUdb::getRecordsByColumnRaw | ( | const GetRecordsByColumnRequest & | request_ | ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection.
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& gpudb::GPUdb::getRecordsByColumnRaw | ( | const GetRecordsByColumnRequest & | request_, |
| RawGetRecordsByColumnResponse & | response_ | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection.
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<boost::any> gpudb::GPUdb::getRecordsBySeries | ( | const GetRecordsBySeriesRequest & | request_ | ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
| GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries | ( | const GetRecordsBySeriesRequest & | request_ | ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
| GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries | ( | const GetRecordsBySeriesRequest & | request_, |
| GetRecordsBySeriesResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
| GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries | ( | const GetRecordsBySeriesRequest & | request_, |
| GetRecordsBySeriesResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
| GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| GetRecordsBySeriesResponse<boost::any> gpudb::GPUdb::getRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsBySeriesResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| GetRecordsBySeriesResponse<boost::any>& gpudb::GPUdb::getRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsBySeriesResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecords 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] | tableName | Name of the table or view for which series/tracks will be fetched, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | worldTableName | Name of the table containing the complete series/track information to be returned for the tracks present in the tableName, in [schema_name.]table_name format, using standard name resolution rules. 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. |
| [in] | offset | A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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. The default value is 250. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| RawGetRecordsBySeriesResponse gpudb::GPUdb::getRecordsBySeriesRaw | ( | const GetRecordsBySeriesRequest & | request_ | ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecordsRaw 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& gpudb::GPUdb::getRecordsBySeriesRaw | ( | const GetRecordsBySeriesRequest & | request_, |
| RawGetRecordsBySeriesResponse & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to getRecordsRaw 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<boost::any> gpudb::GPUdb::getRecordsFromCollection | ( | const GetRecordsFromCollectionRequest & | request_ | ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | request_ | Request object containing the parameters for the operation. |
| GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection | ( | const GetRecordsFromCollectionRequest & | request_ | ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | request_ | Request object containing the parameters for the operation. |
| GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection | ( | const GetRecordsFromCollectionRequest & | request_, |
| GetRecordsFromCollectionResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection | ( | const GetRecordsFromCollectionRequest & | request_, |
| GetRecordsFromCollectionResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| GetRecordsFromCollectionResponse<boost::any> gpudb::GPUdb::getRecordsFromCollection | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsFromCollectionResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
| GetRecordsFromCollectionResponse<boost::any>& gpudb::GPUdb::getRecordsFromCollection | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsFromCollectionResponse< boost::any > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | request_ | Request object containing the parameters for the operation. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| 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. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| 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. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| 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. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| 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. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| 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. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | schema_ | Avro schema object used for decoding returned objects. |
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| TResponse | The type of object being retrieved. |
| [in] | type_ | Type object used for decoding returned objects. |
| [in] | tableName | Name of the collection or table from which records are to be retrieved, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing collection or table. |
| [in] | offset | A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. |
| [in] | 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 offset & limit to request subsequent pages of results. The default value is -9999. |
| [in] | options |
|
| [out] | response_ | Response object containing the results of the operation. |
| RawGetRecordsFromCollectionResponse gpudb::GPUdb::getRecordsFromCollectionRaw | ( | const GetRecordsFromCollectionRequest & | request_ | ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | request_ | Request object containing the parameters for the operation. |
| RawGetRecordsFromCollectionResponse& gpudb::GPUdb::getRecordsFromCollectionRaw | ( | const GetRecordsFromCollectionRequest & | request_, |
| RawGetRecordsFromCollectionResponse & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords.
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 views using this operation. (DEPRECATED)
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| RawGetRecordsResponse gpudb::GPUdb::getRecordsRaw | ( | const GetRecordsRequest & | request_ | ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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& gpudb::GPUdb::getRecordsRaw | ( | const GetRecordsRequest & | request_, |
| RawGetRecordsResponse & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables and views. 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. |
| boost::asio::ssl::context* gpudb::GPUdb::getSslContext | ( | ) | const |
| size_t gpudb::GPUdb::getThreadCount | ( | ) | const |
| size_t gpudb::GPUdb::getTimeout | ( | ) | const |
| const HttpUrl& gpudb::GPUdb::getUrl | ( | ) | const |
| const std::vector<HttpUrl>& gpudb::GPUdb::getUrls | ( | ) | const |
| const std::string& gpudb::GPUdb::getUsername | ( | ) | const |
| bool gpudb::GPUdb::getUseSnappy | ( | ) | const |
| GrantPermissionResponse gpudb::GPUdb::grantPermission | ( | const GrantPermissionRequest & | request_ | ) | const |
| GrantPermissionResponse& gpudb::GPUdb::grantPermission | ( | const GrantPermissionRequest & | request_, |
| GrantPermissionResponse & | response_ | ||
| ) | const |
Grant user or role the specified permission on the specified object.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionResponse gpudb::GPUdb::grantPermission | ( | const std::string & | principal, |
| const std::string & | object, | ||
| const std::string & | objectType, | ||
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grant user or role the specified permission on the specified object.
| [in] | principal | Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''. |
| [in] | object | Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible. |
| [in] | objectType | The type of object being granted to. Supported values:
|
| [in] | permission | Permission being granted. Supported values:
|
| [in] | options | Optional parameters.
|
| GrantPermissionResponse& gpudb::GPUdb::grantPermission | ( | const std::string & | principal, |
| const std::string & | object, | ||
| const std::string & | objectType, | ||
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionResponse & | response_ | ||
| ) | const |
Grant user or role the specified permission on the specified object.
| [in] | principal | Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''. |
| [in] | object | Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible. |
| [in] | objectType | The type of object being granted to. Supported values:
|
| [in] | permission | Permission being granted. Supported values:
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionCredentialResponse gpudb::GPUdb::grantPermissionCredential | ( | const GrantPermissionCredentialRequest & | request_ | ) | const |
Grants a credential-level permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| GrantPermissionCredentialResponse& gpudb::GPUdb::grantPermissionCredential | ( | const GrantPermissionCredentialRequest & | request_, |
| GrantPermissionCredentialResponse & | response_ | ||
| ) | const |
Grants a credential-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. |
| GrantPermissionCredentialResponse gpudb::GPUdb::grantPermissionCredential | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | credentialName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a credential-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | credentialName | Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials. |
| [in] | options | Optional parameters. The default value is an empty map. |
| GrantPermissionCredentialResponse& gpudb::GPUdb::grantPermissionCredential | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | credentialName, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionCredentialResponse & | response_ | ||
| ) | const |
Grants a credential-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | credentialName | Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionDatasourceResponse gpudb::GPUdb::grantPermissionDatasource | ( | const GrantPermissionDatasourceRequest & | request_ | ) | const |
Grants a data source permission to a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| GrantPermissionDatasourceResponse& gpudb::GPUdb::grantPermissionDatasource | ( | const GrantPermissionDatasourceRequest & | request_, |
| GrantPermissionDatasourceResponse & | response_ | ||
| ) | const |
Grants a data source 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. |
| GrantPermissionDatasourceResponse gpudb::GPUdb::grantPermissionDatasource | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | datasourceName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a data source permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | datasourceName | Name of the data source on which the permission will be granted. Must be an existing data source, or an empty string to grant permission on all data sources. |
| [in] | options | Optional parameters. The default value is an empty map. |
| GrantPermissionDatasourceResponse& gpudb::GPUdb::grantPermissionDatasource | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | datasourceName, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionDatasourceResponse & | response_ | ||
| ) | const |
Grants a data source permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | datasourceName | Name of the data source on which the permission will be granted. Must be an existing data source, or an empty string to grant permission on all data sources. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionDirectoryResponse gpudb::GPUdb::grantPermissionDirectory | ( | const GrantPermissionDirectoryRequest & | request_ | ) | const |
| GrantPermissionDirectoryResponse& gpudb::GPUdb::grantPermissionDirectory | ( | const GrantPermissionDirectoryRequest & | request_, |
| GrantPermissionDirectoryResponse & | response_ | ||
| ) | const |
Grants a KiFS directory-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. |
| GrantPermissionDirectoryResponse gpudb::GPUdb::grantPermissionDirectory | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | directoryName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a KiFS directory-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | directoryName | Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories |
| [in] | options | Optional parameters. The default value is an empty map. |
| GrantPermissionDirectoryResponse& gpudb::GPUdb::grantPermissionDirectory | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | directoryName, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionDirectoryResponse & | response_ | ||
| ) | const |
Grants a KiFS directory-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | directoryName | Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionProcResponse gpudb::GPUdb::grantPermissionProc | ( | const GrantPermissionProcRequest & | request_ | ) | const |
| GrantPermissionProcResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| GrantPermissionProcResponse& gpudb::GPUdb::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.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionSystemResponse gpudb::GPUdb::grantPermissionSystem | ( | const GrantPermissionSystemRequest & | request_ | ) | const |
| GrantPermissionSystemResponse& gpudb::GPUdb::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 gpudb::GPUdb::grantPermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a system-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| GrantPermissionSystemResponse& gpudb::GPUdb::grantPermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionSystemResponse & | response_ | ||
| ) | const |
Grants a system-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| GrantPermissionTableResponse gpudb::GPUdb::grantPermissionTable | ( | const GrantPermissionTableRequest & | request_ | ) | const |
| GrantPermissionTableResponse& gpudb::GPUdb::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 gpudb::GPUdb::grantPermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::string & | filterExpression, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a table-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | tableName | Name of the table to which the permission grants access, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table, view, or schema. If a schema, the permission also applies to tables and views in the schema. |
| [in] | filterExpression | Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''. |
| [in] | options | Optional parameters.
|
| GrantPermissionTableResponse& gpudb::GPUdb::grantPermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::string & | filterExpression, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionTableResponse & | response_ | ||
| ) | const |
Grants a table-level permission to a user or role.
| [in] | name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| [in] | permission | Permission to grant to the user or role. Supported values:
|
| [in] | tableName | Name of the table to which the permission grants access, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table, view, or schema. If a schema, the permission also applies to tables and views in the schema. |
| [in] | filterExpression | Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| GrantRoleResponse gpudb::GPUdb::grantRole | ( | const GrantRoleRequest & | request_ | ) | const |
| GrantRoleResponse& gpudb::GPUdb::grantRole | ( | const GrantRoleRequest & | request_, |
| GrantRoleResponse & | response_ | ||
| ) | const |
| GrantRoleResponse gpudb::GPUdb::grantRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants membership in a role to a user or role.
| [in] | role | Name of the role in which membership will be granted. Must be an existing role. |
| [in] | member | Name of the user or role that will be granted membership in role. Must be an existing user or role. |
| [in] | options | Optional parameters. The default value is an empty map. |
| GrantRoleResponse& gpudb::GPUdb::grantRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantRoleResponse & | response_ | ||
| ) | const |
Grants membership in a role to a user or role.
| [in] | role | Name of the role in which membership will be granted. Must be an existing role. |
| [in] | member | Name of the user or role that will be granted membership in role. Must be an existing user or role. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| HasPermissionResponse gpudb::GPUdb::hasPermission | ( | const HasPermissionRequest & | request_ | ) | const |
| HasPermissionResponse& gpudb::GPUdb::hasPermission | ( | const HasPermissionRequest & | request_, |
| HasPermissionResponse & | response_ | ||
| ) | const |
Checks if the specified user has the specified permission on the specified object.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| HasPermissionResponse gpudb::GPUdb::hasPermission | ( | const std::string & | principal, |
| const std::string & | object, | ||
| const std::string & | objectType, | ||
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks if the specified user has the specified permission on the specified object.
| [in] | principal | Name of the user for which the permission is being checked. Must be an existing user. If blank, will use the current user. The default value is ''. |
| [in] | object | Name of object to check for the requested permission. It is recommended to use a fully-qualified name when possible. |
| [in] | objectType | The type of object being checked. Supported values:
|
| [in] | permission | Permission to check for. Supported values:
|
| [in] | options | Optional parameters.
|
| HasPermissionResponse& gpudb::GPUdb::hasPermission | ( | const std::string & | principal, |
| const std::string & | object, | ||
| const std::string & | objectType, | ||
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| HasPermissionResponse & | response_ | ||
| ) | const |
Checks if the specified user has the specified permission on the specified object.
| [in] | principal | Name of the user for which the permission is being checked. Must be an existing user. If blank, will use the current user. The default value is ''. |
| [in] | object | Name of object to check for the requested permission. It is recommended to use a fully-qualified name when possible. |
| [in] | objectType | The type of object being checked. Supported values:
|
| [in] | permission | Permission to check for. Supported values:
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| HasProcResponse gpudb::GPUdb::hasProc | ( | const HasProcRequest & | request_ | ) | const |
| HasProcResponse& gpudb::GPUdb::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 gpudb::GPUdb::hasProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks the existence of a proc with the given name.
| [in] | procName | Name of the proc to check for existence. |
| [in] | options | Optional parameters. The default value is an empty map. |
| HasProcResponse& gpudb::GPUdb::hasProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| HasProcResponse & | response_ | ||
| ) | const |
Checks the existence of a proc with the given name.
| [in] | procName | Name of the proc to check for existence. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| HasRoleResponse gpudb::GPUdb::hasRole | ( | const HasRoleRequest & | request_ | ) | const |
| HasRoleResponse& gpudb::GPUdb::hasRole | ( | const HasRoleRequest & | request_, |
| HasRoleResponse & | response_ | ||
| ) | const |
Checks if the specified user has the specified role.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| HasRoleResponse gpudb::GPUdb::hasRole | ( | const std::string & | principal, |
| const std::string & | role, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks if the specified user has the specified role.
| [in] | principal | Name of the user for which role membersih is being checked. Must be an existing user. If blank, will use the current user. The default value is ''. |
| [in] | role | Name of role to check for membership. |
| [in] | options | Optional parameters.
|
| HasRoleResponse& gpudb::GPUdb::hasRole | ( | const std::string & | principal, |
| const std::string & | role, | ||
| const std::map< std::string, std::string > & | options, | ||
| HasRoleResponse & | response_ | ||
| ) | const |
Checks if the specified user has the specified role.
| [in] | principal | Name of the user for which role membersih is being checked. Must be an existing user. If blank, will use the current user. The default value is ''. |
| [in] | role | Name of role to check for membership. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| HasSchemaResponse gpudb::GPUdb::hasSchema | ( | const HasSchemaRequest & | request_ | ) | const |
| HasSchemaResponse& gpudb::GPUdb::hasSchema | ( | const HasSchemaRequest & | request_, |
| HasSchemaResponse & | response_ | ||
| ) | const |
Checks for the existence of a schema with the given name.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| HasSchemaResponse gpudb::GPUdb::hasSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks for the existence of a schema with the given name.
| [in] | schemaName | Name of the schema to check for existence, in root, using standard name resolution rules. |
| [in] | options | Optional parameters. The default value is an empty map. |
| HasSchemaResponse& gpudb::GPUdb::hasSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options, | ||
| HasSchemaResponse & | response_ | ||
| ) | const |
Checks for the existence of a schema with the given name.
| [in] | schemaName | Name of the schema to check for existence, in root, using standard name resolution rules. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| HasTableResponse gpudb::GPUdb::hasTable | ( | const HasTableRequest & | request_ | ) | const |
| HasTableResponse& gpudb::GPUdb::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 gpudb::GPUdb::hasTable | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks for the existence of a table with the given name.
| [in] | tableName | Name of the table to check for existence, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | options | Optional parameters. The default value is an empty map. |
| HasTableResponse& gpudb::GPUdb::hasTable | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| HasTableResponse & | response_ | ||
| ) | const |
Checks for the existence of a table with the given name.
| [in] | tableName | Name of the table to check for existence, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| HasTypeResponse gpudb::GPUdb::hasType | ( | const HasTypeRequest & | request_ | ) | const |
| HasTypeResponse& gpudb::GPUdb::hasType | ( | const HasTypeRequest & | request_, |
| HasTypeResponse & | response_ | ||
| ) | const |
| HasTypeResponse gpudb::GPUdb::hasType | ( | const std::string & | typeId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Check for the existence of a type.
| [in] | typeId | Id of the type returned in response to createType request. |
| [in] | options | Optional parameters. The default value is an empty map. |
| HasTypeResponse& gpudb::GPUdb::hasType | ( | const std::string & | typeId, |
| const std::map< std::string, std::string > & | options, | ||
| HasTypeResponse & | response_ | ||
| ) | const |
Check for the existence of a type.
| [in] | typeId | Id of the type returned in response to createType request. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| TRequest | The type of object being added. |
| [in] | request_ | Request object containing the parameters for the operation. |
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| 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. |
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| TRequest | The type of object being added. |
| [in] | tableName | Name of table to which the records are to be added, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
|
inline |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| TRequest | The type of object being added. |
| [in] | tableName | Name of table to which the records are to be added, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsFromFilesResponse gpudb::GPUdb::insertRecordsFromFiles | ( | const InsertRecordsFromFilesRequest & | request_ | ) | const |
Reads from one or more files and inserts the data into a new or existing table.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
For delimited text 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.
Note: Due to data being loaded in parallel, there is no insertion order guaranteed. For tables with primary keys, in the case of a primary key collision, this means it is indeterminate which record will be inserted first and remain, while the rest of the colliding key records are discarded.
Returns once all files are processed.
| [in] | request_ | Request object containing the parameters for the operation. |
| InsertRecordsFromFilesResponse& gpudb::GPUdb::insertRecordsFromFiles | ( | const InsertRecordsFromFilesRequest & | request_, |
| InsertRecordsFromFilesResponse & | response_ | ||
| ) | const |
Reads from one or more files and inserts the data into a new or existing table.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
For delimited text 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.
Note: Due to data being loaded in parallel, there is no insertion order guaranteed. For tables with primary keys, in the case of a primary key collision, this means it is indeterminate which record will be inserted first and remain, while the rest of the colliding key records are discarded.
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 gpudb::GPUdb::insertRecordsFromFiles | ( | const std::string & | tableName, |
| const std::vector< std::string > & | filepaths, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Reads from one or more files and inserts the data into a new or existing table.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
For delimited text 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.
Note: Due to data being loaded in parallel, there is no insertion order guaranteed. For tables with primary keys, in the case of a primary key collision, this means it is indeterminate which record will be inserted first and remain, while the rest of the colliding key records are discarded.
Returns once all files are processed.
| [in] | tableName | Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file, and the new table name will have to meet standard table naming criteria. |
| [in] | filepaths | A list of file paths from which data will be sourced; For paths in KiFS, use the uri prefix of kifs:// followed by the path to a file or directory. File matching by prefix is supported, e.g. kifs://dir/file would match dir/file_1 and dir/file_2. When prefix matching is used, the path must start with a full, valid KiFS directory name. If an external data source is specified in datasource_name, these file paths must resolve to accessible files at that data source location. Prefix matching is supported. If the data source is hdfs, prefixes must be aligned with directories, i.e. partial file names will not match. If no data source is specified, the files are assumed to be local to the database and must all be accessible to the gpudb user, residing on the path (or relative to the path) specified by the external files directory in the Kinetica configuration file. Wildcards (*) can be used to specify a group of files. Prefix matching is supported, the prefixes must be aligned with directories. 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 (|). |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options from createTable, allowing the structure of the table to be defined independently of the data source, when creating the target table.
|
| [in] | options | Optional parameters.
|
| InsertRecordsFromFilesResponse& gpudb::GPUdb::insertRecordsFromFiles | ( | const std::string & | tableName, |
| const std::vector< std::string > & | filepaths, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| 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 and inserts the data into a new or existing table.
The source data can be located either in KiFS; on the cluster, accessible to the database; or remotely, accessible via a pre-defined external data source.
For delimited text 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.
Note: Due to data being loaded in parallel, there is no insertion order guaranteed. For tables with primary keys, in the case of a primary key collision, this means it is indeterminate which record will be inserted first and remain, while the rest of the colliding key records are discarded.
Returns once all files are processed.
| [in] | tableName | Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the file, and the new table name will have to meet standard table naming criteria. |
| [in] | filepaths | A list of file paths from which data will be sourced; For paths in KiFS, use the uri prefix of kifs:// followed by the path to a file or directory. File matching by prefix is supported, e.g. kifs://dir/file would match dir/file_1 and dir/file_2. When prefix matching is used, the path must start with a full, valid KiFS directory name. If an external data source is specified in datasource_name, these file paths must resolve to accessible files at that data source location. Prefix matching is supported. If the data source is hdfs, prefixes must be aligned with directories, i.e. partial file names will not match. If no data source is specified, the files are assumed to be local to the database and must all be accessible to the gpudb user, residing on the path (or relative to the path) specified by the external files directory in the Kinetica configuration file. Wildcards (*) can be used to specify a group of files. Prefix matching is supported, the prefixes must be aligned with directories. 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 (|). |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options from createTable, allowing the structure of the table to be defined independently of the data source, when creating the target table.
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsFromPayloadResponse gpudb::GPUdb::insertRecordsFromPayload | ( | const InsertRecordsFromPayloadRequest & | request_ | ) | const |
Reads from the given text-based or binary payload and inserts the data into a new or existing table.
The table will be created if it doesn't already exist.
Returns once all records are processed.
| [in] | request_ | Request object containing the parameters for the operation. |
| InsertRecordsFromPayloadResponse& gpudb::GPUdb::insertRecordsFromPayload | ( | const InsertRecordsFromPayloadRequest & | request_, |
| InsertRecordsFromPayloadResponse & | response_ | ||
| ) | const |
Reads from the given text-based or binary payload and inserts the data into a new or existing table.
The table will be created if it doesn't already exist.
Returns once all records are processed.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsFromPayloadResponse gpudb::GPUdb::insertRecordsFromPayload | ( | const std::string & | tableName, |
| const std::string & | dataText, | ||
| const std::vector< uint8_t > & | dataBytes, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Reads from the given text-based or binary payload and inserts the data into a new or existing table.
The table will be created if it doesn't already exist.
Returns once all records are processed.
| [in] | tableName | Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the payload, and the new table name will have to meet standard table naming criteria. |
| [in] | dataText | Records formatted as delimited text |
| [in] | dataBytes | Records formatted as binary data |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options used when creating the target table. Includes type to use. The other options match those in createTable.
|
| [in] | options | Optional parameters.
|
| InsertRecordsFromPayloadResponse& gpudb::GPUdb::insertRecordsFromPayload | ( | const std::string & | tableName, |
| const std::string & | dataText, | ||
| const std::vector< uint8_t > & | dataBytes, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options, | ||
| InsertRecordsFromPayloadResponse & | response_ | ||
| ) | const |
Reads from the given text-based or binary payload and inserts the data into a new or existing table.
The table will be created if it doesn't already exist.
Returns once all records are processed.
| [in] | tableName | Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the payload, and the new table name will have to meet standard table naming criteria. |
| [in] | dataText | Records formatted as delimited text |
| [in] | dataBytes | Records formatted as binary data |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options used when creating the target table. Includes type to use. The other options match those in createTable.
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsFromQueryResponse gpudb::GPUdb::insertRecordsFromQuery | ( | const InsertRecordsFromQueryRequest & | request_ | ) | const |
| InsertRecordsFromQueryResponse& gpudb::GPUdb::insertRecordsFromQuery | ( | const InsertRecordsFromQueryRequest & | request_, |
| InsertRecordsFromQueryResponse & | response_ | ||
| ) | const |
Computes remote query result and inserts the result data into a new or existing table.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsFromQueryResponse gpudb::GPUdb::insertRecordsFromQuery | ( | const std::string & | tableName, |
| const std::string & | remoteQuery, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Computes remote query result and inserts the result data into a new or existing table.
| [in] | tableName | Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the remote query, and the new table name will have to meet standard table naming criteria. |
| [in] | remoteQuery | Query for which result data needs to be imported |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options used when creating the target table.
|
| [in] | options | Optional parameters.
|
| InsertRecordsFromQueryResponse& gpudb::GPUdb::insertRecordsFromQuery | ( | const std::string & | tableName, |
| const std::string & | remoteQuery, | ||
| const std::map< std::string, std::map< std::string, std::string > > & | modifyColumns, | ||
| const std::map< std::string, std::string > & | createTableOptions, | ||
| const std::map< std::string, std::string > & | options, | ||
| InsertRecordsFromQueryResponse & | response_ | ||
| ) | const |
Computes remote query result and inserts the result data into a new or existing table.
| [in] | tableName | Name of the table into which the data will be inserted, in [schema_name.]table_name format, using standard name resolution rules. If the table does not exist, the table will be created using either an existing type_id or the type inferred from the remote query, and the new table name will have to meet standard table naming criteria. |
| [in] | remoteQuery | Query for which result data needs to be imported |
| [in] | modifyColumns | Not implemented yet. The default value is an empty map. |
| [in] | createTableOptions | Options used when creating the target table.
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsRandomResponse gpudb::GPUdb::insertRecordsRandom | ( | const InsertRecordsRandomRequest & | request_ | ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
| [in] | request_ | Request object containing the parameters for the operation. |
| InsertRecordsRandomResponse& gpudb::GPUdb::insertRecordsRandom | ( | const InsertRecordsRandomRequest & | request_, |
| InsertRecordsRandomResponse & | response_ | ||
| ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| InsertRecordsRandomResponse gpudb::GPUdb::insertRecordsRandom | ( | const std::string & | tableName, |
| const int64_t | count, | ||
| const std::map< std::string, std::map< std::string, double > > & | options | ||
| ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
| [in] | tableName | Table to which random records will be added, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table, not a view. |
| [in] | count | Number of records to generate. |
| [in] | 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& gpudb::GPUdb::insertRecordsRandom | ( | const std::string & | tableName, |
| const int64_t | count, | ||
| const std::map< std::string, std::map< std::string, double > > & | options, | ||
| InsertRecordsRandomResponse & | response_ | ||
| ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
| [in] | tableName | Table to which random records will be added, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table, not a view. |
| [in] | count | Number of records to generate. |
| [in] | 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 gpudb::GPUdb::insertRecordsRaw | ( | const RawInsertRecordsRequest & | request_ | ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| [in] | request_ | Request object containing the parameters for the operation. |
| InsertRecordsResponse& gpudb::GPUdb::insertRecordsRaw | ( | const RawInsertRecordsRequest & | request_, |
| InsertRecordsResponse & | response_ | ||
| ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| InsertSymbolResponse gpudb::GPUdb::insertSymbol | ( | const InsertSymbolRequest & | request_ | ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
| [in] | request_ | Request object containing the parameters for the operation. |
| InsertSymbolResponse& gpudb::GPUdb::insertSymbol | ( | const InsertSymbolRequest & | request_, |
| InsertSymbolResponse & | response_ | ||
| ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| InsertSymbolResponse gpudb::GPUdb::insertSymbol | ( | const std::string & | symbolId, |
| const std::string & | symbolFormat, | ||
| const std::vector< uint8_t > & | symbolData, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
| [in] | 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 |
| [in] | symbolFormat | Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values: |
| [in] | 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' |
| [in] | options | Optional parameters.
|
| InsertSymbolResponse& gpudb::GPUdb::insertSymbol | ( | const std::string & | symbolId, |
| const std::string & | symbolFormat, | ||
| const std::vector< uint8_t > & | symbolData, | ||
| const std::map< std::string, std::string > & | options, | ||
| InsertSymbolResponse & | response_ | ||
| ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
| [in] | 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 |
| [in] | symbolFormat | Specifies the symbol format. Must be either 'svg' or 'svg_path'. Supported values: |
| [in] | 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' |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| KillProcResponse gpudb::GPUdb::killProc | ( | const KillProcRequest & | request_ | ) | const |
| KillProcResponse& gpudb::GPUdb::killProc | ( | const KillProcRequest & | request_, |
| KillProcResponse & | response_ | ||
| ) | const |
| KillProcResponse gpudb::GPUdb::killProc | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Kills a running proc instance.
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| KillProcResponse& gpudb::GPUdb::killProc | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options, | ||
| KillProcResponse & | response_ | ||
| ) | const |
Kills a running proc instance.
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| LockTableResponse gpudb::GPUdb::lockTable | ( | const LockTableRequest & | request_ | ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
| [in] | request_ | Request object containing the parameters for the operation. |
| LockTableResponse& gpudb::GPUdb::lockTable | ( | const LockTableRequest & | request_, |
| LockTableResponse & | response_ | ||
| ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| LockTableResponse gpudb::GPUdb::lockTable | ( | const std::string & | tableName, |
| const std::string & | lockType, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
| [in] | tableName | Name of the table to be locked, in [schema_name.]table_name format, using standard name resolution rules. It must be a currently existing table or view. |
| [in] | 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. Supported values:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| LockTableResponse& gpudb::GPUdb::lockTable | ( | const std::string & | tableName, |
| const std::string & | lockType, | ||
| const std::map< std::string, std::string > & | options, | ||
| LockTableResponse & | response_ | ||
| ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
| [in] | tableName | Name of the table to be locked, in [schema_name.]table_name format, using standard name resolution rules. It must be a currently existing table or view. |
| [in] | 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. Supported values:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| MatchGraphResponse gpudb::GPUdb::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 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& gpudb::GPUdb::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 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 gpudb::GPUdb::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 Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
| [in] | graphName | Name of the underlying geospatial graph resource to match to using samplePoints. |
| [in] | 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'. |
| [in] | solveMethod | The type of solver to use for graph matching. Supported values:
|
| [in] | solutionTable | The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. 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. Must not be an existing table of the same name. The default value is ''. |
| [in] | options | Additional parameters.
|
| MatchGraphResponse& gpudb::GPUdb::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 Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
| [in] | graphName | Name of the underlying geospatial graph resource to match to using samplePoints. |
| [in] | 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'. |
| [in] | solveMethod | The type of solver to use for graph matching. Supported values:
|
| [in] | solutionTable | The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. 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. Must not be an existing table of the same name. The default value is ''. |
| [in] | options | Additional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| MergeRecordsResponse gpudb::GPUdb::mergeRecords | ( | const MergeRecordsRequest & | request_ | ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
| [in] | request_ | Request object containing the parameters for the operation. |
| MergeRecordsResponse& gpudb::GPUdb::mergeRecords | ( | const MergeRecordsRequest & | request_, |
| MergeRecordsResponse & | response_ | ||
| ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| MergeRecordsResponse gpudb::GPUdb::mergeRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | sourceTableNames, | ||
| const std::vector< std::map< std::string, std::string > > & | fieldMaps, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
| [in] | tableName | The name of the new result table for the records to be merged into, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Must NOT be an existing table. |
| [in] | sourceTableNames | The list of names of source tables to get the records from, each in [schema_name.]table_name format, using standard name resolution rules. Must be existing table names. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| MergeRecordsResponse& gpudb::GPUdb::mergeRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | sourceTableNames, | ||
| const std::vector< std::map< std::string, std::string > > & | fieldMaps, | ||
| const std::map< std::string, std::string > & | options, | ||
| MergeRecordsResponse & | response_ | ||
| ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
| [in] | tableName | The name of the new result table for the records to be merged into, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Must NOT be an existing table. |
| [in] | sourceTableNames | The list of names of source tables to get the records from, each in [schema_name.]table_name format, using standard name resolution rules. Must be existing table names. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ModifyGraphResponse gpudb::GPUdb::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 Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
| [in] | request_ | Request object containing the parameters for the operation. |
| ModifyGraphResponse& gpudb::GPUdb::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 Graphs & Solvers concepts documentation, and Graph REST Tutorial 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 gpudb::GPUdb::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 Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
| [in] | graphName | Name of the graph resource to modify. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| ModifyGraphResponse& gpudb::GPUdb::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 Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
| [in] | graphName | Name of the graph resource to modify. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| QueryGraphResponse gpudb::GPUdb::queryGraph | ( | const QueryGraphRequest & | request_ | ) | const |
Employs a topological query on a graph generated a-priori by createGraph 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.
IMPORTANT: It's highly recommended that you review the 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. |
| QueryGraphResponse& gpudb::GPUdb::queryGraph | ( | const QueryGraphRequest & | request_, |
| QueryGraphResponse & | response_ | ||
| ) | const |
Employs a topological query on a graph generated a-priori by createGraph 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.
IMPORTANT: It's highly recommended that you review the 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. |
| QueryGraphResponse gpudb::GPUdb::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 graph generated a-priori by createGraph 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.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to query. |
| [in] | 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. |
| [in] | 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. The default value is an empty vector. |
| [in] | adjacencyTable | Name of the table to store the resulting adjacencies, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If left blank, the query results are instead returned in the response. 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. The default value is ''. |
| [in] | 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. The default value is 1. |
| [in] | options | Additional parameters.
|
| QueryGraphResponse& gpudb::GPUdb::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 graph generated a-priori by createGraph 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.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to query. |
| [in] | 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. |
| [in] | 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. The default value is an empty vector. |
| [in] | adjacencyTable | Name of the table to store the resulting adjacencies, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If left blank, the query results are instead returned in the response. 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. The default value is ''. |
| [in] | 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. The default value is 1. |
| [in] | options | Additional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| void gpudb::GPUdb::removeHttpHeader | ( | const std::string & | header | ) |
Removes the given HTTP header from the map of additional HTTP headers to send to GPUdb with each request.
The user is not allowed to remove the following headers:
| header | the HTTP header |
See getHttpHeaders() See addHttpHeader(const std::string&, const std::string&)
| RepartitionGraphResponse gpudb::GPUdb::repartitionGraph | ( | const RepartitionGraphRequest & | request_ | ) | const |
Rebalances an existing partitioned graph.
IMPORTANT: It's highly recommended that you review the 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. |
| RepartitionGraphResponse& gpudb::GPUdb::repartitionGraph | ( | const RepartitionGraphRequest & | request_, |
| RepartitionGraphResponse & | response_ | ||
| ) | const |
Rebalances an existing partitioned graph.
IMPORTANT: It's highly recommended that you review the 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. |
| RepartitionGraphResponse gpudb::GPUdb::repartitionGraph | ( | const std::string & | graphName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Rebalances an existing partitioned graph.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to rebalance. |
| [in] | options | Optional parameters.
|
| RepartitionGraphResponse& gpudb::GPUdb::repartitionGraph | ( | const std::string & | graphName, |
| const std::map< std::string, std::string > & | options, | ||
| RepartitionGraphResponse & | response_ | ||
| ) | const |
Rebalances an existing partitioned graph.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to rebalance. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionResponse gpudb::GPUdb::revokePermission | ( | const RevokePermissionRequest & | request_ | ) | const |
| RevokePermissionResponse& gpudb::GPUdb::revokePermission | ( | const RevokePermissionRequest & | request_, |
| RevokePermissionResponse & | response_ | ||
| ) | const |
Revoke user or role the specified permission on the specified object.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionResponse gpudb::GPUdb::revokePermission | ( | const std::string & | principal, |
| const std::string & | object, | ||
| const std::string & | objectType, | ||
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revoke user or role the specified permission on the specified object.
| [in] | principal | Name of the user or role for which the permission is being revoked. Must be an existing user or role. The default value is ''. |
| [in] | object | Name of object permission is being revoked from. It is recommended to use a fully-qualified name when possible. |
| [in] | objectType | The type of object being revoked. Supported values:
|
| [in] | permission | Permission being revoked. Supported values:
|
| [in] | options | Optional parameters.
|
| RevokePermissionResponse& gpudb::GPUdb::revokePermission | ( | const std::string & | principal, |
| const std::string & | object, | ||
| const std::string & | objectType, | ||
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionResponse & | response_ | ||
| ) | const |
Revoke user or role the specified permission on the specified object.
| [in] | principal | Name of the user or role for which the permission is being revoked. Must be an existing user or role. The default value is ''. |
| [in] | object | Name of object permission is being revoked from. It is recommended to use a fully-qualified name when possible. |
| [in] | objectType | The type of object being revoked. Supported values:
|
| [in] | permission | Permission being revoked. Supported values:
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionCredentialResponse gpudb::GPUdb::revokePermissionCredential | ( | const RevokePermissionCredentialRequest & | request_ | ) | const |
Revokes a credential-level permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| RevokePermissionCredentialResponse& gpudb::GPUdb::revokePermissionCredential | ( | const RevokePermissionCredentialRequest & | request_, |
| RevokePermissionCredentialResponse & | response_ | ||
| ) | const |
Revokes a credential-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. |
| RevokePermissionCredentialResponse gpudb::GPUdb::revokePermissionCredential | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | credentialName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a credential-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | credentialName | Name of the credential on which the permission will be revoked. Must be an existing credential, or an empty string to revoke access on all credentials. |
| [in] | options | Optional parameters. The default value is an empty map. |
| RevokePermissionCredentialResponse& gpudb::GPUdb::revokePermissionCredential | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | credentialName, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionCredentialResponse & | response_ | ||
| ) | const |
Revokes a credential-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | credentialName | Name of the credential on which the permission will be revoked. Must be an existing credential, or an empty string to revoke access on all credentials. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionDatasourceResponse gpudb::GPUdb::revokePermissionDatasource | ( | const RevokePermissionDatasourceRequest & | request_ | ) | const |
Revokes a data source permission from a user or role.
| [in] | request_ | Request object containing the parameters for the operation. |
| RevokePermissionDatasourceResponse& gpudb::GPUdb::revokePermissionDatasource | ( | const RevokePermissionDatasourceRequest & | request_, |
| RevokePermissionDatasourceResponse & | response_ | ||
| ) | const |
Revokes a data source 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. |
| RevokePermissionDatasourceResponse gpudb::GPUdb::revokePermissionDatasource | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | datasourceName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a data source permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | datasourceName | Name of the data source on which the permission will be revoked. Must be an existing data source, or an empty string to revoke permission from all data sources. |
| [in] | options | Optional parameters. The default value is an empty map. |
| RevokePermissionDatasourceResponse& gpudb::GPUdb::revokePermissionDatasource | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | datasourceName, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionDatasourceResponse & | response_ | ||
| ) | const |
Revokes a data source permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | datasourceName | Name of the data source on which the permission will be revoked. Must be an existing data source, or an empty string to revoke permission from all data sources. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionDirectoryResponse gpudb::GPUdb::revokePermissionDirectory | ( | const RevokePermissionDirectoryRequest & | request_ | ) | const |
| RevokePermissionDirectoryResponse& gpudb::GPUdb::revokePermissionDirectory | ( | const RevokePermissionDirectoryRequest & | request_, |
| RevokePermissionDirectoryResponse & | response_ | ||
| ) | const |
Revokes a KiFS directory-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. |
| RevokePermissionDirectoryResponse gpudb::GPUdb::revokePermissionDirectory | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | directoryName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a KiFS directory-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | directoryName | Name of the KiFS directory to which the permission revokes access |
| [in] | options | Optional parameters. The default value is an empty map. |
| RevokePermissionDirectoryResponse& gpudb::GPUdb::revokePermissionDirectory | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | directoryName, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionDirectoryResponse & | response_ | ||
| ) | const |
Revokes a KiFS directory-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | directoryName | Name of the KiFS directory to which the permission revokes access |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionProcResponse gpudb::GPUdb::revokePermissionProc | ( | const RevokePermissionProcRequest & | request_ | ) | const |
| RevokePermissionProcResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| RevokePermissionProcResponse& gpudb::GPUdb::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.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionSystemResponse gpudb::GPUdb::revokePermissionSystem | ( | const RevokePermissionSystemRequest & | request_ | ) | const |
| RevokePermissionSystemResponse& gpudb::GPUdb::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 gpudb::GPUdb::revokePermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a system-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| RevokePermissionSystemResponse& gpudb::GPUdb::revokePermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionSystemResponse & | response_ | ||
| ) | const |
Revokes a system-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| RevokePermissionTableResponse gpudb::GPUdb::revokePermissionTable | ( | const RevokePermissionTableRequest & | request_ | ) | const |
| RevokePermissionTableResponse& gpudb::GPUdb::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 gpudb::GPUdb::revokePermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a table-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | tableName | Name of the table to which the permission grants access, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table, view or schema. |
| [in] | options | Optional parameters.
|
| RevokePermissionTableResponse& gpudb::GPUdb::revokePermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionTableResponse & | response_ | ||
| ) | const |
Revokes a table-level permission from a user or role.
| [in] | name | Name of the user or role from which the permission will be revoked. Must be an existing user or role. |
| [in] | permission | Permission to revoke from the user or role. Supported values:
|
| [in] | tableName | Name of the table to which the permission grants access, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table, view or schema. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| RevokeRoleResponse gpudb::GPUdb::revokeRole | ( | const RevokeRoleRequest & | request_ | ) | const |
| RevokeRoleResponse& gpudb::GPUdb::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 gpudb::GPUdb::revokeRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes membership in a role from a user or role.
| [in] | role | Name of the role in which membership will be revoked. Must be an existing role. |
| [in] | member | Name of the user or role that will be revoked membership in role. Must be an existing user or role. |
| [in] | options | Optional parameters. The default value is an empty map. |
| RevokeRoleResponse& gpudb::GPUdb::revokeRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokeRoleResponse & | response_ | ||
| ) | const |
Revokes membership in a role from a user or role.
| [in] | role | Name of the role in which membership will be revoked. Must be an existing role. |
| [in] | member | Name of the user or role that will be revoked membership in role. Must be an existing user or role. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| void gpudb::GPUdb::setHASyncMode | ( | HASynchronicityMode | mode | ) |
Sets the high-availability synchronization mode which will override the default mode.
| ShowCredentialResponse gpudb::GPUdb::showCredential | ( | const ShowCredentialRequest & | request_ | ) | const |
Shows information about a specified credential or all credentials.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowCredentialResponse& gpudb::GPUdb::showCredential | ( | const ShowCredentialRequest & | request_, |
| ShowCredentialResponse & | response_ | ||
| ) | const |
Shows information about a specified credential or all credentials.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowCredentialResponse gpudb::GPUdb::showCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a specified credential or all credentials.
| [in] | credentialName | Name of the credential on which to retrieve information. The name must refer to a currently existing credential. If '*' is specified, information about all credentials will be returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowCredentialResponse& gpudb::GPUdb::showCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowCredentialResponse & | response_ | ||
| ) | const |
Shows information about a specified credential or all credentials.
| [in] | credentialName | Name of the credential on which to retrieve information. The name must refer to a currently existing credential. If '*' is specified, information about all credentials will be returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowDatasinkResponse gpudb::GPUdb::showDatasink | ( | const ShowDatasinkRequest & | request_ | ) | const |
| ShowDatasinkResponse& gpudb::GPUdb::showDatasink | ( | const ShowDatasinkRequest & | request_, |
| ShowDatasinkResponse & | response_ | ||
| ) | const |
Shows information about a specified data sink or all data sinks.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowDatasinkResponse gpudb::GPUdb::showDatasink | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a specified data sink or all data sinks.
| [in] | name | Name of the data sink for which to retrieve information. The name must refer to a currently existing data sink. If '*' is specified, information about all data sinks will be returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowDatasinkResponse& gpudb::GPUdb::showDatasink | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| ShowDatasinkResponse & | response_ | ||
| ) | const |
Shows information about a specified data sink or all data sinks.
| [in] | name | Name of the data sink for which to retrieve information. The name must refer to a currently existing data sink. If '*' is specified, information about all data sinks will be returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowDatasourceResponse gpudb::GPUdb::showDatasource | ( | const ShowDatasourceRequest & | request_ | ) | const |
Shows information about a specified data source or all data sources.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowDatasourceResponse& gpudb::GPUdb::showDatasource | ( | const ShowDatasourceRequest & | request_, |
| ShowDatasourceResponse & | response_ | ||
| ) | const |
Shows information about a specified data source or all data sources.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowDatasourceResponse gpudb::GPUdb::showDatasource | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a specified data source or all data sources.
| [in] | name | Name of the data source for which to retrieve information. The name must refer to a currently existing data source. If '*' is specified, information about all data sources will be returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowDatasourceResponse& gpudb::GPUdb::showDatasource | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| ShowDatasourceResponse & | response_ | ||
| ) | const |
Shows information about a specified data source or all data sources.
| [in] | name | Name of the data source for which to retrieve information. The name must refer to a currently existing data source. If '*' is specified, information about all data sources will be returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowDirectoriesResponse gpudb::GPUdb::showDirectories | ( | const ShowDirectoriesRequest & | request_ | ) | const |
| ShowDirectoriesResponse& gpudb::GPUdb::showDirectories | ( | const ShowDirectoriesRequest & | request_, |
| ShowDirectoriesResponse & | response_ | ||
| ) | const |
Shows information about directories in KiFS.
Can be used to show a single directory, or all directories.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowDirectoriesResponse gpudb::GPUdb::showDirectories | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about directories in KiFS.
Can be used to show a single directory, or all directories.
| [in] | directoryName | The KiFS directory name to show. If empty, shows all directories. The default value is ''. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowDirectoriesResponse& gpudb::GPUdb::showDirectories | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowDirectoriesResponse & | response_ | ||
| ) | const |
Shows information about directories in KiFS.
Can be used to show a single directory, or all directories.
| [in] | directoryName | The KiFS directory name to show. If empty, shows all directories. The default value is ''. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowEnvironmentResponse gpudb::GPUdb::showEnvironment | ( | const ShowEnvironmentRequest & | request_ | ) | const |
Shows information about a specified user-defined function (UDF) environment or all environments.
Returns detailed information about existing environments.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowEnvironmentResponse& gpudb::GPUdb::showEnvironment | ( | const ShowEnvironmentRequest & | request_, |
| ShowEnvironmentResponse & | response_ | ||
| ) | const |
Shows information about a specified user-defined function (UDF) environment or all environments.
Returns detailed information about existing environments.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowEnvironmentResponse gpudb::GPUdb::showEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a specified user-defined function (UDF) environment or all environments.
Returns detailed information about existing environments.
| [in] | environmentName | Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '*' or an empty value is specified, information about all environments will be returned. The default value is ''. |
| [in] | options | Optional parameters.
|
| ShowEnvironmentResponse& gpudb::GPUdb::showEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowEnvironmentResponse & | response_ | ||
| ) | const |
Shows information about a specified user-defined function (UDF) environment or all environments.
Returns detailed information about existing environments.
| [in] | environmentName | Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If '*' or an empty value is specified, information about all environments will be returned. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowFilesResponse gpudb::GPUdb::showFiles | ( | const ShowFilesRequest & | request_ | ) | const |
| ShowFilesResponse& gpudb::GPUdb::showFiles | ( | const ShowFilesRequest & | request_, |
| ShowFilesResponse & | response_ | ||
| ) | const |
Shows information about files in KiFS.
Can be used for individual files, or to show all files in a given directory.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowFilesResponse gpudb::GPUdb::showFiles | ( | const std::vector< std::string > & | paths, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about files in KiFS.
Can be used for individual files, or to show all files in a given directory.
| [in] | paths | File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowFilesResponse& gpudb::GPUdb::showFiles | ( | const std::vector< std::string > & | paths, |
| const std::map< std::string, std::string > & | options, | ||
| ShowFilesResponse & | response_ | ||
| ) | const |
Shows information about files in KiFS.
Can be used for individual files, or to show all files in a given directory.
| [in] | paths | File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowGraphResponse gpudb::GPUdb::showGraph | ( | const ShowGraphRequest & | request_ | ) | const |
| ShowGraphResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | graphName | Name of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ''. |
| [in] | options | Optional parameters.
|
| ShowGraphResponse& gpudb::GPUdb::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.
| [in] | graphName | Name of the graph on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowProcResponse gpudb::GPUdb::showProc | ( | const ShowProcRequest & | request_ | ) | const |
| ShowProcResponse& gpudb::GPUdb::showProc | ( | const ShowProcRequest & | request_, |
| ShowProcResponse & | response_ | ||
| ) | const |
| ShowProcResponse gpudb::GPUdb::showProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a proc.
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| ShowProcResponse& gpudb::GPUdb::showProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowProcResponse & | response_ | ||
| ) | const |
Shows information about a proc.
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowProcStatusResponse gpudb::GPUdb::showProcStatus | ( | const ShowProcStatusRequest & | request_ | ) | const |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from executeProc) 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& gpudb::GPUdb::showProcStatus | ( | const ShowProcStatusRequest & | request_, |
| ShowProcStatusResponse & | response_ | ||
| ) | const |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from executeProc) 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 gpudb::GPUdb::showProcStatus | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from executeProc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| ShowProcStatusResponse& gpudb::GPUdb::showProcStatus | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options, | ||
| ShowProcStatusResponse & | response_ | ||
| ) | const |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from executeProc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
| [in] | 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. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowResourceGroupsResponse gpudb::GPUdb::showResourceGroups | ( | const ShowResourceGroupsRequest & | request_ | ) | const |
| ShowResourceGroupsResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | names | List of names of groups to be shown. A single entry with an empty string returns all groups. |
| [in] | options | Optional parameters.
|
| ShowResourceGroupsResponse& gpudb::GPUdb::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.
| [in] | names | List of names of groups to be shown. A single entry with an empty string returns all groups. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowResourceObjectsResponse gpudb::GPUdb::showResourceObjects | ( | const ShowResourceObjectsRequest & | request_ | ) | const |
Returns information about the internal sub-components (tiered objects) which use resources of the system.
The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowResourceObjectsResponse& gpudb::GPUdb::showResourceObjects | ( | const ShowResourceObjectsRequest & | request_, |
| ShowResourceObjectsResponse & | response_ | ||
| ) | const |
Returns information about the internal sub-components (tiered objects) which use resources of the system.
The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowResourceObjectsResponse gpudb::GPUdb::showResourceObjects | ( | const std::map< std::string, std::string > & | options | ) | const |
Returns information about the internal sub-components (tiered objects) which use resources of the system.
The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
| [in] | options | Optional parameters.
|
| ShowResourceObjectsResponse& gpudb::GPUdb::showResourceObjects | ( | const std::map< std::string, std::string > & | options, |
| ShowResourceObjectsResponse & | response_ | ||
| ) | const |
Returns information about the internal sub-components (tiered objects) which use resources of the system.
The request can either return results from actively used objects (default) or it can be used to query the status of the objects of a given list of tables. Returns detailed information about the requested resource objects.
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowResourceStatisticsResponse gpudb::GPUdb::showResourceStatistics | ( | const ShowResourceStatisticsRequest & | request_ | ) | const |
| ShowResourceStatisticsResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowResourceStatisticsResponse& gpudb::GPUdb::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.
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSchemaResponse gpudb::GPUdb::showSchema | ( | const ShowSchemaRequest & | request_ | ) | const |
Retrieves information about a schema (or all schemas), as specified in schemaName.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowSchemaResponse& gpudb::GPUdb::showSchema | ( | const ShowSchemaRequest & | request_, |
| ShowSchemaResponse & | response_ | ||
| ) | const |
Retrieves information about a schema (or all schemas), as specified in schemaName.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSchemaResponse gpudb::GPUdb::showSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves information about a schema (or all schemas), as specified in schemaName.
| [in] | schemaName | Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned. |
| [in] | options | Optional parameters.
|
| ShowSchemaResponse& gpudb::GPUdb::showSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowSchemaResponse & | response_ | ||
| ) | const |
Retrieves information about a schema (or all schemas), as specified in schemaName.
| [in] | schemaName | Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowSecurityResponse gpudb::GPUdb::showSecurity | ( | const ShowSecurityRequest & | request_ | ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowSecurityResponse& gpudb::GPUdb::showSecurity | ( | const ShowSecurityRequest & | request_, |
| ShowSecurityResponse & | response_ | ||
| ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSecurityResponse gpudb::GPUdb::showSecurity | ( | const std::vector< std::string > & | names, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
| [in] | 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. |
| [in] | options | Optional parameters.
|
| ShowSecurityResponse& gpudb::GPUdb::showSecurity | ( | const std::vector< std::string > & | names, |
| const std::map< std::string, std::string > & | options, | ||
| ShowSecurityResponse & | response_ | ||
| ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
| [in] | 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. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowSqlProcResponse gpudb::GPUdb::showSqlProc | ( | const ShowSqlProcRequest & | request_ | ) | const |
| ShowSqlProcResponse& gpudb::GPUdb::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 gpudb::GPUdb::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.
| [in] | procedureName | Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''. |
| [in] | options | Optional parameters.
|
| ShowSqlProcResponse& gpudb::GPUdb::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.
| [in] | procedureName | Name of the procedure for which to retrieve the information. If blank, then information about all procedures is returned. The default value is ''. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowStatisticsResponse gpudb::GPUdb::showStatistics | ( | const ShowStatisticsRequest & | request_ | ) | const |
| ShowStatisticsResponse& gpudb::GPUdb::showStatistics | ( | const ShowStatisticsRequest & | request_, |
| ShowStatisticsResponse & | response_ | ||
| ) | const |
Retrieves the collected column statistics for the specified table(s).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowStatisticsResponse gpudb::GPUdb::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(s).
| [in] | tableNames | Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned. |
| [in] | options | Optional parameters.
|
| ShowStatisticsResponse& gpudb::GPUdb::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(s).
| [in] | tableNames | Names of tables whose metadata will be fetched, each in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowSystemPropertiesResponse gpudb::GPUdb::showSystemProperties | ( | const ShowSystemPropertiesRequest & | request_ | ) | const |
| ShowSystemPropertiesResponse& gpudb::GPUdb::showSystemProperties | ( | const ShowSystemPropertiesRequest & | request_, |
| ShowSystemPropertiesResponse & | response_ | ||
| ) | const |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSystemPropertiesResponse gpudb::GPUdb::showSystemProperties | ( | const std::map< std::string, std::string > & | options | ) | const |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| [in] | options | Optional parameters.
|
| ShowSystemPropertiesResponse& gpudb::GPUdb::showSystemProperties | ( | const std::map< std::string, std::string > & | options, |
| ShowSystemPropertiesResponse & | response_ | ||
| ) | const |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowSystemStatusResponse gpudb::GPUdb::showSystemStatus | ( | const ShowSystemStatusRequest & | request_ | ) | const |
| ShowSystemStatusResponse& gpudb::GPUdb::showSystemStatus | ( | const ShowSystemStatusRequest & | request_, |
| ShowSystemStatusResponse & | response_ | ||
| ) | const |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSystemStatusResponse gpudb::GPUdb::showSystemStatus | ( | const std::map< std::string, std::string > & | options | ) | const |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| [in] | options | Optional parameters, currently unused. The default value is an empty map. |
| ShowSystemStatusResponse& gpudb::GPUdb::showSystemStatus | ( | const std::map< std::string, std::string > & | options, |
| ShowSystemStatusResponse & | response_ | ||
| ) | const |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
| [in] | options | Optional parameters, currently unused. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSystemTimingResponse gpudb::GPUdb::showSystemTiming | ( | const ShowSystemTimingRequest & | request_ | ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowSystemTimingResponse& gpudb::GPUdb::showSystemTiming | ( | const ShowSystemTimingRequest & | request_, |
| ShowSystemTimingResponse & | response_ | ||
| ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowSystemTimingResponse gpudb::GPUdb::showSystemTiming | ( | const std::map< std::string, std::string > & | options | ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
| [in] | options | Optional parameters, currently unused. The default value is an empty map. |
| ShowSystemTimingResponse& gpudb::GPUdb::showSystemTiming | ( | const std::map< std::string, std::string > & | options, |
| ShowSystemTimingResponse & | response_ | ||
| ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
| [in] | options | Optional parameters, currently unused. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTableResponse gpudb::GPUdb::showTable | ( | const ShowTableRequest & | request_ | ) | const |
Retrieves detailed information about a table, view, or schema, specified in tableName.
If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName is empty, information about all schemas will 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 schema, setting the show_children option to false returns only information about the schema itself; setting show_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.
To retrieve a list of every table, view, and schema in the database, set tableName to '*' and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowTableResponse& gpudb::GPUdb::showTable | ( | const ShowTableRequest & | request_, |
| ShowTableResponse & | response_ | ||
| ) | const |
Retrieves detailed information about a table, view, or schema, specified in tableName.
If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName is empty, information about all schemas will 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 schema, setting the show_children option to false returns only information about the schema itself; setting show_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.
To retrieve a list of every table, view, and schema in the database, set tableName to '*' and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTableResponse gpudb::GPUdb::showTable | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves detailed information about a table, view, or schema, specified in tableName.
If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName is empty, information about all schemas will 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 schema, setting the show_children option to false returns only information about the schema itself; setting show_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.
To retrieve a list of every table, view, and schema in the database, set tableName to '*' and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).
| [in] | tableName | Name of the table for which to retrieve the information, in [schema_name.]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views. |
| [in] | options | Optional parameters.
|
| ShowTableResponse& gpudb::GPUdb::showTable | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowTableResponse & | response_ | ||
| ) | const |
Retrieves detailed information about a table, view, or schema, specified in tableName.
If the supplied tableName is a schema the call can return information about either the schema itself or the tables and views it contains. If tableName is empty, information about all schemas will 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 schema, setting the show_children option to false returns only information about the schema itself; setting show_children to true returns a list of tables and views contained in the schema, along with their corresponding detail.
To retrieve a list of every table, view, and schema in the database, set tableName to '*' and show_children to true. When doing this, the returned totalSize and totalFullSize will not include the sizes of non-base tables (e.g., filters, views, joins, etc.).
| [in] | tableName | Name of the table for which to retrieve the information, in [schema_name.]table_name format, using standard name resolution rules. If blank, then returns information about all tables and views. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowTableMetadataResponse gpudb::GPUdb::showTableMetadata | ( | const ShowTableMetadataRequest & | request_ | ) | const |
| ShowTableMetadataResponse& gpudb::GPUdb::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 gpudb::GPUdb::showTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the user provided metadata for the specified tables.
| [in] | tableNames | Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowTableMetadataResponse& gpudb::GPUdb::showTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options, | ||
| ShowTableMetadataResponse & | response_ | ||
| ) | const |
Retrieves the user provided metadata for the specified tables.
| [in] | tableNames | Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTableMonitorsResponse gpudb::GPUdb::showTableMonitors | ( | const ShowTableMonitorsRequest & | request_ | ) | const |
Show table monitors and their properties.
Table monitors are created using createTableMonitor. Returns detailed information about existing table monitors.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowTableMonitorsResponse& gpudb::GPUdb::showTableMonitors | ( | const ShowTableMonitorsRequest & | request_, |
| ShowTableMonitorsResponse & | response_ | ||
| ) | const |
Show table monitors and their properties.
Table monitors are created using createTableMonitor. Returns detailed information about existing table monitors.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTableMonitorsResponse gpudb::GPUdb::showTableMonitors | ( | const std::vector< std::string > & | monitorIds, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Show table monitors and their properties.
Table monitors are created using createTableMonitor. Returns detailed information about existing table monitors.
| [in] | monitorIds | List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowTableMonitorsResponse& gpudb::GPUdb::showTableMonitors | ( | const std::vector< std::string > & | monitorIds, |
| const std::map< std::string, std::string > & | options, | ||
| ShowTableMonitorsResponse & | response_ | ||
| ) | const |
Show table monitors and their properties.
Table monitors are created using createTableMonitor. Returns detailed information about existing table monitors.
| [in] | monitorIds | List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTablesByTypeResponse gpudb::GPUdb::showTablesByType | ( | const ShowTablesByTypeRequest & | request_ | ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowTablesByTypeResponse& gpudb::GPUdb::showTablesByType | ( | const ShowTablesByTypeRequest & | request_, |
| ShowTablesByTypeResponse & | response_ | ||
| ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTablesByTypeResponse gpudb::GPUdb::showTablesByType | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
| [in] | typeId | Type id returned by a call to createType. |
| [in] | label | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowTablesByTypeResponse& gpudb::GPUdb::showTablesByType | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options, | ||
| ShowTablesByTypeResponse & | response_ | ||
| ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
| [in] | typeId | Type id returned by a call to createType. |
| [in] | label | Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTriggersResponse gpudb::GPUdb::showTriggers | ( | const ShowTriggersRequest & | request_ | ) | const |
| ShowTriggersResponse& gpudb::GPUdb::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 gpudb::GPUdb::showTriggers | ( | const std::vector< std::string > & | triggerIds, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| ShowTriggersResponse& gpudb::GPUdb::showTriggers | ( | const std::vector< std::string > & | triggerIds, |
| const std::map< std::string, std::string > & | options, | ||
| ShowTriggersResponse & | response_ | ||
| ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
| [in] | 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. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTypesResponse gpudb::GPUdb::showTypes | ( | const ShowTypesRequest & | request_ | ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
| [in] | request_ | Request object containing the parameters for the operation. |
| ShowTypesResponse& gpudb::GPUdb::showTypes | ( | const ShowTypesRequest & | request_, |
| ShowTypesResponse & | response_ | ||
| ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowTypesResponse gpudb::GPUdb::showTypes | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
| [in] | typeId | Type Id returned in response to a call to createType. |
| [in] | label | Option string that was supplied by user in a call to createType. |
| [in] | options | Optional parameters.
|
| ShowTypesResponse& gpudb::GPUdb::showTypes | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options, | ||
| ShowTypesResponse & | response_ | ||
| ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
| [in] | typeId | Type Id returned in response to a call to createType. |
| [in] | label | Option string that was supplied by user in a call to createType. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| ShowVideoResponse gpudb::GPUdb::showVideo | ( | const ShowVideoRequest & | request_ | ) | const |
| ShowVideoResponse& gpudb::GPUdb::showVideo | ( | const ShowVideoRequest & | request_, |
| ShowVideoResponse & | response_ | ||
| ) | const |
| ShowVideoResponse gpudb::GPUdb::showVideo | ( | const std::vector< std::string > & | paths, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
| ShowVideoResponse& gpudb::GPUdb::showVideo | ( | const std::vector< std::string > & | paths, |
| const std::map< std::string, std::string > & | options, | ||
| ShowVideoResponse & | response_ | ||
| ) | const |
Retrieves information about rendered videos.
| [in] | paths | The fully-qualified KiFS paths for the videos to show. If empty, shows all videos. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowWalResponse gpudb::GPUdb::showWal | ( | const ShowWalRequest & | request_ | ) | const |
| ShowWalResponse& gpudb::GPUdb::showWal | ( | const ShowWalRequest & | request_, |
| ShowWalResponse & | response_ | ||
| ) | const |
Requests table wal properties.
Returns information about the requested table wal entries.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| ShowWalResponse gpudb::GPUdb::showWal | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Requests table wal properties.
Returns information about the requested table wal entries.
| [in] | tableNames | List of tables to query. An asterisk returns all tables. |
| [in] | options | Optional parameters.
|
| ShowWalResponse& gpudb::GPUdb::showWal | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options, | ||
| ShowWalResponse & | response_ | ||
| ) | const |
Requests table wal properties.
Returns information about the requested table wal entries.
| [in] | tableNames | List of tables to query. An asterisk returns all tables. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| SolveGraphResponse gpudb::GPUdb::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 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& gpudb::GPUdb::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 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 gpudb::GPUdb::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 Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to solve. |
| [in] | 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. The default value is an empty vector. |
| [in] | 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 option is set to true, any provided restrictions will replace the existing restrictions. Otherwise, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED'). The default value is an empty vector. |
| [in] | solverType | The type of solver to use for the graph. Supported values:
|
| [in] | 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. The default value is an empty vector. |
| [in] | 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. The default value is an empty vector. |
| [in] | solutionTable | Name of the table to store the solution, in [schema_name.]table_name format, using standard name resolution rules. The default value is 'graph_solutions'. |
| [in] | options | Additional parameters.
|
| SolveGraphResponse& gpudb::GPUdb::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 Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
| [in] | graphName | Name of the graph resource to solve. |
| [in] | 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. The default value is an empty vector. |
| [in] | 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 option is set to true, any provided restrictions will replace the existing restrictions. Otherwise, any provided restrictions will be added (in the case of 'RESTRICTIONS_VALUECOMPARED') to or replaced (in the case of 'RESTRICTIONS_ONOFFCOMPARED'). The default value is an empty vector. |
| [in] | solverType | The type of solver to use for the graph. Supported values:
|
| [in] | 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. The default value is an empty vector. |
| [in] | 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. The default value is an empty vector. |
| [in] | solutionTable | Name of the table to store the solution, in [schema_name.]table_name format, using standard name resolution rules. The default value is 'graph_solutions'. |
| [in] | options | Additional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
|
inline |
|
inline |
|
inline |
|
inline |
Submit an HTTP request to the host manager.
| [in] | endpoint | The endpoint for which the request is made. |
| [in] | request | The request object containing the parameters for the operation. |
| [out] | response | The response object in which the return values will be saved. |
| [in] | enableCompression | Optional boolean flag indicating whether any compression should be used. Default is false. |
|
inline |
Submit an HTTP request to the host manager.
| [in] | endpoint | The endpoint for which the request is made. |
| [in] | request | The request object containing the parameters for the operation. |
| [out] | response | The response object in which the return values will be saved. |
| [in] | enableCompression | Optional boolean flag indicating whether any compression should be used. Default is false. |
| void gpudb::GPUdb::updateHostManagerPort | ( | ) |
Update the host manager port by inquiring the server.
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
The update_on_existing_pk option specifies the record primary key collision policy for tables with a primary key, while ignore_existing_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.
| TRequest | The type of object being added. |
| [in] | request_ | Request object containing the parameters for the operation. |
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
The update_on_existing_pk option specifies the record primary key collision policy for tables with a primary key, while ignore_existing_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are 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. |
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
The update_on_existing_pk option specifies the record primary key collision policy for tables with a primary key, while ignore_existing_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.
| TRequest | The type of object being added. |
| [in] | tableName | Name of table to be updated, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table and not a view. |
| [in] | expressions | A list of the actual predicates, one for each update; format should follow the guidelines here. |
| [in] | 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. |
| [in] | 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. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
|
inline |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
The update_on_existing_pk option specifies the record primary key collision policy for tables with a primary key, while ignore_existing_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.
| TRequest | The type of object being added. |
| [in] | tableName | Name of table to be updated, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table and not a view. |
| [in] | expressions | A list of the actual predicates, one for each update; format should follow the guidelines here. |
| [in] | 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. |
| [in] | 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. The default value is an empty vector. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| UpdateRecordsBySeriesResponse gpudb::GPUdb::updateRecordsBySeries | ( | const UpdateRecordsBySeriesRequest & | request_ | ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
| [in] | request_ | Request object containing the parameters for the operation. |
| UpdateRecordsBySeriesResponse& gpudb::GPUdb::updateRecordsBySeries | ( | const UpdateRecordsBySeriesRequest & | request_, |
| UpdateRecordsBySeriesResponse & | response_ | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| UpdateRecordsBySeriesResponse gpudb::GPUdb::updateRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const std::string & | viewName, | ||
| const std::vector< std::string > & | reserved, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
| [in] | tableName | Name of the view on which the update operation will be performed, in [schema_name.]view_name format, using standard name resolution rules. Must be an existing view. |
| [in] | worldTableName | Name of the table containing the complete series (track) information, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | viewName | Name of the view containing the series (tracks) which have to be updated, in [schema_name.]view_name format, using standard name resolution rules. The default value is ''. |
| [in] | reserved | The default value is an empty vector. |
| [in] | options | Optional parameters. The default value is an empty map. |
| UpdateRecordsBySeriesResponse& gpudb::GPUdb::updateRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const std::string & | viewName, | ||
| const std::vector< std::string > & | reserved, | ||
| const std::map< std::string, std::string > & | options, | ||
| UpdateRecordsBySeriesResponse & | response_ | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
| [in] | tableName | Name of the view on which the update operation will be performed, in [schema_name.]view_name format, using standard name resolution rules. Must be an existing view. |
| [in] | worldTableName | Name of the table containing the complete series (track) information, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | viewName | Name of the view containing the series (tracks) which have to be updated, in [schema_name.]view_name format, using standard name resolution rules. The default value is ''. |
| [in] | reserved | The default value is an empty vector. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| UpdateRecordsResponse gpudb::GPUdb::updateRecordsRaw | ( | const RawUpdateRecordsRequest & | request_ | ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
The update_on_existing_pk option specifies the record primary key collision policy for tables with a primary key, while ignore_existing_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.
| [in] | request_ | Request object containing the parameters for the operation. |
| UpdateRecordsResponse& gpudb::GPUdb::updateRecordsRaw | ( | const RawUpdateRecordsRequest & | request_, |
| UpdateRecordsResponse & | response_ | ||
| ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
The update_on_existing_pk option specifies the record primary key collision policy for tables with a primary key, while ignore_existing_pk specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are 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. |
| UploadFilesResponse gpudb::GPUdb::uploadFiles | ( | const UploadFilesRequest & | request_ | ) | const |
Uploads one or more files to KiFS.
There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommeded for files of approximately 60 MB or larger.
To upload files in their entirety, populate fileNames with the file names to upload into on KiFS, and their respective byte content in fileData.
Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:
Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.
The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in showFiles.
File data may be pre-encoded using base64 encoding. This should be indicated using the file_encoding option, and is recommended when using JSON serialization.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | request_ | Request object containing the parameters for the operation. |
| UploadFilesResponse& gpudb::GPUdb::uploadFiles | ( | const UploadFilesRequest & | request_, |
| UploadFilesResponse & | response_ | ||
| ) | const |
Uploads one or more files to KiFS.
There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommeded for files of approximately 60 MB or larger.
To upload files in their entirety, populate fileNames with the file names to upload into on KiFS, and their respective byte content in fileData.
Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:
Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.
The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in showFiles.
File data may be pre-encoded using base64 encoding. This should be indicated using the file_encoding option, and is recommended when using JSON serialization.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| UploadFilesResponse gpudb::GPUdb::uploadFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::vector< std::vector< uint8_t > > & | fileData, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Uploads one or more files to KiFS.
There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommeded for files of approximately 60 MB or larger.
To upload files in their entirety, populate fileNames with the file names to upload into on KiFS, and their respective byte content in fileData.
Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:
Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.
The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in showFiles.
File data may be pre-encoded using base64 encoding. This should be indicated using the file_encoding option, and is recommended when using JSON serialization.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | fileNames | An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters. |
| [in] | fileData | File data for the files being uploaded, for the respective files in fileNames. |
| [in] | options | Optional parameters.
|
| UploadFilesResponse& gpudb::GPUdb::uploadFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::vector< std::vector< uint8_t > > & | fileData, | ||
| const std::map< std::string, std::string > & | options, | ||
| UploadFilesResponse & | response_ | ||
| ) | const |
Uploads one or more files to KiFS.
There are two methods for uploading files: load files in their entirety, or load files in parts. The latter is recommeded for files of approximately 60 MB or larger.
To upload files in their entirety, populate fileNames with the file names to upload into on KiFS, and their respective byte content in fileData.
Multiple steps are involved when uploading in multiple parts. Only one file at a time can be uploaded in this manner. A user-provided UUID is utilized to tie all the upload steps together for a given file. To upload a file in multiple parts:
Multipart uploads in progress may be canceled by providing the file name, the UUID, and a multipart_operation value of cancel. If an new upload is initialized with a different UUID for an existing upload in progress, the pre-existing upload is automatically canceled in favor of the new upload.
The multipart upload must be completed for the file to be usable in KiFS. Information about multipart uploads in progress is available in showFiles.
File data may be pre-encoded using base64 encoding. This should be indicated using the file_encoding option, and is recommended when using JSON serialization.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | fileNames | An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters. |
| [in] | fileData | File data for the files being uploaded, for the respective files in fileNames. |
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| UploadFilesFromurlResponse gpudb::GPUdb::uploadFilesFromurl | ( | const UploadFilesFromurlRequest & | request_ | ) | const |
Uploads one or more files to KiFS.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | request_ | Request object containing the parameters for the operation. |
| UploadFilesFromurlResponse& gpudb::GPUdb::uploadFilesFromurl | ( | const UploadFilesFromurlRequest & | request_, |
| UploadFilesFromurlResponse & | response_ | ||
| ) | const |
Uploads one or more files to KiFS.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| UploadFilesFromurlResponse gpudb::GPUdb::uploadFilesFromurl | ( | const std::vector< std::string > & | fileNames, |
| const std::vector< std::string > & | urls, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Uploads one or more files to KiFS.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | fileNames | An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters. |
| [in] | urls | List of URLs to upload, for each respective file in fileNames. |
| [in] | options | Optional parameters. The default value is an empty map. |
| UploadFilesFromurlResponse& gpudb::GPUdb::uploadFilesFromurl | ( | const std::vector< std::string > & | fileNames, |
| const std::vector< std::string > & | urls, | ||
| const std::map< std::string, std::string > & | options, | ||
| UploadFilesFromurlResponse & | response_ | ||
| ) | const |
Uploads one or more files to KiFS.
Each file path must reside in a top-level KiFS directory, i.e. one of the directories listed in showDirectories. The user must have write permission on the directory. Nested directories are permitted in file name paths. Directories are deliniated with the directory separator of '/'. For example, given the file path '/a/b/c/d.txt', 'a' must be a KiFS directory.
These characters are allowed in file name paths: letters, numbers, spaces, the path delimiter of '/', and the characters: '.' '-' ':' '[' ']' '(' ')' '#' '='.
| [in] | fileNames | An array of full file name paths to be used for the files uploaded to KiFS. File names may have any number of nested directories in their paths, but the top-level directory must be an existing KiFS directory. Each file must reside in or under a top-level directory. A full file name path cannot be larger than 1024 characters. |
| [in] | urls | List of URLs to upload, for each respective file in fileNames. |
| [in] | options | Optional parameters. The default value is an empty map. |
| [out] | response_ | Response object containing the results of the operation. |
| VisualizeImageChartResponse gpudb::GPUdb::visualizeImageChart | ( | const VisualizeImageChartRequest & | request_ | ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
| [in] | request_ | Request object containing the parameters for the operation. |
| VisualizeImageChartResponse& gpudb::GPUdb::visualizeImageChart | ( | const VisualizeImageChartRequest & | request_, |
| VisualizeImageChartResponse & | response_ | ||
| ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
| [in] | request_ | Request object containing the parameters for the operation. |
| [out] | response_ | Response object containing the results of the operation. |
| VisualizeImageChartResponse gpudb::GPUdb::visualizeImageChart | ( | const std::string & | tableName, |
| const std::vector< std::string > & | xColumnNames, | ||
| const std::vector< std::string > & | yColumnNames, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const int32_t | width, | ||
| const int32_t | height, | ||
| const std::string & | bgColor, | ||
| const std::map< std::string, std::vector< std::string > > & | styleOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
| [in] | tableName | Name of the table containing the data to be drawn as a chart, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | xColumnNames | Names of the columns containing the data mapped to the x axis of a chart. |
| [in] | yColumnNames | Names of the columns containing the data mapped to the y axis of a chart. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | width | Width of the generated image in pixels. |
| [in] | height | Height of the generated image in pixels. |
| [in] | bgColor | Background color of the generated image. |
| [in] | styleOptions | Rendering style options for a chart.
|
| [in] | options | Optional parameters.
|
| VisualizeImageChartResponse& gpudb::GPUdb::visualizeImageChart | ( | const std::string & | tableName, |
| const std::vector< std::string > & | xColumnNames, | ||
| const std::vector< std::string > & | yColumnNames, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const int32_t | width, | ||
| const int32_t | height, | ||
| const std::string & | bgColor, | ||
| const std::map< std::string, std::vector< std::string > > & | styleOptions, | ||
| const std::map< std::string, std::string > & | options, | ||
| VisualizeImageChartResponse & | response_ | ||
| ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
| [in] | tableName | Name of the table containing the data to be drawn as a chart, in [schema_name.]table_name format, using standard name resolution rules. |
| [in] | xColumnNames | Names of the columns containing the data mapped to the x axis of a chart. |
| [in] | yColumnNames | Names of the columns containing the data mapped to the y axis of a chart. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | 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. |
| [in] | width | Width of the generated image in pixels. |
| [in] | height | Height of the generated image in pixels. |
| [in] | bgColor | Background color of the generated image. |
| [in] | styleOptions | Rendering style options for a chart.
|
| [in] | options | Optional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
| VisualizeIsochroneResponse gpudb::GPUdb::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 Graphs & Solvers for more information on graphs.
| [in] | request_ | Request object containing the parameters for the operation. |
| VisualizeIsochroneResponse& gpudb::GPUdb::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 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 gpudb::GPUdb::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 Graphs & Solvers for more information on graphs.
| [in] | graphName | Name of the graph on which the isochrone is to be computed. |
| [in] | sourceNode | Starting vertex on the underlying graph from/to which the isochrones are created. |
| [in] | maxSolutionRadius | Extent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius. The default value is -1.0. |
| [in] | 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). The default value is an empty vector. |
| [in] | 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'). The default value is an empty vector. |
| [in] | numLevels | Number of equally-separated isochrones to compute. The default value is 1. |
| [in] | generateImage | If set to true, generates a PNG image of the isochrones in the response. Supported values:
|
| [in] | levelsTable | Name of the table to output the isochrones to, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ''. |
| [in] | styleOptions | Various style related options of the isochrone image.
|
| [in] | solveOptions | Solver specific parameters.
|
| [in] | contourOptions | Solver specific parameters.
|
| [in] | options | Additional parameters.
|
| VisualizeIsochroneResponse& gpudb::GPUdb::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 Graphs & Solvers for more information on graphs.
| [in] | graphName | Name of the graph on which the isochrone is to be computed. |
| [in] | sourceNode | Starting vertex on the underlying graph from/to which the isochrones are created. |
| [in] | maxSolutionRadius | Extent of the search radius around sourceNode. Set to '-1.0' for unrestricted search radius. The default value is -1.0. |
| [in] | 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). The default value is an empty vector. |
| [in] | 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'). The default value is an empty vector. |
| [in] | numLevels | Number of equally-separated isochrones to compute. The default value is 1. |
| [in] | generateImage | If set to true, generates a PNG image of the isochrones in the response. Supported values:
|
| [in] | levelsTable | Name of the table to output the isochrones to, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ''. |
| [in] | styleOptions | Various style related options of the isochrone image.
|
| [in] | solveOptions | Solver specific parameters.
|
| [in] | contourOptions | Solver specific parameters.
|
| [in] | options | Additional parameters.
|
| [out] | response_ | Response object containing the results of the operation. |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
1.8.15