GPUdbFunctions.hpp File Reference
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Functions | |
| 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... | |
Function Documentation
◆ adminAddHost() [1/4]
| AdminAddHostResponse adminAddHost | ( | const AdminAddHostRequest & | request_ | ) | const |
◆ adminAddHost() [2/4]
| AdminAddHostResponse& adminAddHost | ( | const AdminAddHostRequest & | request_, |
| AdminAddHostResponse & | response_ | ||
| ) | const |
Adds a host to an existing cluster.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAddHost() [3/4]
| AdminAddHostResponse adminAddHost | ( | const std::string & | hostAddress, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Adds a host to an existing cluster.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_add_host_dry_run: If set to true, only validation checks will be performed. No host is added. Supported values: The default value is admin_add_host_false.
- admin_add_host_accepts_failover: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: The default value is admin_add_host_false.
- admin_add_host_public_address: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
- admin_add_host_host_manager_public_url: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
- admin_add_host_ram_limit: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if ram_limit is set to 10M, the resulting RAM limit is 10 million bytes. Set ram_limit to -1 to have no RAM limit.
- admin_add_host_gpus: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.
- Returns
- Response object containing the result of the operation.
◆ adminAddHost() [4/4]
| AdminAddHostResponse& adminAddHost | ( | const std::string & | hostAddress, |
| const std::map< std::string, std::string > & | options, | ||
| AdminAddHostResponse & | response_ | ||
| ) | const |
Adds a host to an existing cluster.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_add_host_dry_run: If set to true, only validation checks will be performed. No host is added. Supported values: The default value is admin_add_host_false.
- admin_add_host_accepts_failover: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: The default value is admin_add_host_false.
- admin_add_host_public_address: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
- admin_add_host_host_manager_public_url: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
- admin_add_host_ram_limit: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if ram_limit is set to 10M, the resulting RAM limit is 10 million bytes. Set ram_limit to -1 to have no RAM limit.
- admin_add_host_gpus: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAddRanks() [1/4]
| AdminAddRanksResponse 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:
- hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
- configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"rank.gpu":"1"}'
This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminAddRanks() [2/4]
| AdminAddRanksResponse& 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:
- hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
- configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"rank.gpu":"1"}'
This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAddRanks() [3/4]
| 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.
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:
- hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
- configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"rank.gpu":"1"}'
This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_add_ranks_dry_run: If true, only validation checks will be performed. No ranks are added. Supported values: The default value is admin_add_ranks_false.
- Returns
- Response object containing the result of the operation.
◆ adminAddRanks() [4/4]
| 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.
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:
- hosts would be an array including 172.123.45.67 in the first two indices (signifying two ranks being added to host 172.123.45.67) and 172.123.45.68 in the last index (signifying one rank being added to host 172.123.45.67)
- configParams would be an array of maps, with each map corresponding to the ranks being added in hosts. The key of each map would be the configuration parameter name and the value would be the parameter's value, e.g. '{"rank.gpu":"1"}'
This endpoint's processing includes copying all replicated table data to the new rank(s) and therefore could take a long time. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via createJob.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_add_ranks_dry_run: If true, only validation checks will be performed. No ranks are added. Supported values: The default value is admin_add_ranks_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAlterHost() [1/4]
| AdminAlterHostResponse adminAlterHost | ( | const AdminAlterHostRequest & | request_ | ) | const |
◆ adminAlterHost() [2/4]
| AdminAlterHostResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAlterHost() [3/4]
| AdminAlterHostResponse 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.
- Parameters
-
[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. - admin_alter_host_accepts_failover: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: The default value is admin_alter_host_false.
- Returns
- Response object containing the result of the operation.
◆ adminAlterHost() [4/4]
| 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.
Currently, the only property that can be altered is a hosts ability to accept failover processes.
- Parameters
-
[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. - admin_alter_host_accepts_failover: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: The default value is admin_alter_host_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAlterJobs() [1/4]
| AdminAlterJobsResponse adminAlterJobs | ( | const AdminAlterJobsRequest & | request_ | ) | const |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminAlterJobs() [2/4]
| AdminAlterJobsResponse& adminAlterJobs | ( | const AdminAlterJobsRequest & | request_, |
| AdminAlterJobsResponse & | response_ | ||
| ) | const |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminAlterJobs() [3/4]
| AdminAlterJobsResponse adminAlterJobs | ( | const std::vector< int64_t > & | jobIds, |
| const std::string & | action, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
- Parameters
-
[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. - admin_alter_jobs_job_tag: Job tag returned in call to create the job
- Returns
- Response object containing the result of the operation.
◆ adminAlterJobs() [4/4]
| AdminAlterJobsResponse& adminAlterJobs | ( | const std::vector< int64_t > & | jobIds, |
| const std::string & | action, | ||
| const std::map< std::string, std::string > & | options, | ||
| AdminAlterJobsResponse & | response_ | ||
| ) | const |
Perform the requested action on a list of one or more job(s).
Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
- Parameters
-
[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. - admin_alter_jobs_job_tag: Job tag returned in call to create the job
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminBackupBegin() [1/4]
| 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.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminBackupBegin() [2/4]
| 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.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminBackupBegin() [3/4]
| 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.
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.
- Parameters
-
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ adminBackupBegin() [4/4]
| 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.
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.
- Parameters
-
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminBackupEnd() [1/4]
| AdminBackupEndResponse adminBackupEnd | ( | const AdminBackupEndRequest & | request_ | ) | const |
◆ adminBackupEnd() [2/4]
| 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminBackupEnd() [3/4]
| 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.
- Parameters
-
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ adminBackupEnd() [4/4]
| 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.
- Parameters
-
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminHaRefresh() [1/4]
| AdminHaRefreshResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminHaRefresh() [2/4]
| 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.
Additionally the cluster is put into read-only while HA is restarting.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminHaRefresh() [3/4]
| 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.
Additionally the cluster is put into read-only while HA is restarting.
- Parameters
-
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ adminHaRefresh() [4/4]
| 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.
Additionally the cluster is put into read-only while HA is restarting.
- Parameters
-
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminOffline() [1/4]
| AdminOfflineResponse adminOffline | ( | const AdminOfflineRequest & | request_ | ) | const |
◆ adminOffline() [2/4]
| AdminOfflineResponse& adminOffline | ( | const AdminOfflineRequest & | request_, |
| AdminOfflineResponse & | response_ | ||
| ) | const |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminOffline() [3/4]
| AdminOfflineResponse adminOffline | ( | const bool | offline, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
- Parameters
-
[in] offline Set to true if desired state is offline. Supported values: - true
- false
[in] options Optional parameters. - admin_offline_flush_to_disk: Flush to disk when going offline. Supported values:
- Returns
- Response object containing the result of the operation.
◆ adminOffline() [4/4]
| AdminOfflineResponse& adminOffline | ( | const bool | offline, |
| const std::map< std::string, std::string > & | options, | ||
| AdminOfflineResponse & | response_ | ||
| ) | const |
Take the system offline.
When the system is offline, no user operations can be performed with the exception of a system shutdown.
- Parameters
-
[in] offline Set to true if desired state is offline. Supported values: - true
- false
[in] options Optional parameters. - admin_offline_flush_to_disk: Flush to disk when going offline. Supported values:
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRebalance() [1/4]
| 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.
The database must be offline for this operation, see adminOffline
- If adminRebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank
- If adminRebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminRebalance() [2/4]
| 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.
The database must be offline for this operation, see adminOffline
- If adminRebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank
- If adminRebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRebalance() [3/4]
| 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.
The database must be offline for this operation, see adminOffline
- If adminRebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank
- If adminRebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank
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.
- Parameters
-
[in] options Optional parameters. - admin_rebalance_rebalance_sharded_data: If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_rebalance_true.
- admin_rebalance_rebalance_unsharded_data: If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_rebalance_true.
- admin_rebalance_table_includes: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_excludes. This parameter is ignored if rebalance_unsharded_data is false.
- admin_rebalance_table_excludes: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_includes. This parameter is ignored if rebalance_unsharded_data is false.
- admin_rebalance_aggressiveness: Influences how much data is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
- admin_rebalance_compact_after_rebalance: Perform compaction of deleted records once the rebalance completes to reclaim memory and disk space. Default is true, unless repair_incorrectly_sharded_data is set to true. Supported values: The default value is admin_rebalance_true.
- admin_rebalance_compact_only: If set to true, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values: The default value is admin_rebalance_false.
- admin_rebalance_repair_incorrectly_sharded_data: Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if adminVerifyDb reports an error in sharding alignment. This can be done as part of a typical rebalance after expanding the cluster or in a standalone fashion when it is believed that data is sharded incorrectly somewhere in the cluster. Compaction will not be performed by default when this is enabled. If this option is set to true, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values: The default value is admin_rebalance_false.
- Returns
- Response object containing the result of the operation.
◆ adminRebalance() [4/4]
| 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.
The database must be offline for this operation, see adminOffline
- If adminRebalance is invoked after a change is made to the cluster, e.g., a host was added or removed, sharded data will be evenly redistributed across the cluster by number of shards per rank while unsharded data will be redistributed across the cluster by data size per rank
- If adminRebalance is invoked at some point when unsharded data (a.k.a. randomly-sharded) in the cluster is unevenly distributed over time, sharded data will not move while unsharded data will be redistributed across the cluster by data size per rank
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.
- Parameters
-
[in] options Optional parameters. - admin_rebalance_rebalance_sharded_data: If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_rebalance_true.
- admin_rebalance_rebalance_unsharded_data: If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_rebalance_true.
- admin_rebalance_table_includes: Comma-separated list of unsharded table names to rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_excludes. This parameter is ignored if rebalance_unsharded_data is false.
- admin_rebalance_table_excludes: Comma-separated list of unsharded table names to not rebalance. Not applicable to sharded tables because they are always rebalanced. Cannot be used simultaneously with table_includes. This parameter is ignored if rebalance_unsharded_data is false.
- admin_rebalance_aggressiveness: Influences how much data is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
- admin_rebalance_compact_after_rebalance: Perform compaction of deleted records once the rebalance completes to reclaim memory and disk space. Default is true, unless repair_incorrectly_sharded_data is set to true. Supported values: The default value is admin_rebalance_true.
- admin_rebalance_compact_only: If set to true, ignore rebalance options and attempt to perform compaction of deleted records to reclaim memory and disk space without rebalancing first. Supported values: The default value is admin_rebalance_false.
- admin_rebalance_repair_incorrectly_sharded_data: Scans for any data sharded incorrectly and re-routes the data to the correct location. Only necessary if adminVerifyDb reports an error in sharding alignment. This can be done as part of a typical rebalance after expanding the cluster or in a standalone fashion when it is believed that data is sharded incorrectly somewhere in the cluster. Compaction will not be performed by default when this is enabled. If this option is set to true, the time necessary to rebalance and the memory used by the rebalance may increase. Supported values: The default value is admin_rebalance_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRemoveHost() [1/4]
| AdminRemoveHostResponse 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminRemoveHost() [2/4]
| AdminRemoveHostResponse& 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRemoveHost() [3/4]
| AdminRemoveHostResponse 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_remove_host_dry_run: If set to true, only validation checks will be performed. No host is removed. Supported values: The default value is admin_remove_host_false.
- Returns
- Response object containing the result of the operation.
◆ adminRemoveHost() [4/4]
| AdminRemoveHostResponse& 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_remove_host_dry_run: If set to true, only validation checks will be performed. No host is removed. Supported values: The default value is admin_remove_host_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRemoveRanks() [1/4]
| AdminRemoveRanksResponse 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminRemoveRanks() [2/4]
| AdminRemoveRanksResponse& 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRemoveRanks() [3/4]
| 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.
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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_remove_ranks_rebalance_sharded_data: If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_remove_ranks_true.
- admin_remove_ranks_rebalance_unsharded_data: If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_remove_ranks_true.
- admin_remove_ranks_aggressiveness: Influences how much data is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
- Returns
- Response object containing the result of the operation.
◆ adminRemoveRanks() [4/4]
| 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.
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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_remove_ranks_rebalance_sharded_data: If true, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_remove_ranks_true.
- admin_remove_ranks_rebalance_unsharded_data: If true, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values: The default value is admin_remove_ranks_true.
- admin_remove_ranks_aggressiveness: Influences how much data is moved at a time during rebalance. A higher aggressiveness will complete the rebalance faster. A lower aggressiveness will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRepairTable() [1/4]
| AdminRepairTableResponse adminRepairTable | ( | const AdminRepairTableRequest & | request_ | ) | const |
◆ adminRepairTable() [2/4]
| AdminRepairTableResponse& adminRepairTable | ( | const AdminRepairTableRequest & | request_, |
| AdminRepairTableResponse & | response_ | ||
| ) | const |
Manually repair a corrupted table.
Returns information about affected tables.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminRepairTable() [3/4]
| AdminRepairTableResponse 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.
- Parameters
-
[in] tableNames List of tables to query. An asterisk returns all tables. [in] options Optional parameters. -
admin_repair_table_repair_policy: Corrective action to take. Supported values:
- admin_repair_table_delete_chunks: Deletes any corrupted chunks
- admin_repair_table_shrink_columns: Shrinks corrupted chunks to the shortest column
- admin_repair_table_replay_wal: Manually invokes wal replay on the table
- admin_repair_table_verify_all: If false only table chunk data already known to be corrupted will be repaired. Otherwise the database will perform a full table scan to check for correctness. Supported values: The default value is admin_repair_table_false.
-
admin_repair_table_repair_policy: Corrective action to take. Supported values:
- Returns
- Response object containing the result of the operation.
◆ adminRepairTable() [4/4]
| AdminRepairTableResponse& 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.
- Parameters
-
[in] tableNames List of tables to query. An asterisk returns all tables. [in] options Optional parameters. -
admin_repair_table_repair_policy: Corrective action to take. Supported values:
- admin_repair_table_delete_chunks: Deletes any corrupted chunks
- admin_repair_table_shrink_columns: Shrinks corrupted chunks to the shortest column
- admin_repair_table_replay_wal: Manually invokes wal replay on the table
- admin_repair_table_verify_all: If false only table chunk data already known to be corrupted will be repaired. Otherwise the database will perform a full table scan to check for correctness. Supported values: The default value is admin_repair_table_false.
[out] response_ Response object containing the results of the operation. -
admin_repair_table_repair_policy: Corrective action to take. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowAlerts() [1/4]
| AdminShowAlertsResponse adminShowAlerts | ( | const AdminShowAlertsRequest & | request_ | ) | const |
◆ adminShowAlerts() [2/4]
| AdminShowAlertsResponse& adminShowAlerts | ( | const AdminShowAlertsRequest & | request_, |
| AdminShowAlertsResponse & | response_ | ||
| ) | const |
Requests a list of the most recent alerts.
Returns lists of alert data, including timestamp and type.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowAlerts() [3/4]
| AdminShowAlertsResponse adminShowAlerts | ( | const int32_t | numAlerts, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Requests a list of the most recent alerts.
Returns lists of alert data, including timestamp and type.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ adminShowAlerts() [4/4]
| AdminShowAlertsResponse& adminShowAlerts | ( | const int32_t | numAlerts, |
| const std::map< std::string, std::string > & | options, | ||
| AdminShowAlertsResponse & | response_ | ||
| ) | const |
Requests a list of the most recent alerts.
Returns lists of alert data, including timestamp and type.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowClusterOperations() [1/4]
| AdminShowClusterOperationsResponse adminShowClusterOperations | ( | const AdminShowClusterOperationsRequest & | request_ | ) | const |
Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminShowClusterOperations() [2/4]
| AdminShowClusterOperationsResponse& adminShowClusterOperations | ( | const AdminShowClusterOperationsRequest & | request_, |
| AdminShowClusterOperationsResponse & | response_ | ||
| ) | const |
Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowClusterOperations() [3/4]
| AdminShowClusterOperationsResponse adminShowClusterOperations | ( | const int32_t | historyIndex, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ adminShowClusterOperations() [4/4]
| AdminShowClusterOperationsResponse& adminShowClusterOperations | ( | const int32_t | historyIndex, |
| const std::map< std::string, std::string > & | options, | ||
| AdminShowClusterOperationsResponse & | response_ | ||
| ) | const |
Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex.
Returns details on the requested cluster operation.
The response will also indicate how many cluster operations are stored in the history.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowJobs() [1/4]
| AdminShowJobsResponse adminShowJobs | ( | const AdminShowJobsRequest & | request_ | ) | const |
◆ adminShowJobs() [2/4]
| AdminShowJobsResponse& adminShowJobs | ( | const AdminShowJobsRequest & | request_, |
| AdminShowJobsResponse & | response_ | ||
| ) | const |
◆ adminShowJobs() [3/4]
| AdminShowJobsResponse adminShowJobs | ( | const std::map< std::string, std::string > & | options | ) | const |
Get a list of the current jobs in GPUdb.
- Parameters
-
[in] options Optional parameters. - admin_show_jobs_show_async_jobs: If true, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values: The default value is admin_show_jobs_false.
- admin_show_jobs_show_worker_info: If true, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
- Returns
- Response object containing the result of the operation.
◆ adminShowJobs() [4/4]
| AdminShowJobsResponse& adminShowJobs | ( | const std::map< std::string, std::string > & | options, |
| AdminShowJobsResponse & | response_ | ||
| ) | const |
Get a list of the current jobs in GPUdb.
- Parameters
-
[in] options Optional parameters. - admin_show_jobs_show_async_jobs: If true, then the completed async jobs are also included in the response. By default, once the async jobs are completed they are no longer included in the jobs list. Supported values: The default value is admin_show_jobs_false.
- admin_show_jobs_show_worker_info: If true, then information is also returned from worker ranks. By default only status from the head rank is returned. Supported values:
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowShards() [1/4]
| AdminShowShardsResponse adminShowShards | ( | const AdminShowShardsRequest & | request_ | ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminShowShards() [2/4]
| AdminShowShardsResponse& adminShowShards | ( | const AdminShowShardsRequest & | request_, |
| AdminShowShardsResponse & | response_ | ||
| ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShowShards() [3/4]
| AdminShowShardsResponse adminShowShards | ( | const std::map< std::string, std::string > & | options | ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
- Parameters
-
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ adminShowShards() [4/4]
| AdminShowShardsResponse& adminShowShards | ( | const std::map< std::string, std::string > & | options, |
| AdminShowShardsResponse & | response_ | ||
| ) | const |
Show the mapping of shards to the corresponding rank and tom.
The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
- Parameters
-
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminShutdown() [1/4]
| AdminShutdownResponse adminShutdown | ( | const AdminShutdownRequest & | request_ | ) | const |
◆ adminShutdown() [2/4]
| AdminShutdownResponse& adminShutdown | ( | const AdminShutdownRequest & | request_, |
| AdminShutdownResponse & | response_ | ||
| ) | const |
◆ adminShutdown() [3/4]
| AdminShutdownResponse adminShutdown | ( | const std::string & | exitType, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Exits the database server application.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ adminShutdown() [4/4]
| AdminShutdownResponse& adminShutdown | ( | const std::string & | exitType, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options, | ||
| AdminShutdownResponse & | response_ | ||
| ) | const |
Exits the database server application.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminSwitchover() [1/4]
| AdminSwitchoverResponse 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminSwitchover() [2/4]
| AdminSwitchoverResponse& 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.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminSwitchover() [3/4]
| 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.
Individual ranks or entire hosts may be moved to another host.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_switchover_dry_run: If set to true, only validation checks will be performed. Nothing is switched over. Supported values: The default value is admin_switchover_false.
- Returns
- Response object containing the result of the operation.
◆ adminSwitchover() [4/4]
| 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.
Individual ranks or entire hosts may be moved to another host.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - admin_switchover_dry_run: If set to true, only validation checks will be performed. Nothing is switched over. Supported values: The default value is admin_switchover_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminVerifyDb() [1/4]
| AdminVerifyDbResponse adminVerifyDb | ( | const AdminVerifyDbRequest & | request_ | ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ adminVerifyDb() [2/4]
| AdminVerifyDbResponse& adminVerifyDb | ( | const AdminVerifyDbRequest & | request_, |
| AdminVerifyDbResponse & | response_ | ||
| ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ adminVerifyDb() [3/4]
| AdminVerifyDbResponse adminVerifyDb | ( | const std::map< std::string, std::string > & | options | ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
- Parameters
-
[in] options Optional parameters. - admin_verify_db_rebuild_on_error: [DEPRECATED – Use the Rebuild DB feature of GAdmin instead.]. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_verify_nulls: When true, verifies that null values are set to zero. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_verify_persist: When true, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set concurrent_safe in options to true or place the database offline. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_concurrent_safe: When true, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values: The default value is admin_verify_db_true.
- admin_verify_db_verify_rank0: If true, compare rank0 table metadata against workers' metadata. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_delete_orphaned_tables: If true, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. Must set verify_persist in options to true. It is recommended to run this while the database is offline OR set concurrent_safe in options to true. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_verify_orphaned_tables_only: If true, only the presence of orphaned table directories will be checked, all persistence checks will be skipped. Supported values: The default value is admin_verify_db_false.
- Returns
- Response object containing the result of the operation.
◆ adminVerifyDb() [4/4]
| AdminVerifyDbResponse& adminVerifyDb | ( | const std::map< std::string, std::string > & | options, |
| AdminVerifyDbResponse & | response_ | ||
| ) | const |
Verify database is in a consistent state.
When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.
- Parameters
-
[in] options Optional parameters. - admin_verify_db_rebuild_on_error: [DEPRECATED – Use the Rebuild DB feature of GAdmin instead.]. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_verify_nulls: When true, verifies that null values are set to zero. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_verify_persist: When true, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set concurrent_safe in options to true or place the database offline. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_concurrent_safe: When true, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values: The default value is admin_verify_db_true.
- admin_verify_db_verify_rank0: If true, compare rank0 table metadata against workers' metadata. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_delete_orphaned_tables: If true, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. Must set verify_persist in options to true. It is recommended to run this while the database is offline OR set concurrent_safe in options to true. Supported values: The default value is admin_verify_db_false.
- admin_verify_db_verify_orphaned_tables_only: If true, only the presence of orphaned table directories will be checked, all persistence checks will be skipped. Supported values: The default value is admin_verify_db_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateConvexHull() [1/4]
| AggregateConvexHullResponse aggregateConvexHull | ( | const AggregateConvexHullRequest & | request_ | ) | const |
◆ aggregateConvexHull() [2/4]
| AggregateConvexHullResponse& aggregateConvexHull | ( | const AggregateConvexHullRequest & | request_, |
| AggregateConvexHullResponse & | response_ | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateConvexHull() [3/4]
| AggregateConvexHullResponse aggregateConvexHull | ( | const std::string & | tableName, |
| const std::string & | xColumnName, | ||
| const std::string & | yColumnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ aggregateConvexHull() [4/4]
| AggregateConvexHullResponse& aggregateConvexHull | ( | const std::string & | tableName, |
| const std::string & | xColumnName, | ||
| const std::string & | yColumnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateConvexHullResponse & | response_ | ||
| ) | const |
Calculates and returns the convex hull for the values in a table specified by tableName.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateGroupBy() [1/4]
| AggregateGroupByResponse aggregateGroupBy | ( | const AggregateGroupByRequest & | request_ | ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
This is somewhat analogous to an SQL-style SELECT...GROUP BY.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateGroupBy() [2/4]
| AggregateGroupByResponse& aggregateGroupBy | ( | const AggregateGroupByRequest & | request_, |
| AggregateGroupByResponse & | response_ | ||
| ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
This is somewhat analogous to an SQL-style SELECT...GROUP BY.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateGroupBy() [3/4]
| AggregateGroupByResponse aggregateGroupBy | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
This is somewhat analogous to an SQL-style SELECT...GROUP BY.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
- Parameters
-
[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. - aggregate_group_by_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_collection_name: [DEPRECATED–please specify the containing schema as part of result_table and use createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema provided is non-existent, it will be automatically created.
- aggregate_group_by_expression: Filter expression to apply to the table prior to computing the aggregate group by.
- aggregate_group_by_chunked_expression_evaluation: evaluate the filter expression during group-by chunk processing. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_having: Filter expression to apply to the aggregated results.
-
aggregate_group_by_sort_order: [DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
- aggregate_group_by_ascending: Indicates that the returned values should be sorted in ascending order.
- aggregate_group_by_descending: Indicates that the returned values should be sorted in descending order.
-
aggregate_group_by_sort_by: [DEPRECATED–use order_by instead] String determining how the results are sorted. Supported values:
- aggregate_group_by_key: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
- aggregate_group_by_value: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
- aggregate_group_by_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
- aggregate_group_by_strategy_definition: The tier strategy for the table and its columns.
- aggregate_group_by_result_table: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. ["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
- aggregate_group_by_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_result_table_generate_pk: If true then set a primary key for the result table. Must be used in combination with the result_table option. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_ttl: Sets the TTL of the table specified in result_table.
- aggregate_group_by_chunk_size: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_group_by_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_group_by_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_group_by_create_indexes: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the result_table option.
- aggregate_group_by_view_id: ID of view of which the result table will be a member. The default value is ''.
- aggregate_group_by_pivot: pivot column
- aggregate_group_by_pivot_values: The value list provided will become the column headers in the output. Should be the values from the pivot_column.
- aggregate_group_by_grouping_sets: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.
- aggregate_group_by_rollup: This option is used to specify the multilevel aggregates.
- aggregate_group_by_cube: This option is used to specify the multidimensional aggregates.
- aggregate_group_by_shard_key: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ aggregateGroupBy() [4/4]
| AggregateGroupByResponse& aggregateGroupBy | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateGroupByResponse & | response_ | ||
| ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
This is somewhat analogous to an SQL-style SELECT...GROUP BY.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
- Parameters
-
[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. - aggregate_group_by_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_collection_name: [DEPRECATED–please specify the containing schema as part of result_table and use createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema provided is non-existent, it will be automatically created.
- aggregate_group_by_expression: Filter expression to apply to the table prior to computing the aggregate group by.
- aggregate_group_by_chunked_expression_evaluation: evaluate the filter expression during group-by chunk processing. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_having: Filter expression to apply to the aggregated results.
-
aggregate_group_by_sort_order: [DEPRECATED–use order_by instead] String indicating how the returned values should be sorted - ascending or descending. Supported values:
- aggregate_group_by_ascending: Indicates that the returned values should be sorted in ascending order.
- aggregate_group_by_descending: Indicates that the returned values should be sorted in descending order.
-
aggregate_group_by_sort_by: [DEPRECATED–use order_by instead] String determining how the results are sorted. Supported values:
- aggregate_group_by_key: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
- aggregate_group_by_value: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
- aggregate_group_by_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
- aggregate_group_by_strategy_definition: The tier strategy for the table and its columns.
- aggregate_group_by_result_table: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Column names (group-by and aggregate fields) need to be given aliases e.g. ["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
- aggregate_group_by_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_result_table_generate_pk: If true then set a primary key for the result table. Must be used in combination with the result_table option. Supported values: The default value is aggregate_group_by_false.
- aggregate_group_by_ttl: Sets the TTL of the table specified in result_table.
- aggregate_group_by_chunk_size: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_group_by_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_group_by_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_group_by_create_indexes: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the result_table option.
- aggregate_group_by_view_id: ID of view of which the result table will be a member. The default value is ''.
- aggregate_group_by_pivot: pivot column
- aggregate_group_by_pivot_values: The value list provided will become the column headers in the output. Should be the values from the pivot_column.
- aggregate_group_by_grouping_sets: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.
- aggregate_group_by_rollup: This option is used to specify the multilevel aggregates.
- aggregate_group_by_cube: This option is used to specify the multidimensional aggregates.
- aggregate_group_by_shard_key: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateGroupByRaw() [1/2]
| RawAggregateGroupByResponse aggregateGroupByRaw | ( | const AggregateGroupByRequest & | request_ | ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
This is somewhat analogous to an SQL-style SELECT...GROUP BY.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateGroupByRaw() [2/2]
| RawAggregateGroupByResponse& aggregateGroupByRaw | ( | const AggregateGroupByRequest & | request_, |
| RawAggregateGroupByResponse & | response_ | ||
| ) | const |
Calculates unique combinations (groups) of values for the given columns in a given table or view and computes aggregates on each unique combination.
This is somewhat analogous to an SQL-style SELECT...GROUP BY.
For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
options can be used to customize behavior of this call e.g. filtering or sorting the results.
To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
Available grouping functions are Rollup, Cube, and Grouping Sets
This service also provides support for Pivot operations.
Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateHistogram() [1/4]
| AggregateHistogramResponse aggregateHistogram | ( | const AggregateHistogramRequest & | request_ | ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateHistogram() [2/4]
| AggregateHistogramResponse& aggregateHistogram | ( | const AggregateHistogramRequest & | request_, |
| AggregateHistogramResponse & | response_ | ||
| ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateHistogram() [3/4]
| AggregateHistogramResponse 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.
- Parameters
-
[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. - aggregate_histogram_value_column: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).
- Returns
- Response object containing the result of the operation.
◆ aggregateHistogram() [4/4]
| AggregateHistogramResponse& aggregateHistogram | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const double | start, | ||
| const double | end, | ||
| const double | interval, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateHistogramResponse & | response_ | ||
| ) | const |
Performs a histogram calculation given a table, a column, and an interval function.
The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column.
- Parameters
-
[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. - aggregate_histogram_value_column: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateKMeans() [1/4]
| AggregateKMeansResponse aggregateKMeans | ( | const AggregateKMeansRequest & | request_ | ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateKMeans() [2/4]
| AggregateKMeansResponse& aggregateKMeans | ( | const AggregateKMeansRequest & | request_, |
| AggregateKMeansResponse & | response_ | ||
| ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateKMeans() [3/4]
| AggregateKMeansResponse aggregateKMeans | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int32_t | k, | ||
| const double | tolerance, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
- Parameters
-
[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. - aggregate_k_means_whiten: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
- aggregate_k_means_max_iters: Number of times to try to hit the tolerance limit before giving up - default is 10.
- aggregate_k_means_num_tries: Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.
- aggregate_k_means_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_k_means_false.
- aggregate_k_means_result_table: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.
- aggregate_k_means_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_k_means_false.
- aggregate_k_means_ttl: Sets the TTL of the table specified in result_table.
- Returns
- Response object containing the result of the operation.
◆ aggregateKMeans() [4/4]
| AggregateKMeansResponse& aggregateKMeans | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int32_t | k, | ||
| const double | tolerance, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateKMeansResponse & | response_ | ||
| ) | const |
This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
- Parameters
-
[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. - aggregate_k_means_whiten: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
- aggregate_k_means_max_iters: Number of times to try to hit the tolerance limit before giving up - default is 10.
- aggregate_k_means_num_tries: Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.
- aggregate_k_means_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_k_means_false.
- aggregate_k_means_result_table: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.
- aggregate_k_means_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_k_means_false.
- aggregate_k_means_ttl: Sets the TTL of the table specified in result_table.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateMinMax() [1/4]
| AggregateMinMaxResponse aggregateMinMax | ( | const AggregateMinMaxRequest & | request_ | ) | const |
◆ aggregateMinMax() [2/4]
| AggregateMinMaxResponse& aggregateMinMax | ( | const AggregateMinMaxRequest & | request_, |
| AggregateMinMaxResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateMinMax() [3/4]
| AggregateMinMaxResponse aggregateMinMax | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ aggregateMinMax() [4/4]
| AggregateMinMaxResponse& aggregateMinMax | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateMinMaxResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum values of a particular column in a table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateMinMaxGeometry() [1/4]
| AggregateMinMaxGeometryResponse aggregateMinMaxGeometry | ( | const AggregateMinMaxGeometryRequest & | request_ | ) | const |
◆ aggregateMinMaxGeometry() [2/4]
| AggregateMinMaxGeometryResponse& aggregateMinMaxGeometry | ( | const AggregateMinMaxGeometryRequest & | request_, |
| AggregateMinMaxGeometryResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateMinMaxGeometry() [3/4]
| AggregateMinMaxGeometryResponse aggregateMinMaxGeometry | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ aggregateMinMaxGeometry() [4/4]
| AggregateMinMaxGeometryResponse& aggregateMinMaxGeometry | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateMinMaxGeometryResponse & | response_ | ||
| ) | const |
Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateStatistics() [1/4]
| AggregateStatisticsResponse aggregateStatistics | ( | const AggregateStatisticsRequest & | request_ | ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateStatistics() [2/4]
| AggregateStatisticsResponse& aggregateStatistics | ( | const AggregateStatisticsRequest & | request_, |
| AggregateStatisticsResponse & | response_ | ||
| ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateStatistics() [3/4]
| AggregateStatisticsResponse 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.
- Parameters
-
[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: - aggregate_statistics_count: Number of objects (independent of the given column(s)).
- aggregate_statistics_mean: Arithmetic mean (average), equivalent to sum/count.
- aggregate_statistics_stdv: Sample standard deviation (denominator is count-1).
- aggregate_statistics_variance: Unbiased sample variance (denominator is count-1).
- aggregate_statistics_skew: Skewness (third standardized moment).
- aggregate_statistics_kurtosis: Kurtosis (fourth standardized moment).
- aggregate_statistics_sum: Sum of all values in the column(s).
- aggregate_statistics_min: Minimum value of the column(s).
- aggregate_statistics_max: Maximum value of the column(s).
- aggregate_statistics_weighted_average: Weighted arithmetic mean (using the option weight_column_name as the weighting column).
- aggregate_statistics_cardinality: Number of unique values in the column(s).
- aggregate_statistics_estimated_cardinality: Estimate (via hyperloglog technique) of the number of unique values in the column(s).
- aggregate_statistics_percentile: Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median). Add a second, comma-separated value to calculate percentile resolution, e.g., 'percentile(75,150)'
- aggregate_statistics_percentile_rank: Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile_rank(<median>) will return approximately 50.0).
[in] options Optional parameters. - aggregate_statistics_additional_column_names: A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and columnName must be of the same type. Must not include the column specified in columnName and no column can be listed twice.
- aggregate_statistics_weight_column_name: Name of column used as weighting attribute for the weighted average statistic.
- Returns
- Response object containing the result of the operation.
◆ aggregateStatistics() [4/4]
| AggregateStatisticsResponse& aggregateStatistics | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::string & | stats, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateStatisticsResponse & | response_ | ||
| ) | const |
Calculates the requested statistics of the given column(s) in a given table.
The available statistics are: count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile, and percentile_rank.
Estimated cardinality is calculated by using the hyperloglog approximation technique.
Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e.\ 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
The weighted average statistic requires a weight column 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.
- Parameters
-
[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: - aggregate_statistics_count: Number of objects (independent of the given column(s)).
- aggregate_statistics_mean: Arithmetic mean (average), equivalent to sum/count.
- aggregate_statistics_stdv: Sample standard deviation (denominator is count-1).
- aggregate_statistics_variance: Unbiased sample variance (denominator is count-1).
- aggregate_statistics_skew: Skewness (third standardized moment).
- aggregate_statistics_kurtosis: Kurtosis (fourth standardized moment).
- aggregate_statistics_sum: Sum of all values in the column(s).
- aggregate_statistics_min: Minimum value of the column(s).
- aggregate_statistics_max: Maximum value of the column(s).
- aggregate_statistics_weighted_average: Weighted arithmetic mean (using the option weight_column_name as the weighting column).
- aggregate_statistics_cardinality: Number of unique values in the column(s).
- aggregate_statistics_estimated_cardinality: Estimate (via hyperloglog technique) of the number of unique values in the column(s).
- aggregate_statistics_percentile: Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median). Add a second, comma-separated value to calculate percentile resolution, e.g., 'percentile(75,150)'
- aggregate_statistics_percentile_rank: Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile_rank(<median>) will return approximately 50.0).
[in] options Optional parameters. - aggregate_statistics_additional_column_names: A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and columnName must be of the same type. Must not include the column specified in columnName and no column can be listed twice.
- aggregate_statistics_weight_column_name: Name of column used as weighting attribute for the weighted average statistic.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateStatisticsByRange() [1/4]
| AggregateStatisticsByRangeResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateStatisticsByRange() [2/4]
| AggregateStatisticsByRangeResponse& aggregateStatisticsByRange | ( | const AggregateStatisticsByRangeRequest & | request_, |
| AggregateStatisticsByRangeResponse & | response_ | ||
| ) | const |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateStatisticsByRange() [3/4]
| AggregateStatisticsByRangeResponse 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.
- Parameters
-
[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: - aggregate_statistics_by_range_additional_column_names: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
- aggregate_statistics_by_range_bin_values: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
- aggregate_statistics_by_range_weight_column_name: Name of the column used as weighting column for the weighted_average statistic.
- aggregate_statistics_by_range_order_column_name: Name of the column used for candlestick charting techniques.
- Returns
- Response object containing the result of the operation.
◆ aggregateStatisticsByRange() [4/4]
| AggregateStatisticsByRangeResponse& aggregateStatisticsByRange | ( | const std::string & | tableName, |
| const std::string & | selectExpression, | ||
| const std::string & | columnName, | ||
| const std::string & | valueColumnName, | ||
| const std::string & | stats, | ||
| const double | start, | ||
| const double | end, | ||
| const double | interval, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateStatisticsByRangeResponse & | response_ | ||
| ) | const |
Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in 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.
- Parameters
-
[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: - aggregate_statistics_by_range_additional_column_names: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
- aggregate_statistics_by_range_bin_values: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
- aggregate_statistics_by_range_weight_column_name: Name of the column used as weighting column for the weighted_average statistic.
- aggregate_statistics_by_range_order_column_name: Name of the column used for candlestick charting techniques.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateUnique() [1/4]
| AggregateUniqueResponse 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:
{"limit":"10","sort_order":"descending"}
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateUnique() [2/4]
| AggregateUniqueResponse& aggregateUnique | ( | const AggregateUniqueRequest & | request_, |
| AggregateUniqueResponse & | response_ | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName).
If columnName is a numeric column, the values will be in binaryEncodedResponse. Otherwise if columnName is a string column, the values will be in jsonEncodedResponse. The results can be paged via offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be:
{"limit":"10","sort_order":"descending"}
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateUnique() [3/4]
| AggregateUniqueResponse aggregateUnique | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName).
If columnName is a numeric column, the values will be in binaryEncodedResponse. Otherwise if columnName is a string column, the values will be in jsonEncodedResponse. The results can be paged via offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be:
{"limit":"10","sort_order":"descending"}
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.
- Parameters
-
[in] 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. - aggregate_unique_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_collection_name: [DEPRECATED–please specify the containing schema as part of result_table and use createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema provided is non-existent, it will be automatically created.
- aggregate_unique_expression: Optional filter expression to apply to the table.
- aggregate_unique_sort_order: String indicating how the returned values should be sorted. Supported values: The default value is aggregate_unique_ascending.
- aggregate_unique_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
- aggregate_unique_result_table: 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. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.
- aggregate_unique_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_result_table_generate_pk: If true then set a primary key for the result table. Must be used in combination with the result_table option. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_ttl: Sets the TTL of the table specified in result_table.
- aggregate_unique_chunk_size: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unique_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unique_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unique_view_id: ID of view of which the result table will be a member. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ aggregateUnique() [4/4]
| AggregateUniqueResponse& aggregateUnique | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateUniqueResponse & | response_ | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName).
If columnName is a numeric column, the values will be in binaryEncodedResponse. Otherwise if columnName is a string column, the values will be in jsonEncodedResponse. The results can be paged via offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be:
{"limit":"10","sort_order":"descending"}
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.
- Parameters
-
[in] 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. - aggregate_unique_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_collection_name: [DEPRECATED–please specify the containing schema as part of result_table and use createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema provided is non-existent, it will be automatically created.
- aggregate_unique_expression: Optional filter expression to apply to the table.
- aggregate_unique_sort_order: String indicating how the returned values should be sorted. Supported values: The default value is aggregate_unique_ascending.
- aggregate_unique_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
- aggregate_unique_result_table: 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. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.
- aggregate_unique_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_result_table_generate_pk: If true then set a primary key for the result table. Must be used in combination with the result_table option. Supported values: The default value is aggregate_unique_false.
- aggregate_unique_ttl: Sets the TTL of the table specified in result_table.
- aggregate_unique_chunk_size: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unique_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unique_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unique_view_id: ID of view of which the result table will be a member. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateUniqueRaw() [1/2]
| RawAggregateUniqueResponse aggregateUniqueRaw | ( | const AggregateUniqueRequest & | request_ | ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName).
If columnName is a numeric column, the values will be in binaryEncodedResponse. Otherwise if columnName is a string column, the values will be in jsonEncodedResponse. The results can be paged via offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be:
{"limit":"10","sort_order":"descending"}
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateUniqueRaw() [2/2]
| RawAggregateUniqueResponse& aggregateUniqueRaw | ( | const AggregateUniqueRequest & | request_, |
| RawAggregateUniqueResponse & | response_ | ||
| ) | const |
Returns all the unique values from a particular column (specified by columnName) of a particular table or view (specified by tableName).
If columnName is a numeric column, the values will be in binaryEncodedResponse. Otherwise if columnName is a string column, the values will be in jsonEncodedResponse. The results can be paged via offset and limit parameters.
Columns marked as store-only are unable to be used with this function.
To get the first 10 unique values sorted in descending order options would be:
{"limit":"10","sort_order":"descending"}
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if the value of columnName is an unrestricted-length string.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateUnpivot() [1/4]
| AggregateUnpivotResponse aggregateUnpivot | ( | const AggregateUnpivotRequest & | request_ | ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateUnpivot() [2/4]
| AggregateUnpivotResponse& aggregateUnpivot | ( | const AggregateUnpivotRequest & | request_, |
| AggregateUnpivotResponse & | response_ | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateUnpivot() [3/4]
| AggregateUnpivotResponse aggregateUnpivot | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const std::string & | variableColumnName, | ||
| const std::string & | valueColumnName, | ||
| const std::vector< std::string > & | pivotedColumns, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
- Parameters
-
[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. - aggregate_unpivot_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_unpivot_false.
- aggregate_unpivot_collection_name: [DEPRECATED–please specify the containing schema as part of result_table and use createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema is non-existent, it will be automatically created.
- aggregate_unpivot_result_table: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
- aggregate_unpivot_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_unpivot_false.
- aggregate_unpivot_expression: Filter expression to apply to the table prior to unpivot processing.
- aggregate_unpivot_order_by: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- aggregate_unpivot_chunk_size: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unpivot_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unpivot_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unpivot_limit: The number of records to keep. The default value is ''.
- aggregate_unpivot_ttl: Sets the TTL of the table specified in result_table.
- aggregate_unpivot_view_id: view this result table is part of. The default value is ''.
- aggregate_unpivot_create_indexes: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
- aggregate_unpivot_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is aggregate_unpivot_false.
- Returns
- Response object containing the result of the operation.
◆ aggregateUnpivot() [4/4]
| AggregateUnpivotResponse& aggregateUnpivot | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const std::string & | variableColumnName, | ||
| const std::string & | valueColumnName, | ||
| const std::vector< std::string > & | pivotedColumns, | ||
| const std::map< std::string, std::string > & | options, | ||
| AggregateUnpivotResponse & | response_ | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
- Parameters
-
[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. - aggregate_unpivot_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of result_table. If result_table_persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_result_table_name. Supported values: The default value is aggregate_unpivot_false.
- aggregate_unpivot_collection_name: [DEPRECATED–please specify the containing schema as part of result_table and use createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in result_table. If the schema is non-existent, it will be automatically created.
- aggregate_unpivot_result_table: The name of a table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response.
- aggregate_unpivot_result_table_persist: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is aggregate_unpivot_false.
- aggregate_unpivot_expression: Filter expression to apply to the table prior to unpivot processing.
- aggregate_unpivot_order_by: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- aggregate_unpivot_chunk_size: Indicates the number of records per chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unpivot_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unpivot_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the result_table option.
- aggregate_unpivot_limit: The number of records to keep. The default value is ''.
- aggregate_unpivot_ttl: Sets the TTL of the table specified in result_table.
- aggregate_unpivot_view_id: view this result table is part of. The default value is ''.
- aggregate_unpivot_create_indexes: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
- aggregate_unpivot_result_table_force_replicated: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values: The default value is aggregate_unpivot_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ aggregateUnpivotRaw() [1/2]
| RawAggregateUnpivotResponse aggregateUnpivotRaw | ( | const AggregateUnpivotRequest & | request_ | ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ aggregateUnpivotRaw() [2/2]
| RawAggregateUnpivotResponse& aggregateUnpivotRaw | ( | const AggregateUnpivotRequest & | request_, |
| RawAggregateUnpivotResponse & | response_ | ||
| ) | const |
Rotate the column values into rows values.
For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterCredential() [1/4]
| AlterCredentialResponse alterCredential | ( | const AlterCredentialRequest & | request_ | ) | const |
Alter the properties of an existing credential.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterCredential() [2/4]
| AlterCredentialResponse& alterCredential | ( | const AlterCredentialRequest & | request_, |
| AlterCredentialResponse & | response_ | ||
| ) | const |
Alter the properties of an existing credential.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterCredential() [3/4]
| 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.
- Parameters
-
[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. -
alter_credential_type: New type for the credential. Supported values:
- alter_credential_aws_access_key
- alter_credential_aws_iam_role
- alter_credential_azure_ad
- alter_credential_azure_oauth
- alter_credential_azure_sas
- alter_credential_azure_storage_key
- alter_credential_docker
- alter_credential_gcs_service_account_id
- alter_credential_gcs_service_account_keys
- alter_credential_hdfs
- alter_credential_kafka
- alter_credential_identity: New user for the credential
- alter_credential_secret: New password for the credential
- alter_credential_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
[in] options Optional parameters. -
alter_credential_type: New type for the credential. Supported values:
- Returns
- Response object containing the result of the operation.
◆ alterCredential() [4/4]
| 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.
- Parameters
-
[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. -
alter_credential_type: New type for the credential. Supported values:
- alter_credential_aws_access_key
- alter_credential_aws_iam_role
- alter_credential_azure_ad
- alter_credential_azure_oauth
- alter_credential_azure_sas
- alter_credential_azure_storage_key
- alter_credential_docker
- alter_credential_gcs_service_account_id
- alter_credential_gcs_service_account_keys
- alter_credential_hdfs
- alter_credential_kafka
- alter_credential_identity: New user for the credential
- alter_credential_secret: New password for the credential
- alter_credential_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
[in] options Optional parameters. [out] response_ Response object containing the results of the operation. -
alter_credential_type: New type for the credential. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterDatasink() [1/4]
| AlterDatasinkResponse alterDatasink | ( | const AlterDatasinkRequest & | request_ | ) | const |
◆ alterDatasink() [2/4]
| AlterDatasinkResponse& alterDatasink | ( | const AlterDatasinkRequest & | request_, |
| AlterDatasinkResponse & | response_ | ||
| ) | const |
◆ alterDatasink() [3/4]
| 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
- Parameters
-
[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. - alter_datasink_destination: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
- alter_datasink_connection_timeout: Timeout in seconds for connecting to this sink
- alter_datasink_wait_timeout: Timeout in seconds for waiting for a response from this sink
- alter_datasink_credential: Name of the credential object to be used in this data sink
- alter_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink
- alter_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located
-
alter_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- alter_datasink_true: Connect with SSL verification
- alter_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
alter_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
- alter_datasink_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- alter_datasink_false: Use path-style URI for requests.
- alter_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- alter_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- alter_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- alter_datasink_s3_encryption_type: Server side encryption type
- alter_datasink_s3_kms_key_id: KMS key
- alter_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- alter_datasink_hdfs_delegation_token: Delegation token for the given HDFS user
- alter_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is alter_datasink_false.
- alter_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified
- alter_datasink_azure_container_name: Name of the Azure storage container to use as the data sink
- alter_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID)
- alter_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink
- alter_datasink_azure_oauth_token: Oauth token to access given storage container
- alter_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink
- alter_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink
- alter_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink
- alter_datasink_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
- alter_datasink_jdbc_driver_class_name: Name of the JDBC driver class
- alter_datasink_kafka_url: The publicly-accessible full path URL to the kafka broker, e.g., 'http://172.123.45.67:9300'.
- alter_datasink_kafka_topic_name: Name of the Kafka topic to use for this data sink, if it references a Kafka broker
- alter_datasink_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: The default value is alter_datasink_true.
- alter_datasink_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is alter_datasink_false.
- alter_datasink_use_https: Use https to connect to datasink if true, otherwise use http. Supported values: The default value is alter_datasink_true.
- alter_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'.
- alter_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'.
-
alter_datasink_json_format: The desired format of JSON encoded notifications message. Supported values:
- alter_datasink_flat: A single record is returned per message
- alter_datasink_nested: Records are returned as an array per message
- alter_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: The default value is alter_datasink_false.
- alter_datasink_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
[in] options Optional parameters.
- Returns
- Response object containing the result of the operation.
◆ alterDatasink() [4/4]
| 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
- Parameters
-
[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. - alter_datasink_destination: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
- alter_datasink_connection_timeout: Timeout in seconds for connecting to this sink
- alter_datasink_wait_timeout: Timeout in seconds for waiting for a response from this sink
- alter_datasink_credential: Name of the credential object to be used in this data sink
- alter_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink
- alter_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located
-
alter_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- alter_datasink_true: Connect with SSL verification
- alter_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
alter_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
- alter_datasink_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- alter_datasink_false: Use path-style URI for requests.
- alter_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- alter_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- alter_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- alter_datasink_s3_encryption_type: Server side encryption type
- alter_datasink_s3_kms_key_id: KMS key
- alter_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- alter_datasink_hdfs_delegation_token: Delegation token for the given HDFS user
- alter_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is alter_datasink_false.
- alter_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified
- alter_datasink_azure_container_name: Name of the Azure storage container to use as the data sink
- alter_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID)
- alter_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink
- alter_datasink_azure_oauth_token: Oauth token to access given storage container
- alter_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink
- alter_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink
- alter_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink
- alter_datasink_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
- alter_datasink_jdbc_driver_class_name: Name of the JDBC driver class
- alter_datasink_kafka_url: The publicly-accessible full path URL to the kafka broker, e.g., 'http://172.123.45.67:9300'.
- alter_datasink_kafka_topic_name: Name of the Kafka topic to use for this data sink, if it references a Kafka broker
- alter_datasink_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: The default value is alter_datasink_true.
- alter_datasink_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is alter_datasink_false.
- alter_datasink_use_https: Use https to connect to datasink if true, otherwise use http. Supported values: The default value is alter_datasink_true.
- alter_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'.
- alter_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'.
-
alter_datasink_json_format: The desired format of JSON encoded notifications message. Supported values:
- alter_datasink_flat: A single record is returned per message
- alter_datasink_nested: Records are returned as an array per message
- alter_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: The default value is alter_datasink_false.
- alter_datasink_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
[in] options Optional parameters. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterDatasource() [1/4]
| AlterDatasourceResponse alterDatasource | ( | const AlterDatasourceRequest & | request_ | ) | const |
Alters the properties of an existing data source
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterDatasource() [2/4]
| AlterDatasourceResponse& alterDatasource | ( | const AlterDatasourceRequest & | request_, |
| AlterDatasourceResponse & | response_ | ||
| ) | const |
Alters the properties of an existing data source
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterDatasource() [3/4]
| 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
- Parameters
-
[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. - alter_datasource_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'.
- alter_datasource_user_name: Name of the remote system user; may be an empty string
- alter_datasource_password: Password for the remote system user; may be an empty string
- alter_datasource_skip_validation: Bypass validation of connection to remote source. Supported values: The default value is alter_datasource_false.
- alter_datasource_connection_timeout: Timeout in seconds for connecting to this storage provider
- alter_datasource_wait_timeout: Timeout in seconds for reading from this storage provider
- alter_datasource_credential: Name of the credential object to be used in data source
- alter_datasource_s3_bucket_name: Name of the Amazon S3 bucket to use as the data source
- alter_datasource_s3_region: Name of the Amazon S3 region where the given bucket is located
-
alter_datasource_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- alter_datasource_true: Connect with SSL verification
- alter_datasource_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
alter_datasource_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
- alter_datasource_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- alter_datasource_false: Use path-style URI for requests.
- alter_datasource_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- alter_datasource_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- alter_datasource_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- alter_datasource_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- alter_datasource_hdfs_delegation_token: Delegation token for the given HDFS user
- alter_datasource_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is alter_datasource_false.
- alter_datasource_azure_storage_account_name: Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified
- alter_datasource_azure_container_name: Name of the Azure storage container to use as the data source
- alter_datasource_azure_tenant_id: Active Directory tenant ID (or directory ID)
- alter_datasource_azure_sas_token: Shared access signature token for Azure storage account to use as the data source
- alter_datasource_azure_oauth_token: OAuth token to access given storage container
- alter_datasource_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data source
- alter_datasource_gcs_project_id: Name of the Google Cloud project to use as the data source
- alter_datasource_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data source
- alter_datasource_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
- alter_datasource_jdbc_driver_class_name: Name of the JDBC driver class
- alter_datasource_kafka_url: The publicly-accessible full path URL to the Kafka broker, e.g., 'http://172.123.45.67:9300'.
- alter_datasource_kafka_topic_name: Name of the Kafka topic to use as the data source
- alter_datasource_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: The default value is alter_datasource_true.
- alter_datasource_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is alter_datasource_false.
- alter_datasource_use_https: Use https to connect to datasource if true, otherwise use http. Supported values: The default value is alter_datasource_true.
- alter_datasource_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
- alter_datasource_schema_registry_location: Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format.
- alter_datasource_schema_registry_credential: Confluent Schema Registry credential object name.
- alter_datasource_schema_registry_port: Confluent Schema Registry port (optional).
[in] options Optional parameters.
- Returns
- Response object containing the result of the operation.
◆ alterDatasource() [4/4]
| 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
- Parameters
-
[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. - alter_datasource_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'.
- alter_datasource_user_name: Name of the remote system user; may be an empty string
- alter_datasource_password: Password for the remote system user; may be an empty string
- alter_datasource_skip_validation: Bypass validation of connection to remote source. Supported values: The default value is alter_datasource_false.
- alter_datasource_connection_timeout: Timeout in seconds for connecting to this storage provider
- alter_datasource_wait_timeout: Timeout in seconds for reading from this storage provider
- alter_datasource_credential: Name of the credential object to be used in data source
- alter_datasource_s3_bucket_name: Name of the Amazon S3 bucket to use as the data source
- alter_datasource_s3_region: Name of the Amazon S3 region where the given bucket is located
-
alter_datasource_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- alter_datasource_true: Connect with SSL verification
- alter_datasource_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
alter_datasource_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
- alter_datasource_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- alter_datasource_false: Use path-style URI for requests.
- alter_datasource_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- alter_datasource_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- alter_datasource_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- alter_datasource_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- alter_datasource_hdfs_delegation_token: Delegation token for the given HDFS user
- alter_datasource_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is alter_datasource_false.
- alter_datasource_azure_storage_account_name: Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified
- alter_datasource_azure_container_name: Name of the Azure storage container to use as the data source
- alter_datasource_azure_tenant_id: Active Directory tenant ID (or directory ID)
- alter_datasource_azure_sas_token: Shared access signature token for Azure storage account to use as the data source
- alter_datasource_azure_oauth_token: OAuth token to access given storage container
- alter_datasource_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data source
- alter_datasource_gcs_project_id: Name of the Google Cloud project to use as the data source
- alter_datasource_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data source
- alter_datasource_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
- alter_datasource_jdbc_driver_class_name: Name of the JDBC driver class
- alter_datasource_kafka_url: The publicly-accessible full path URL to the Kafka broker, e.g., 'http://172.123.45.67:9300'.
- alter_datasource_kafka_topic_name: Name of the Kafka topic to use as the data source
- alter_datasource_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: The default value is alter_datasource_true.
- alter_datasource_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is alter_datasource_false.
- alter_datasource_use_https: Use https to connect to datasource if true, otherwise use http. Supported values: The default value is alter_datasource_true.
- alter_datasource_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
- alter_datasource_schema_registry_location: Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format.
- alter_datasource_schema_registry_credential: Confluent Schema Registry credential object name.
- alter_datasource_schema_registry_port: Confluent Schema Registry port (optional).
[in] options Optional parameters. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterDirectory() [1/4]
| AlterDirectoryResponse alterDirectory | ( | const AlterDirectoryRequest & | request_ | ) | const |
◆ alterDirectory() [2/4]
| AlterDirectoryResponse& alterDirectory | ( | const AlterDirectoryRequest & | request_, |
| AlterDirectoryResponse & | response_ | ||
| ) | const |
◆ alterDirectory() [3/4]
| 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.
- Parameters
-
[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. - alter_directory_data_limit: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ alterDirectory() [4/4]
| 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.
- Parameters
-
[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. - alter_directory_data_limit: The maximum capacity, in bytes, to apply to the directory. Set to -1 to indicate no upper limit.
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterEnvironment() [1/4]
| AlterEnvironmentResponse alterEnvironment | ( | const AlterEnvironmentRequest & | request_ | ) | const |
Alters an existing environment which can be referenced by a user-defined function (UDF).
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterEnvironment() [2/4]
| AlterEnvironmentResponse& alterEnvironment | ( | const AlterEnvironmentRequest & | request_, |
| AlterEnvironmentResponse & | response_ | ||
| ) | const |
Alters an existing environment which can be referenced by a user-defined function (UDF).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterEnvironment() [3/4]
| 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).
- Parameters
-
[in] environmentName Name of the environment to be altered. [in] action Modification operation to be applied. Supported values: - alter_environment_install_package: Install a python package from PyPI, an external data source or KiFS
- alter_environment_install_requirements: Install packages from a requirements file
- alter_environment_uninstall_package: Uninstall a python package.
- alter_environment_uninstall_requirements: Uninstall packages from a requirements file
- alter_environment_reset: Uninstalls all packages in the environment and resets it to the original state at time of creation
- alter_environment_rebuild: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies
[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. - alter_environment_datasource_name: Name of an existing external data source from which packages specified in value can be loaded
- Returns
- Response object containing the result of the operation.
◆ alterEnvironment() [4/4]
| 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).
- Parameters
-
[in] environmentName Name of the environment to be altered. [in] action Modification operation to be applied. Supported values: - alter_environment_install_package: Install a python package from PyPI, an external data source or KiFS
- alter_environment_install_requirements: Install packages from a requirements file
- alter_environment_uninstall_package: Uninstall a python package.
- alter_environment_uninstall_requirements: Uninstall packages from a requirements file
- alter_environment_reset: Uninstalls all packages in the environment and resets it to the original state at time of creation
- alter_environment_rebuild: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies
[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. - alter_environment_datasource_name: Name of an existing external data source from which packages specified in value can be loaded
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterResourceGroup() [1/4]
| AlterResourceGroupResponse alterResourceGroup | ( | const AlterResourceGroupRequest & | request_ | ) | const |
◆ alterResourceGroup() [2/4]
| AlterResourceGroupResponse& alterResourceGroup | ( | const AlterResourceGroupRequest & | request_, |
| AlterResourceGroupResponse & | response_ | ||
| ) | const |
Alters the properties of an exisiting resource group to facilitate resource management.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterResourceGroup() [3/4]
| AlterResourceGroupResponse alterResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::map< std::string, std::string > > & | tierAttributes, | ||
| const std::string & | ranking, | ||
| const std::string & | adjoiningResourceGroup, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters the properties of an exisiting resource group to facilitate resource management.
- Parameters
-
[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'}}. - alter_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group.
[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: - alter_resource_group_empty_string
- alter_resource_group_first
- alter_resource_group_last
- alter_resource_group_before
- alter_resource_group_after
[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. - alter_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
- alter_resource_group_max_data: Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is '-1'.
- alter_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
- alter_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'.
- alter_resource_group_is_default_group: If true, this request applies to the global default resource group. It is an error for this field to be true when the name field is also populated. Supported values: The default value is alter_resource_group_false.
- alter_resource_group_persist: If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_resource_group_true.
- Returns
- Response object containing the result of the operation.
◆ alterResourceGroup() [4/4]
| AlterResourceGroupResponse& alterResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::map< std::string, std::string > > & | tierAttributes, | ||
| const std::string & | ranking, | ||
| const std::string & | adjoiningResourceGroup, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterResourceGroupResponse & | response_ | ||
| ) | const |
Alters the properties of an exisiting resource group to facilitate resource management.
- Parameters
-
[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'}}. - alter_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group.
[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: - alter_resource_group_empty_string
- alter_resource_group_first
- alter_resource_group_last
- alter_resource_group_before
- alter_resource_group_after
[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. - alter_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
- alter_resource_group_max_data: Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is '-1'.
- alter_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
- alter_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'.
- alter_resource_group_is_default_group: If true, this request applies to the global default resource group. It is an error for this field to be true when the name field is also populated. Supported values: The default value is alter_resource_group_false.
- alter_resource_group_persist: If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_resource_group_true.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterRole() [1/4]
| AlterRoleResponse alterRole | ( | const AlterRoleRequest & | request_ | ) | const |
◆ alterRole() [2/4]
| AlterRoleResponse& alterRole | ( | const AlterRoleRequest & | request_, |
| AlterRoleResponse & | response_ | ||
| ) | const |
◆ alterRole() [3/4]
| AlterRoleResponse alterRole | ( | const std::string & | name, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters a Role.
- Parameters
-
[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: - alter_role_set_comment: Sets the comment for an internal role.
- alter_role_set_resource_group: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
[in] value The value of the modification, depending on action. [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ alterRole() [4/4]
| AlterRoleResponse& alterRole | ( | const std::string & | name, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterRoleResponse & | response_ | ||
| ) | const |
Alters a Role.
- Parameters
-
[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: - alter_role_set_comment: Sets the comment for an internal role.
- alter_role_set_resource_group: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterSchema() [1/4]
| AlterSchemaResponse alterSchema | ( | const AlterSchemaRequest & | request_ | ) | const |
Used to change the name of a SQL-style schema, specified in schemaName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterSchema() [2/4]
| AlterSchemaResponse& alterSchema | ( | const AlterSchemaRequest & | request_, |
| AlterSchemaResponse & | response_ | ||
| ) | const |
Used to change the name of a SQL-style schema, specified in schemaName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterSchema() [3/4]
| 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.
- Parameters
-
[in] schemaName Name of the schema to be altered. [in] action Modification operation to be applied. Supported values: - alter_schema_add_comment: Adds a comment describing the schema
- alter_schema_rename_schema: Renames a schema to value. Has the same naming restrictions as tables.
[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.
- Returns
- Response object containing the result of the operation.
◆ alterSchema() [4/4]
| 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.
- Parameters
-
[in] schemaName Name of the schema to be altered. [in] action Modification operation to be applied. Supported values: - alter_schema_add_comment: Adds a comment describing the schema
- alter_schema_rename_schema: Renames a schema to value. Has the same naming restrictions as tables.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterSystemProperties() [1/4]
| 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.
Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterSystemProperties() [2/4]
| AlterSystemPropertiesResponse& 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').
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterSystemProperties() [3/4]
| AlterSystemPropertiesResponse 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').
- Parameters
-
[in] propertyUpdatesMap Map containing the properties of the system to be updated. Error if empty. - alter_system_properties_concurrent_kernel_execution: Enables concurrent kernel execution if the value is true and disables it if the value is false. Supported values:
- alter_system_properties_subtask_concurrency_limit: Sets the maximum number of simultaneous threads allocated to a given request, on each rank. Note that thread allocation may also be limted by resource group limits and/or system load.
- alter_system_properties_chunk_size: Sets the number of records per chunk to be used for all new tables.
- alter_system_properties_chunk_column_max_memory: Sets the target maximum data size for each column in a chunk to be used for all new tables.
- alter_system_properties_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
- alter_system_properties_evict_columns: Attempts to evict columns from memory to the persistent store. Value string is a semicolon separated list of entries, each entry being a table name optionally followed by a comma and a comma separated list of column names to attempt to evict. An empty value string will attempt to evict all tables and columns.
- alter_system_properties_execution_mode: Sets the execution_mode for kernel executions to the specified string value. Possible values are host, device, default (engine decides) or an integer value that indicates max chunk size to exec on host
- alter_system_properties_external_files_directory: Sets the root directory path where external table data files are accessed from. Path must exist on the head node
- alter_system_properties_flush_to_disk: Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store. Value string can be 'true', 'false' or 'text_search' to flush the text search store only.
- alter_system_properties_clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is the name of the table for which to clear the cached results, or an empty string to clear the cached results for all tables.
- alter_system_properties_communicator_test: Invoke the communicator test and report timing results. Value string is a semicolon separated list of [key]=[value] expressions. Expressions are: num_transactions=[num] where num is the number of request reply transactions to invoke per test; message_size=[bytes] where bytes is the size in bytes of the messages to send; check_values=[enabled] where if enabled is true the value of the messages received are verified.
- alter_system_properties_network_speed: Invoke the network speed test and report timing results. Value string is a semicolon-separated list of [key]=[value] expressions. Valid expressions are: seconds=[time] where time is the time in seconds to run the test; data_size=[bytes] where bytes is the size in bytes of the block to be transferred; threads=[number of threads]; to_ranks=[space-separated list of ranks] where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.
- alter_system_properties_request_timeout: Number of minutes after which filtering (e.g., filter) and aggregating (e.g., aggregateGroupBy) queries will timeout. The default value is '20'. The minimum allowed value is '0'. The maximum allowed value is '1440'.
- alter_system_properties_max_get_records_size: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'. The minimum allowed value is '0'. The maximum allowed value is '1000000'.
- alter_system_properties_max_grbc_batch_size: <DEVELOPER>
- alter_system_properties_enable_audit: Enable or disable auditing.
- alter_system_properties_audit_headers: Enable or disable auditing of request headers.
- alter_system_properties_audit_body: Enable or disable auditing of request bodies.
- alter_system_properties_audit_data: Enable or disable auditing of request data.
- alter_system_properties_audit_response: Enable or disable auditing of response information.
- alter_system_properties_shadow_agg_size: Size of the shadow aggregate chunk cache in bytes. The default value is '10000000'. The minimum allowed value is '0'. The maximum allowed value is '2147483647'.
- alter_system_properties_shadow_filter_size: Size of the shadow filter chunk cache in bytes. The default value is '10000000'. The minimum allowed value is '0'. The maximum allowed value is '2147483647'.
- alter_system_properties_synchronous_compression: compress vector on set_compression (instead of waiting for background thread). The default value is 'false'.
- alter_system_properties_enable_overlapped_equi_join: Enable overlapped-equi-join filter. The default value is 'true'.
- alter_system_properties_enable_one_step_compound_equi_join: Enable the one_step compound-equi-join algorithm. The default value is 'true'.
- alter_system_properties_kafka_batch_size: Maximum number of records to be ingested in a single batch. The default value is '1000'. The minimum allowed value is '1'. The maximum allowed value is '10000000'.
- alter_system_properties_kafka_poll_timeout: Maximum time (milliseconds) for each poll to get records from kafka. The default value is '0'. The minimum allowed value is '0'. The maximum allowed value is '1000'.
- alter_system_properties_kafka_wait_time: Maximum time (seconds) to buffer records received from kafka before ingestion. The default value is '30'. The minimum allowed value is '1'. The maximum allowed value is '120'.
- alter_system_properties_egress_parquet_compression: Parquet file compression type. Supported values: The default value is alter_system_properties_snappy.
- alter_system_properties_egress_single_file_max_size: Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is '10000'. The minimum allowed value is '1'. The maximum allowed value is '200000'.
- alter_system_properties_max_concurrent_kernels: Sets the max_concurrent_kernels value of the conf. The minimum allowed value is '0'. The maximum allowed value is '256'.
- alter_system_properties_system_metadata_retention_period: Sets the system_metadata.retention_period value of the conf. The minimum allowed value is '1'.
- alter_system_properties_tcs_per_tom: Sets the tcs_per_tom value of the conf. The minimum allowed value is '2'. The maximum allowed value is '8192'.
- alter_system_properties_tps_per_tom: Sets the tps_per_tom value of the conf. The minimum allowed value is '2'. The maximum allowed value is '8192'.
- alter_system_properties_background_worker_threads: Size of the worker rank background thread pool. This includes background operations such as watermark evictions catalog table updates. The minimum allowed value is '1'. The maximum allowed value is '8192'.
- alter_system_properties_ai_enable_rag: Enable RAG. The default value is 'false'.
- alter_system_properties_ai_api_provider: AI API provider type
- alter_system_properties_ai_api_url: AI API URL
- alter_system_properties_ai_api_key: AI API key
- alter_system_properties_ai_api_connection_timeout: AI API connection timeout in seconds
- alter_system_properties_ai_api_embeddings_model: AI API model name
- alter_system_properties_telm_persist_query_metrics: Enable or disable persisting of query metrics.
- alter_system_properties_postgres_proxy_idle_connection_timeout: Idle connection timeout in seconds
- alter_system_properties_postgres_proxy_keep_alive: Enable postgres proxy keep alive. The default value is 'false'.
- alter_system_properties_kifs_directory_data_limit: The default maximum capacity to apply when creating a KiFS directory (bytes). The minimum allowed value is '-1'.
[in] options Optional parameters. - alter_system_properties_evict_to_cold: If true and evict_columns is specified, the given objects will be evicted to cold storage (if such a tier exists). Supported values:
- alter_system_properties_persist: If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_system_properties_true.
- Returns
- Response object containing the result of the operation.
◆ alterSystemProperties() [4/4]
| 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.
Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
- Parameters
-
[in] propertyUpdatesMap Map containing the properties of the system to be updated. Error if empty. - alter_system_properties_concurrent_kernel_execution: Enables concurrent kernel execution if the value is true and disables it if the value is false. Supported values:
- alter_system_properties_subtask_concurrency_limit: Sets the maximum number of simultaneous threads allocated to a given request, on each rank. Note that thread allocation may also be limted by resource group limits and/or system load.
- alter_system_properties_chunk_size: Sets the number of records per chunk to be used for all new tables.
- alter_system_properties_chunk_column_max_memory: Sets the target maximum data size for each column in a chunk to be used for all new tables.
- alter_system_properties_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
- alter_system_properties_evict_columns: Attempts to evict columns from memory to the persistent store. Value string is a semicolon separated list of entries, each entry being a table name optionally followed by a comma and a comma separated list of column names to attempt to evict. An empty value string will attempt to evict all tables and columns.
- alter_system_properties_execution_mode: Sets the execution_mode for kernel executions to the specified string value. Possible values are host, device, default (engine decides) or an integer value that indicates max chunk size to exec on host
- alter_system_properties_external_files_directory: Sets the root directory path where external table data files are accessed from. Path must exist on the head node
- alter_system_properties_flush_to_disk: Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store. Value string can be 'true', 'false' or 'text_search' to flush the text search store only.
- alter_system_properties_clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is the name of the table for which to clear the cached results, or an empty string to clear the cached results for all tables.
- alter_system_properties_communicator_test: Invoke the communicator test and report timing results. Value string is a semicolon separated list of [key]=[value] expressions. Expressions are: num_transactions=[num] where num is the number of request reply transactions to invoke per test; message_size=[bytes] where bytes is the size in bytes of the messages to send; check_values=[enabled] where if enabled is true the value of the messages received are verified.
- alter_system_properties_network_speed: Invoke the network speed test and report timing results. Value string is a semicolon-separated list of [key]=[value] expressions. Valid expressions are: seconds=[time] where time is the time in seconds to run the test; data_size=[bytes] where bytes is the size in bytes of the block to be transferred; threads=[number of threads]; to_ranks=[space-separated list of ranks] where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.
- alter_system_properties_request_timeout: Number of minutes after which filtering (e.g., filter) and aggregating (e.g., aggregateGroupBy) queries will timeout. The default value is '20'. The minimum allowed value is '0'. The maximum allowed value is '1440'.
- alter_system_properties_max_get_records_size: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'. The minimum allowed value is '0'. The maximum allowed value is '1000000'.
- alter_system_properties_max_grbc_batch_size: <DEVELOPER>
- alter_system_properties_enable_audit: Enable or disable auditing.
- alter_system_properties_audit_headers: Enable or disable auditing of request headers.
- alter_system_properties_audit_body: Enable or disable auditing of request bodies.
- alter_system_properties_audit_data: Enable or disable auditing of request data.
- alter_system_properties_audit_response: Enable or disable auditing of response information.
- alter_system_properties_shadow_agg_size: Size of the shadow aggregate chunk cache in bytes. The default value is '10000000'. The minimum allowed value is '0'. The maximum allowed value is '2147483647'.
- alter_system_properties_shadow_filter_size: Size of the shadow filter chunk cache in bytes. The default value is '10000000'. The minimum allowed value is '0'. The maximum allowed value is '2147483647'.
- alter_system_properties_synchronous_compression: compress vector on set_compression (instead of waiting for background thread). The default value is 'false'.
- alter_system_properties_enable_overlapped_equi_join: Enable overlapped-equi-join filter. The default value is 'true'.
- alter_system_properties_enable_one_step_compound_equi_join: Enable the one_step compound-equi-join algorithm. The default value is 'true'.
- alter_system_properties_kafka_batch_size: Maximum number of records to be ingested in a single batch. The default value is '1000'. The minimum allowed value is '1'. The maximum allowed value is '10000000'.
- alter_system_properties_kafka_poll_timeout: Maximum time (milliseconds) for each poll to get records from kafka. The default value is '0'. The minimum allowed value is '0'. The maximum allowed value is '1000'.
- alter_system_properties_kafka_wait_time: Maximum time (seconds) to buffer records received from kafka before ingestion. The default value is '30'. The minimum allowed value is '1'. The maximum allowed value is '120'.
- alter_system_properties_egress_parquet_compression: Parquet file compression type. Supported values: The default value is alter_system_properties_snappy.
- alter_system_properties_egress_single_file_max_size: Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is '10000'. The minimum allowed value is '1'. The maximum allowed value is '200000'.
- alter_system_properties_max_concurrent_kernels: Sets the max_concurrent_kernels value of the conf. The minimum allowed value is '0'. The maximum allowed value is '256'.
- alter_system_properties_system_metadata_retention_period: Sets the system_metadata.retention_period value of the conf. The minimum allowed value is '1'.
- alter_system_properties_tcs_per_tom: Sets the tcs_per_tom value of the conf. The minimum allowed value is '2'. The maximum allowed value is '8192'.
- alter_system_properties_tps_per_tom: Sets the tps_per_tom value of the conf. The minimum allowed value is '2'. The maximum allowed value is '8192'.
- alter_system_properties_background_worker_threads: Size of the worker rank background thread pool. This includes background operations such as watermark evictions catalog table updates. The minimum allowed value is '1'. The maximum allowed value is '8192'.
- alter_system_properties_ai_enable_rag: Enable RAG. The default value is 'false'.
- alter_system_properties_ai_api_provider: AI API provider type
- alter_system_properties_ai_api_url: AI API URL
- alter_system_properties_ai_api_key: AI API key
- alter_system_properties_ai_api_connection_timeout: AI API connection timeout in seconds
- alter_system_properties_ai_api_embeddings_model: AI API model name
- alter_system_properties_telm_persist_query_metrics: Enable or disable persisting of query metrics.
- alter_system_properties_postgres_proxy_idle_connection_timeout: Idle connection timeout in seconds
- alter_system_properties_postgres_proxy_keep_alive: Enable postgres proxy keep alive. The default value is 'false'.
- alter_system_properties_kifs_directory_data_limit: The default maximum capacity to apply when creating a KiFS directory (bytes). The minimum allowed value is '-1'.
[in] options Optional parameters. - alter_system_properties_evict_to_cold: If true and evict_columns is specified, the given objects will be evicted to cold storage (if such a tier exists). Supported values:
- alter_system_properties_persist: If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_system_properties_true.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTable() [1/4]
| AlterTableResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterTable() [2/4]
| AlterTableResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTable() [3/4]
| AlterTableResponse 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.
- Parameters
-
[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: - alter_table_allow_homogeneous_tables: No longer supported; action will be ignored.
- alter_table_create_index: Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified index_type), on the column name specified in value. If this column already has the specified index, an error will be returned.
- alter_table_refresh_index: Refreshes an index identified by index_type, on the column name specified in value. Currently applicable only to CAGRA indices.
- alter_table_delete_index: Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified index_type), on the column name specified in value. If this column does not have the specified index, an error will be returned.
- alter_table_move_to_collection: [DEPRECATED–please use move_to_schema and use createSchema to create the schema if non-existent] Moves a table or view into a schema named value. If the schema provided is non-existent, it will be automatically created.
- alter_table_move_to_schema: Moves a table or view into a schema named value. If the schema provided is nonexistent, an error will be thrown. If value is empty, then the table or view will be placed in the user's default schema.
- alter_table_protected: No longer used. Previously set whether the given tableName should be protected or not. The value would have been either 'true' or 'false'.
- alter_table_rename_table: Renames a table or view to value. Has the same naming restrictions as tables.
- alter_table_ttl: Sets the time-to-live in minutes of the table or view specified in tableName.
- alter_table_add_comment: Adds the comment specified in value to the table specified in tableName. Use column_name to set the comment for a column.
- alter_table_add_column: Adds the column specified in value to the table specified in tableName. Use column_type and column_properties in options to set the column's type and properties, respectively.
- alter_table_change_column: Changes type and properties of the column specified in value. Use column_type and column_properties in options to set the column's type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing 'char4' column, both 'char4' and 'dict' must be specified in the options map.
- alter_table_set_column_compression: No longer supported; action will be ignored.
- alter_table_delete_column: Deletes the column specified in value from the table specified in tableName.
- alter_table_create_foreign_key: Creates a foreign key specified in value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- alter_table_delete_foreign_key: Deletes a foreign key. The value should be the foreign_key_name specified when creating the key or the complete string used to define it.
- alter_table_add_partition: Adds the partition specified in value, to either a range-partitioned or manual list-partitioned table.
- alter_table_remove_partition: Removes the partition specified in value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.
- alter_table_delete_partition: Deletes the partition specified in value (and all of its data) from either a range-partitioned or manual list-partitioned table.
- alter_table_set_global_access_mode: Sets the global access mode (i.e. locking) for the table specified in tableName. Specify the access mode in value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.
- alter_table_refresh: For a materialized view, replays all the table creation commands required to create the view. For an external table, reloads all data in the table from its associated source files or data source.
- alter_table_set_refresh_method: For a materialized view, sets the method by which the view is refreshed to the method specified in value - one of 'manual', 'periodic', or 'on_change'. For an external table, sets the method by which the table is refreshed to the method specified in value - either 'manual' or 'on_start'.
- alter_table_set_refresh_start_time: Sets the time to start periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period.
- alter_table_set_refresh_stop_time: Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'.
- alter_table_set_refresh_period: Sets the time interval in seconds at which to refresh this materialized view to the value specified in value. Also, sets the refresh method to periodic if not already set.
- alter_table_set_refresh_span: Sets the future time-offset(in seconds) for the view refresh to stop.
- alter_table_set_refresh_execute_as: Sets the user name to refresh this materialized view to the value specified in value.
- alter_table_remove_text_search_attributes: Removes text search attribute from all columns.
- alter_table_remove_shard_keys: Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The value is ignored.
- alter_table_set_strategy_definition: Sets the tier strategy for the table and its columns to the one specified in value, replacing the existing tier strategy in its entirety.
- alter_table_cancel_datasource_subscription: Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
- alter_table_pause_datasource_subscription: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
- alter_table_resume_datasource_subscription: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure.
- alter_table_change_owner: Change the owner resource group of the table.
- alter_table_set_load_vectors_policy: Set startup data loading scheme for the table; see description of 'load_vectors_policy' in createTable for possible values for value
- alter_table_set_build_pk_index_policy: Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' in createTable for possible values for value
- alter_table_set_build_materialized_view_policy: Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_policy' in createMaterializedView for possible values for value
[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. - alter_table_action
- alter_table_column_name
- alter_table_table_name
- alter_table_column_default_value: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
- alter_table_column_properties: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
- alter_table_column_type: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
- alter_table_compression_type: No longer supported; option will be ignored. Supported values: The default value is alter_table_snappy.
- alter_table_copy_values_from_column: [DEPRECATED–please use add_column_expression instead.]
- alter_table_rename_column: When changing a column, specify new column name.
-
alter_table_validate_change_column: When changing a column, validate the change before applying it (or not). Supported values:
- alter_table_true: Validate all values. A value too large (or too long) for the new type will prevent any change.
- alter_table_false: When a value is too large or long, it will be truncated.
-
alter_table_update_last_access_time: Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. Supported values:
- alter_table_true: Reset the expiration countdown timer to the table's configured TTL.
- alter_table_false: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
- alter_table_add_column_expression: When adding a column, an optional expression to use for the new column's values. Any valid expression may be used, including one containing references to existing columns in the same table.
- alter_table_strategy_definition: Optional parameter for specifying the tier strategy for the table and its columns when action is set_strategy_definition, replacing the existing tier strategy in its entirety.
-
alter_table_index_type: Type of index to create, when action is create_index; to refresh, when action is refresh_index; or to delete, when action is delete_index. Supported values:
- alter_table_column: Create or delete a column (attribute) index.
- alter_table_low_cardinality: Create a low-cardinality column (attribute) index.
- alter_table_chunk_skip: Create or delete a chunk skip index.
- alter_table_geospatial: Create or delete a geospatial index
- alter_table_cagra: Create or delete a CAGRA index on a vector column
- alter_table_hnsw: Create or delete an HNSW index on a vector column
- alter_table_index_options: Options to use when creating an index, in the format "key: value [, key: value [, ...]]". Valid options vary by index type.
- Returns
- Response object containing the result of the operation.
◆ alterTable() [4/4]
| 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.
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.
- Parameters
-
[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: - alter_table_allow_homogeneous_tables: No longer supported; action will be ignored.
- alter_table_create_index: Creates a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified index_type), on the column name specified in value. If this column already has the specified index, an error will be returned.
- alter_table_refresh_index: Refreshes an index identified by index_type, on the column name specified in value. Currently applicable only to CAGRA indices.
- alter_table_delete_index: Deletes a column (attribute) index, low-cardinality index, chunk skip index, geospatial index, CAGRA index, or HNSW index (depending on the specified index_type), on the column name specified in value. If this column does not have the specified index, an error will be returned.
- alter_table_move_to_collection: [DEPRECATED–please use move_to_schema and use createSchema to create the schema if non-existent] Moves a table or view into a schema named value. If the schema provided is non-existent, it will be automatically created.
- alter_table_move_to_schema: Moves a table or view into a schema named value. If the schema provided is nonexistent, an error will be thrown. If value is empty, then the table or view will be placed in the user's default schema.
- alter_table_protected: No longer used. Previously set whether the given tableName should be protected or not. The value would have been either 'true' or 'false'.
- alter_table_rename_table: Renames a table or view to value. Has the same naming restrictions as tables.
- alter_table_ttl: Sets the time-to-live in minutes of the table or view specified in tableName.
- alter_table_add_comment: Adds the comment specified in value to the table specified in tableName. Use column_name to set the comment for a column.
- alter_table_add_column: Adds the column specified in value to the table specified in tableName. Use column_type and column_properties in options to set the column's type and properties, respectively.
- alter_table_change_column: Changes type and properties of the column specified in value. Use column_type and column_properties in options to set the column's type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing 'char4' column, both 'char4' and 'dict' must be specified in the options map.
- alter_table_set_column_compression: No longer supported; action will be ignored.
- alter_table_delete_column: Deletes the column specified in value from the table specified in tableName.
- alter_table_create_foreign_key: Creates a foreign key specified in value using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- alter_table_delete_foreign_key: Deletes a foreign key. The value should be the foreign_key_name specified when creating the key or the complete string used to define it.
- alter_table_add_partition: Adds the partition specified in value, to either a range-partitioned or manual list-partitioned table.
- alter_table_remove_partition: Removes the partition specified in value (and relocates all of its data to the default partition) from either a range-partitioned or manual list-partitioned table.
- alter_table_delete_partition: Deletes the partition specified in value (and all of its data) from either a range-partitioned or manual list-partitioned table.
- alter_table_set_global_access_mode: Sets the global access mode (i.e. locking) for the table specified in tableName. Specify the access mode in value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.
- alter_table_refresh: For a materialized view, replays all the table creation commands required to create the view. For an external table, reloads all data in the table from its associated source files or data source.
- alter_table_set_refresh_method: For a materialized view, sets the method by which the view is refreshed to the method specified in value - one of 'manual', 'periodic', or 'on_change'. For an external table, sets the method by which the table is refreshed to the method specified in value - either 'manual' or 'on_start'.
- alter_table_set_refresh_start_time: Sets the time to start periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period.
- alter_table_set_refresh_stop_time: Sets the time to stop periodic refreshes of this materialized view to the datetime string specified in value with format 'YYYY-MM-DD HH:MM:SS'.
- alter_table_set_refresh_period: Sets the time interval in seconds at which to refresh this materialized view to the value specified in value. Also, sets the refresh method to periodic if not already set.
- alter_table_set_refresh_span: Sets the future time-offset(in seconds) for the view refresh to stop.
- alter_table_set_refresh_execute_as: Sets the user name to refresh this materialized view to the value specified in value.
- alter_table_remove_text_search_attributes: Removes text search attribute from all columns.
- alter_table_remove_shard_keys: Removes the shard key property from all columns, so that the table will be considered randomly sharded. The data is not moved. The value is ignored.
- alter_table_set_strategy_definition: Sets the tier strategy for the table and its columns to the one specified in value, replacing the existing tier strategy in its entirety.
- alter_table_cancel_datasource_subscription: Permanently unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
- alter_table_pause_datasource_subscription: Temporarily unsubscribe a data source that is loading continuously as a stream. The data source can be Kafka / S3 / Azure.
- alter_table_resume_datasource_subscription: Resubscribe to a paused data source subscription. The data source can be Kafka / S3 / Azure.
- alter_table_change_owner: Change the owner resource group of the table.
- alter_table_set_load_vectors_policy: Set startup data loading scheme for the table; see description of 'load_vectors_policy' in createTable for possible values for value
- alter_table_set_build_pk_index_policy: Set startup primary key generation scheme for the table; see description of 'build_pk_index_policy' in createTable for possible values for value
- alter_table_set_build_materialized_view_policy: Set startup rebuilding scheme for the materialized view; see description of 'build_materialized_view_policy' in createMaterializedView for possible values for value
[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. - alter_table_action
- alter_table_column_name
- alter_table_table_name
- alter_table_column_default_value: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
- alter_table_column_properties: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
- alter_table_column_type: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
- alter_table_compression_type: No longer supported; option will be ignored. Supported values: The default value is alter_table_snappy.
- alter_table_copy_values_from_column: [DEPRECATED–please use add_column_expression instead.]
- alter_table_rename_column: When changing a column, specify new column name.
-
alter_table_validate_change_column: When changing a column, validate the change before applying it (or not). Supported values:
- alter_table_true: Validate all values. A value too large (or too long) for the new type will prevent any change.
- alter_table_false: When a value is too large or long, it will be truncated.
-
alter_table_update_last_access_time: Indicates whether the time-to-live (TTL) expiration countdown timer should be reset to the table's TTL. Supported values:
- alter_table_true: Reset the expiration countdown timer to the table's configured TTL.
- alter_table_false: Don't reset the timer; expiration countdown will continue from where it is, as if the table had not been accessed.
- alter_table_add_column_expression: When adding a column, an optional expression to use for the new column's values. Any valid expression may be used, including one containing references to existing columns in the same table.
- alter_table_strategy_definition: Optional parameter for specifying the tier strategy for the table and its columns when action is set_strategy_definition, replacing the existing tier strategy in its entirety.
-
alter_table_index_type: Type of index to create, when action is create_index; to refresh, when action is refresh_index; or to delete, when action is delete_index. Supported values:
- alter_table_column: Create or delete a column (attribute) index.
- alter_table_low_cardinality: Create a low-cardinality column (attribute) index.
- alter_table_chunk_skip: Create or delete a chunk skip index.
- alter_table_geospatial: Create or delete a geospatial index
- alter_table_cagra: Create or delete a CAGRA index on a vector column
- alter_table_hnsw: Create or delete an HNSW index on a vector column
- alter_table_index_options: Options to use when creating an index, in the format "key: value [, key: value [, ...]]". Valid options vary by index type.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTableColumns() [1/4]
| AlterTableColumnsResponse alterTableColumns | ( | const AlterTableColumnsRequest & | request_ | ) | const |
Apply various modifications to columns in a table, view.
The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterTableColumns() [2/4]
| AlterTableColumnsResponse& alterTableColumns | ( | const AlterTableColumnsRequest & | request_, |
| AlterTableColumnsResponse & | response_ | ||
| ) | const |
Apply various modifications to columns in a table, view.
The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTableColumns() [3/4]
| AlterTableColumnsResponse alterTableColumns | ( | const std::string & | tableName, |
| const std::vector< std::map< std::string, std::string > > & | columnAlterations, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Apply various modifications to columns in a table, view.
The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ alterTableColumns() [4/4]
| AlterTableColumnsResponse& alterTableColumns | ( | const std::string & | tableName, |
| const std::vector< std::map< std::string, std::string > > & | columnAlterations, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterTableColumnsResponse & | response_ | ||
| ) | const |
Apply various modifications to columns in a table, view.
The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTableMetadata() [1/4]
| AlterTableMetadataResponse alterTableMetadata | ( | const AlterTableMetadataRequest & | request_ | ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterTableMetadata() [2/4]
| AlterTableMetadataResponse& alterTableMetadata | ( | const AlterTableMetadataRequest & | request_, |
| AlterTableMetadataResponse & | response_ | ||
| ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTableMetadata() [3/4]
| AlterTableMetadataResponse alterTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | metadataMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ alterTableMetadata() [4/4]
| AlterTableMetadataResponse& alterTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | metadataMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterTableMetadataResponse & | response_ | ||
| ) | const |
Updates (adds or changes) metadata for tables.
The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTableMonitor() [1/4]
| AlterTableMonitorResponse alterTableMonitor | ( | const AlterTableMonitorRequest & | request_ | ) | const |
Alters a table monitor previously created with createTableMonitor.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterTableMonitor() [2/4]
| AlterTableMonitorResponse& alterTableMonitor | ( | const AlterTableMonitorRequest & | request_, |
| AlterTableMonitorResponse & | response_ | ||
| ) | const |
Alters a table monitor previously created with createTableMonitor.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTableMonitor() [3/4]
| 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.
- Parameters
-
[in] topicId The topic ID returned by createTableMonitor. [in] monitorUpdatesMap Map containing the properties of the table monitor to be updated. Error if empty. - alter_table_monitor_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
[in] options Optional parameters.
- Returns
- Response object containing the result of the operation.
◆ alterTableMonitor() [4/4]
| 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.
- Parameters
-
[in] topicId The topic ID returned by createTableMonitor. [in] monitorUpdatesMap Map containing the properties of the table monitor to be updated. Error if empty. - alter_table_monitor_schema_name: Updates the schema name. If schema_name doesn't exist, an error will be thrown. If schema_name is empty, then the user's default schema will be used.
[in] options Optional parameters. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTier() [1/4]
| AlterTierResponse alterTier | ( | const AlterTierRequest & | request_ | ) | const |
Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ alterTier() [2/4]
| AlterTierResponse& alterTier | ( | const AlterTierRequest & | request_, |
| AlterTierResponse & | response_ | ||
| ) | const |
Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterTier() [3/4]
| AlterTierResponse alterTier | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.
- Parameters
-
[in] name Name of the tier to be altered. Must be an existing tier group name. [in] options Optional parameters. - alter_tier_capacity: Maximum size in bytes this tier may hold at once.
- alter_tier_high_watermark: Threshold of usage of this tier's resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'.
- alter_tier_low_watermark: Threshold of resource usage that once fallen below after crossing the high_watermark, will cease watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'.
- alter_tier_wait_timeout: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.
- alter_tier_persist: If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_tier_true.
- alter_tier_rank: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'.
- Returns
- Response object containing the result of the operation.
◆ alterTier() [4/4]
| AlterTierResponse& alterTier | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| AlterTierResponse & | response_ | ||
| ) | const |
Alters properties of an exisiting tier to facilitate resource management.
To disable watermark-based eviction, set both high_watermark and low_watermark to 100.
- Parameters
-
[in] name Name of the tier to be altered. Must be an existing tier group name. [in] options Optional parameters. - alter_tier_capacity: Maximum size in bytes this tier may hold at once.
- alter_tier_high_watermark: Threshold of usage of this tier's resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'.
- alter_tier_low_watermark: Threshold of resource usage that once fallen below after crossing the high_watermark, will cease watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'.
- alter_tier_wait_timeout: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.
- alter_tier_persist: If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_tier_true.
- alter_tier_rank: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterUser() [1/4]
| AlterUserResponse alterUser | ( | const AlterUserRequest & | request_ | ) | const |
◆ alterUser() [2/4]
| AlterUserResponse& alterUser | ( | const AlterUserRequest & | request_, |
| AlterUserResponse & | response_ | ||
| ) | const |
◆ alterUser() [3/4]
| AlterUserResponse alterUser | ( | const std::string & | name, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters a user.
- Parameters
-
[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: - alter_user_set_activated: Is the user allowed to login.
- alter_user_true: User may login
- alter_user_false: User may not login
- alter_user_set_comment: Sets the comment for an internal user.
- alter_user_set_default_schema: Set the default_schema for an internal user. An empty string means the user will have no default schema.
- alter_user_set_password: Sets the password of the user. The user must be an internal user.
- alter_user_set_resource_group: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.
[in] value The value of the modification, depending on action. [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ alterUser() [4/4]
| AlterUserResponse& alterUser | ( | const std::string & | name, |
| const std::string & | action, | ||
| const std::string & | value, | ||
| const std::map< std::string, std::string > & | options, | ||
| AlterUserResponse & | response_ | ||
| ) | const |
Alters a user.
- Parameters
-
[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: - alter_user_set_activated: Is the user allowed to login.
- alter_user_true: User may login
- alter_user_false: User may not login
- alter_user_set_comment: Sets the comment for an internal user.
- alter_user_set_default_schema: Set the default_schema for an internal user. An empty string means the user will have no default schema.
- alter_user_set_password: Sets the password of the user. The user must be an internal user.
- alter_user_set_resource_group: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterVideo() [1/4]
| AlterVideoResponse alterVideo | ( | const AlterVideoRequest & | request_ | ) | const |
◆ alterVideo() [2/4]
| AlterVideoResponse& alterVideo | ( | const AlterVideoRequest & | request_, |
| AlterVideoResponse & | response_ | ||
| ) | const |
◆ alterVideo() [3/4]
| AlterVideoResponse alterVideo | ( | const std::string & | path, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Alters a video.
- Parameters
-
[in] path Fully-qualified KiFS path to the video to be altered. [in] options Optional parameters. - alter_video_ttl: Sets the TTL of the video.
- Returns
- Response object containing the result of the operation.
◆ alterVideo() [4/4]
| AlterVideoResponse& alterVideo | ( | const std::string & | path, |
| const std::map< std::string, std::string > & | options, | ||
| AlterVideoResponse & | response_ | ||
| ) | const |
Alters a video.
- Parameters
-
[in] path Fully-qualified KiFS path to the video to be altered. [in] options Optional parameters. - alter_video_ttl: Sets the TTL of the video.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterWal() [1/4]
| AlterWalResponse alterWal | ( | const AlterWalRequest & | request_ | ) | const |
◆ alterWal() [2/4]
| AlterWalResponse& alterWal | ( | const AlterWalRequest & | request_, |
| AlterWalResponse & | response_ | ||
| ) | const |
Alters table wal settings.
Returns information about the requested table wal modifications.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ alterWal() [3/4]
| AlterWalResponse 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.
- Parameters
-
[in] tableNames List of tables to modify. An asterisk changes the system settings. [in] options Optional parameters. - alter_wal_max_segment_size: Maximum size of an individual segment file
- alter_wal_segment_count: Approximate number of segment files to split the wal across. Must be at least two.
-
alter_wal_sync_policy: Maximum size of an individual segment file. Supported values:
- alter_wal_none: Disables the wal
- alter_wal_background: Wal entries are periodically written instead of immediately after each operation
- alter_wal_flush: Protects entries in the event of a database crash
- alter_wal_fsync: Protects entries in the event of an OS crash
- alter_wal_flush_frequency: Specifies how frequently wal entries are written with background sync. This is a global setting and can only be used with the system {options.table_names} specifier '*'.
- alter_wal_checksum: If true each entry will be checked against a protective checksum. Supported values: The default value is alter_wal_true.
- alter_wal_override_non_default: If true tables with unique wal settings will be overridden when applying a system level change. Supported values: The default value is alter_wal_false.
- alter_wal_restore_system_settings: If true tables with unique wal settings will be reverted to the current global settings. Cannot be used in conjunction with any other option. Supported values: The default value is alter_wal_false.
- alter_wal_persist: If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_wal_true.
- Returns
- Response object containing the result of the operation.
◆ alterWal() [4/4]
| AlterWalResponse& 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.
- Parameters
-
[in] tableNames List of tables to modify. An asterisk changes the system settings. [in] options Optional parameters. - alter_wal_max_segment_size: Maximum size of an individual segment file
- alter_wal_segment_count: Approximate number of segment files to split the wal across. Must be at least two.
-
alter_wal_sync_policy: Maximum size of an individual segment file. Supported values:
- alter_wal_none: Disables the wal
- alter_wal_background: Wal entries are periodically written instead of immediately after each operation
- alter_wal_flush: Protects entries in the event of a database crash
- alter_wal_fsync: Protects entries in the event of an OS crash
- alter_wal_flush_frequency: Specifies how frequently wal entries are written with background sync. This is a global setting and can only be used with the system {options.table_names} specifier '*'.
- alter_wal_checksum: If true each entry will be checked against a protective checksum. Supported values: The default value is alter_wal_true.
- alter_wal_override_non_default: If true tables with unique wal settings will be overridden when applying a system level change. Supported values: The default value is alter_wal_false.
- alter_wal_restore_system_settings: If true tables with unique wal settings will be reverted to the current global settings. Cannot be used in conjunction with any other option. Supported values: The default value is alter_wal_false.
- alter_wal_persist: If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: The default value is alter_wal_true.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ appendRecords() [1/4]
| AppendRecordsResponse appendRecords | ( | const AppendRecordsRequest & | request_ | ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ appendRecords() [2/4]
| AppendRecordsResponse& appendRecords | ( | const AppendRecordsRequest & | request_, |
| AppendRecordsResponse & | response_ | ||
| ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ appendRecords() [3/4]
| AppendRecordsResponse appendRecords | ( | const std::string & | tableName, |
| const std::string & | sourceTableName, | ||
| const std::map< std::string, std::string > & | fieldMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
- Parameters
-
[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. - append_records_offset: A positive integer indicating the number of initial results to skip from sourceTableName. Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.
- append_records_limit: A positive integer indicating the maximum number of results to be returned from sourceTableName. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
- append_records_expression: Optional filter expression to apply to the sourceTableName. The default value is ''.
- append_records_order_by: Comma-separated list of the columns to be sorted by from source table (specified by sourceTableName), e.g., 'timestamp asc, x desc'. The order_by columns do not have to be present in fieldMap. The default value is ''.
-
append_records_update_on_existing_pk: Specifies the record collision policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key. If set to true, any existing table record with primary key values that match those of a source table record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
- append_records_true: Upsert new records when primary keys match existing records
- append_records_false: Reject new records when primary keys match existing records
-
append_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If false, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- append_records_true: Ignore source table records whose primary key values collide with those of target table records
- append_records_false: Raise an error for any source table record whose primary key values collide with those of a target table record
- append_records_truncate_strings: If set to true, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values: The default value is append_records_false.
- Returns
- Response object containing the result of the operation.
◆ appendRecords() [4/4]
| AppendRecordsResponse& appendRecords | ( | const std::string & | tableName, |
| const std::string & | sourceTableName, | ||
| const std::map< std::string, std::string > & | fieldMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| AppendRecordsResponse & | response_ | ||
| ) | const |
Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName).
The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
- Parameters
-
[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. - append_records_offset: A positive integer indicating the number of initial results to skip from sourceTableName. Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.
- append_records_limit: A positive integer indicating the maximum number of results to be returned from sourceTableName. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
- append_records_expression: Optional filter expression to apply to the sourceTableName. The default value is ''.
- append_records_order_by: Comma-separated list of the columns to be sorted by from source table (specified by sourceTableName), e.g., 'timestamp asc, x desc'. The order_by columns do not have to be present in fieldMap. The default value is ''.
-
append_records_update_on_existing_pk: Specifies the record collision policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key. If set to true, any existing table record with primary key values that match those of a source table record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
- append_records_true: Upsert new records when primary keys match existing records
- append_records_false: Reject new records when primary keys match existing records
-
append_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting source table records (specified by sourceTableName) into a target table (specified by tableName) with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If false, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- append_records_true: Ignore source table records whose primary key values collide with those of target table records
- append_records_false: Raise an error for any source table record whose primary key values collide with those of a target table record
- append_records_truncate_strings: If set to true, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values: The default value is append_records_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearStatistics() [1/4]
| ClearStatisticsResponse clearStatistics | ( | const ClearStatisticsRequest & | request_ | ) | const |
◆ clearStatistics() [2/4]
| ClearStatisticsResponse& clearStatistics | ( | const ClearStatisticsRequest & | request_, |
| ClearStatisticsResponse & | response_ | ||
| ) | const |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearStatistics() [3/4]
| ClearStatisticsResponse clearStatistics | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ clearStatistics() [4/4]
| ClearStatisticsResponse& clearStatistics | ( | const std::string & | tableName, |
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| ClearStatisticsResponse & | response_ | ||
| ) | const |
Clears statistics (cardinality, mean value, etc.) for a column in a specified table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearTable() [1/4]
| ClearTableResponse clearTable | ( | const ClearTableRequest & | request_ | ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ clearTable() [2/4]
| ClearTableResponse& clearTable | ( | const ClearTableRequest & | request_, |
| ClearTableResponse & | response_ | ||
| ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearTable() [3/4]
| ClearTableResponse clearTable | ( | const std::string & | tableName, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
- Parameters
-
[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. - clear_table_no_error_if_not_exists: If true and if the table specified in tableName does not exist no error is returned. If false and if the table specified in tableName does not exist then an error is returned. Supported values: The default value is clear_table_false.
- Returns
- Response object containing the result of the operation.
◆ clearTable() [4/4]
| ClearTableResponse& clearTable | ( | const std::string & | tableName, |
| const std::string & | authorization, | ||
| const std::map< std::string, std::string > & | options, | ||
| ClearTableResponse & | response_ | ||
| ) | const |
Clears (drops) one or all tables in the database cluster.
The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
- Parameters
-
[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. - clear_table_no_error_if_not_exists: If true and if the table specified in tableName does not exist no error is returned. If false and if the table specified in tableName does not exist then an error is returned. Supported values: The default value is clear_table_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearTableMonitor() [1/4]
| ClearTableMonitorResponse clearTableMonitor | ( | const ClearTableMonitorRequest & | request_ | ) | const |
Deactivates a table monitor previously created with createTableMonitor.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ clearTableMonitor() [2/4]
| ClearTableMonitorResponse& clearTableMonitor | ( | const ClearTableMonitorRequest & | request_, |
| ClearTableMonitorResponse & | response_ | ||
| ) | const |
Deactivates a table monitor previously created with createTableMonitor.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearTableMonitor() [3/4]
| ClearTableMonitorResponse clearTableMonitor | ( | const std::string & | topicId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deactivates a table monitor previously created with createTableMonitor.
- Parameters
-
[in] topicId The topic ID returned by createTableMonitor. [in] options Optional parameters. - clear_table_monitor_keep_autogenerated_sink: If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values: The default value is clear_table_monitor_false.
- clear_table_monitor_clear_all_references: If true, all references that share the same topicId will be cleared. Supported values: The default value is clear_table_monitor_false.
- Returns
- Response object containing the result of the operation.
◆ clearTableMonitor() [4/4]
| 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.
- Parameters
-
[in] topicId The topic ID returned by createTableMonitor. [in] options Optional parameters. - clear_table_monitor_keep_autogenerated_sink: If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values: The default value is clear_table_monitor_false.
- clear_table_monitor_clear_all_references: If true, all references that share the same topicId will be cleared. Supported values: The default value is clear_table_monitor_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearTrigger() [1/4]
| ClearTriggerResponse clearTrigger | ( | const ClearTriggerRequest & | request_ | ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ clearTrigger() [2/4]
| ClearTriggerResponse& clearTrigger | ( | const ClearTriggerRequest & | request_, |
| ClearTriggerResponse & | response_ | ||
| ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ clearTrigger() [3/4]
| ClearTriggerResponse clearTrigger | ( | const std::string & | triggerId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
- Parameters
-
[in] triggerId ID for the trigger to be deactivated. [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ clearTrigger() [4/4]
| ClearTriggerResponse& clearTrigger | ( | const std::string & | triggerId, |
| const std::map< std::string, std::string > & | options, | ||
| ClearTriggerResponse & | response_ | ||
| ) | const |
Clears or cancels the trigger identified by the specified handle.
The output returns the handle of the trigger cleared as well as indicating success or failure of the trigger deactivation.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ collectStatistics() [1/4]
| CollectStatisticsResponse collectStatistics | ( | const CollectStatisticsRequest & | request_ | ) | const |
◆ collectStatistics() [2/4]
| CollectStatisticsResponse& collectStatistics | ( | const CollectStatisticsRequest & | request_, |
| CollectStatisticsResponse & | response_ | ||
| ) | const |
Collect statistics for a column(s) in a specified table.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ collectStatistics() [3/4]
| CollectStatisticsResponse collectStatistics | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Collect statistics for a column(s) in a specified table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ collectStatistics() [4/4]
| CollectStatisticsResponse& collectStatistics | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| CollectStatisticsResponse & | response_ | ||
| ) | const |
Collect statistics for a column(s) in a specified table.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createCredential() [1/4]
| CreateCredentialResponse createCredential | ( | const CreateCredentialRequest & | request_ | ) | const |
Create a new credential.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createCredential() [2/4]
| CreateCredentialResponse& createCredential | ( | const CreateCredentialRequest & | request_, |
| CreateCredentialResponse & | response_ | ||
| ) | const |
Create a new credential.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createCredential() [3/4]
| 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.
- Parameters
-
[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: - create_credential_aws_access_key
- create_credential_aws_iam_role
- create_credential_azure_ad
- create_credential_azure_oauth
- create_credential_azure_sas
- create_credential_azure_storage_key
- create_credential_confluent
- create_credential_docker
- create_credential_gcs_service_account_id
- create_credential_gcs_service_account_keys
- create_credential_hdfs
- create_credential_jdbc
- create_credential_kafka
- create_credential_nvidia_api_key
- create_credential_openai_api_key
[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.
- Returns
- Response object containing the result of the operation.
◆ createCredential() [4/4]
| 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.
- Parameters
-
[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: - create_credential_aws_access_key
- create_credential_aws_iam_role
- create_credential_azure_ad
- create_credential_azure_oauth
- create_credential_azure_sas
- create_credential_azure_storage_key
- create_credential_confluent
- create_credential_docker
- create_credential_gcs_service_account_id
- create_credential_gcs_service_account_keys
- create_credential_hdfs
- create_credential_jdbc
- create_credential_kafka
- create_credential_nvidia_api_key
- create_credential_openai_api_key
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createDatasink() [1/4]
| CreateDatasinkResponse createDatasink | ( | const CreateDatasinkRequest & | request_ | ) | const |
◆ createDatasink() [2/4]
| 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createDatasink() [3/4]
| 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.
- Parameters
-
[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. - create_datasink_connection_timeout: Timeout in seconds for connecting to this data sink
- create_datasink_wait_timeout: Timeout in seconds for waiting for a response from this data sink
- create_datasink_credential: Name of the credential object to be used in this data sink
- create_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink
- create_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located
-
create_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- create_datasink_true: Connect with SSL verification
- create_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
create_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
- create_datasink_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- create_datasink_false: Use path-style URI for requests.
- create_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- create_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- create_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- create_datasink_s3_encryption_type: Server side encryption type
- create_datasink_s3_kms_key_id: KMS key
- create_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- create_datasink_hdfs_delegation_token: Delegation token for the given HDFS user
- create_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is create_datasink_false.
- create_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified
- create_datasink_azure_container_name: Name of the Azure storage container to use as the data sink
- create_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID)
- create_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink
- create_datasink_azure_oauth_token: Oauth token to access given storage container
- create_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink
- create_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink
- create_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink
- create_datasink_jdbc_driver_jar_path: JDBC driver jar file location
- create_datasink_jdbc_driver_class_name: Name of the JDBC driver class
- create_datasink_kafka_topic_name: Name of the Kafka topic to publish to if destination is a Kafka broker
- create_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'.
- create_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'.
-
create_datasink_json_format: The desired format of JSON encoded notifications message. Supported values:
- create_datasink_flat: A single record is returned per message
- create_datasink_nested: Records are returned as an array per message
- create_datasink_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is create_datasink_false.
- create_datasink_use_https: Use https to connect to datasink if true, otherwise use http. Supported values: The default value is create_datasink_true.
- create_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: The default value is create_datasink_false.
- Returns
- Response object containing the result of the operation.
◆ createDatasink() [4/4]
| 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.
- Parameters
-
[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. - create_datasink_connection_timeout: Timeout in seconds for connecting to this data sink
- create_datasink_wait_timeout: Timeout in seconds for waiting for a response from this data sink
- create_datasink_credential: Name of the credential object to be used in this data sink
- create_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink
- create_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located
-
create_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- create_datasink_true: Connect with SSL verification
- create_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
create_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
- create_datasink_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- create_datasink_false: Use path-style URI for requests.
- create_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- create_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- create_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- create_datasink_s3_encryption_type: Server side encryption type
- create_datasink_s3_kms_key_id: KMS key
- create_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- create_datasink_hdfs_delegation_token: Delegation token for the given HDFS user
- create_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is create_datasink_false.
- create_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified
- create_datasink_azure_container_name: Name of the Azure storage container to use as the data sink
- create_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID)
- create_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink
- create_datasink_azure_oauth_token: Oauth token to access given storage container
- create_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink
- create_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink
- create_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink
- create_datasink_jdbc_driver_jar_path: JDBC driver jar file location
- create_datasink_jdbc_driver_class_name: Name of the JDBC driver class
- create_datasink_kafka_topic_name: Name of the Kafka topic to publish to if destination is a Kafka broker
- create_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'.
- create_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'.
-
create_datasink_json_format: The desired format of JSON encoded notifications message. Supported values:
- create_datasink_flat: A single record is returned per message
- create_datasink_nested: Records are returned as an array per message
- create_datasink_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is create_datasink_false.
- create_datasink_use_https: Use https to connect to datasink if true, otherwise use http. Supported values: The default value is create_datasink_true.
- create_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: The default value is create_datasink_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createDatasource() [1/4]
| 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createDatasource() [2/4]
| 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createDatasource() [3/4]
| 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.
- Parameters
-
[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. - create_datasource_skip_validation: Bypass validation of connection to remote source. Supported values: The default value is create_datasource_false.
- create_datasource_connection_timeout: Timeout in seconds for connecting to this storage provider
- create_datasource_wait_timeout: Timeout in seconds for reading from this storage provider
- create_datasource_credential: Name of the credential object to be used in data source
- create_datasource_s3_bucket_name: Name of the Amazon S3 bucket to use as the data source
- create_datasource_s3_region: Name of the Amazon S3 region where the given bucket is located
-
create_datasource_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- create_datasource_true: Connect with SSL verification
- create_datasource_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
create_datasource_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
- create_datasource_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- create_datasource_false: Use path-style URI for requests.
- create_datasource_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- create_datasource_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- create_datasource_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- create_datasource_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- create_datasource_hdfs_delegation_token: Delegation token for the given HDFS user
- create_datasource_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is create_datasource_false.
- create_datasource_azure_storage_account_name: Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified
- create_datasource_azure_container_name: Name of the Azure storage container to use as the data source
- create_datasource_azure_tenant_id: Active Directory tenant ID (or directory ID)
- create_datasource_azure_sas_token: Shared access signature token for Azure storage account to use as the data source
- create_datasource_azure_oauth_token: OAuth token to access given storage container
- create_datasource_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data source
- create_datasource_gcs_project_id: Name of the Google Cloud project to use as the data source
- create_datasource_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data source
- create_datasource_is_stream: To load from Azure/GCS/S3 as a stream continuously. Supported values: The default value is create_datasource_false.
- create_datasource_kafka_topic_name: Name of the Kafka topic to use as the data source
- create_datasource_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
- create_datasource_jdbc_driver_class_name: Name of the JDBC driver class
- create_datasource_anonymous: Use anonymous connection to storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: The default value is create_datasource_true.
- create_datasource_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is create_datasource_false.
- create_datasource_use_https: Use https to connect to datasource if true, otherwise use http. Supported values: The default value is create_datasource_true.
- create_datasource_schema_registry_location: Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format.
- create_datasource_schema_registry_credential: Confluent Schema Registry credential object name.
- create_datasource_schema_registry_port: Confluent Schema Registry port (optional).
- Returns
- Response object containing the result of the operation.
◆ createDatasource() [4/4]
| 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.
- Parameters
-
[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. - create_datasource_skip_validation: Bypass validation of connection to remote source. Supported values: The default value is create_datasource_false.
- create_datasource_connection_timeout: Timeout in seconds for connecting to this storage provider
- create_datasource_wait_timeout: Timeout in seconds for reading from this storage provider
- create_datasource_credential: Name of the credential object to be used in data source
- create_datasource_s3_bucket_name: Name of the Amazon S3 bucket to use as the data source
- create_datasource_s3_region: Name of the Amazon S3 region where the given bucket is located
-
create_datasource_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- create_datasource_true: Connect with SSL verification
- create_datasource_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
-
create_datasource_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
- create_datasource_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- create_datasource_false: Use path-style URI for requests.
- create_datasource_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
- create_datasource_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
- create_datasource_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
- create_datasource_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
- create_datasource_hdfs_delegation_token: Delegation token for the given HDFS user
- create_datasource_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: The default value is create_datasource_false.
- create_datasource_azure_storage_account_name: Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified
- create_datasource_azure_container_name: Name of the Azure storage container to use as the data source
- create_datasource_azure_tenant_id: Active Directory tenant ID (or directory ID)
- create_datasource_azure_sas_token: Shared access signature token for Azure storage account to use as the data source
- create_datasource_azure_oauth_token: OAuth token to access given storage container
- create_datasource_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data source
- create_datasource_gcs_project_id: Name of the Google Cloud project to use as the data source
- create_datasource_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data source
- create_datasource_is_stream: To load from Azure/GCS/S3 as a stream continuously. Supported values: The default value is create_datasource_false.
- create_datasource_kafka_topic_name: Name of the Kafka topic to use as the data source
- create_datasource_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
- create_datasource_jdbc_driver_class_name: Name of the JDBC driver class
- create_datasource_anonymous: Use anonymous connection to storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: The default value is create_datasource_true.
- create_datasource_use_managed_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: The default value is create_datasource_false.
- create_datasource_use_https: Use https to connect to datasource if true, otherwise use http. Supported values: The default value is create_datasource_true.
- create_datasource_schema_registry_location: Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format.
- create_datasource_schema_registry_credential: Confluent Schema Registry credential object name.
- create_datasource_schema_registry_port: Confluent Schema Registry port (optional).
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createDirectory() [1/4]
| CreateDirectoryResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createDirectory() [2/4]
| CreateDirectoryResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createDirectory() [3/4]
| CreateDirectoryResponse 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.
- Parameters
-
[in] directoryName Name of the directory in KiFS to be created. [in] options Optional parameters. - create_directory_create_home_directory: When set, a home directory is created for the user name provided in the value. The directoryName must be an empty string in this case. The user must exist.
- create_directory_data_limit: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
- create_directory_no_error_if_exists: If true, does not return an error if the directory already exists. Supported values: The default value is create_directory_false.
- Returns
- Response object containing the result of the operation.
◆ createDirectory() [4/4]
| CreateDirectoryResponse& 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.
- Parameters
-
[in] directoryName Name of the directory in KiFS to be created. [in] options Optional parameters. - create_directory_create_home_directory: When set, a home directory is created for the user name provided in the value. The directoryName must be an empty string in this case. The user must exist.
- create_directory_data_limit: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
- create_directory_no_error_if_exists: If true, does not return an error if the directory already exists. Supported values: The default value is create_directory_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createEnvironment() [1/4]
| CreateEnvironmentResponse createEnvironment | ( | const CreateEnvironmentRequest & | request_ | ) | const |
Creates a new environment which can be used by user-defined functions (UDF).
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createEnvironment() [2/4]
| CreateEnvironmentResponse& createEnvironment | ( | const CreateEnvironmentRequest & | request_, |
| CreateEnvironmentResponse & | response_ | ||
| ) | const |
Creates a new environment which can be used by user-defined functions (UDF).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createEnvironment() [3/4]
| 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).
- Parameters
-
[in] environmentName Name of the environment to be created. [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ createEnvironment() [4/4]
| 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).
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createGraph() [1/4]
| CreateGraphResponse createGraph | ( | const CreateGraphRequest & | request_ | ) | const |
Creates a new graph network using given nodes, edges, weights, and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createGraph() [2/4]
| CreateGraphResponse& createGraph | ( | const CreateGraphRequest & | request_, |
| CreateGraphResponse & | response_ | ||
| ) | const |
Creates a new graph network using given nodes, edges, weights, and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createGraph() [3/4]
| CreateGraphResponse createGraph | ( | const std::string & | graphName, |
| const bool | directedGraph, | ||
| const std::vector< std::string > & | nodes, | ||
| const std::vector< std::string > & | edges, | ||
| const std::vector< std::string > & | weights, | ||
| const std::vector< std::string > & | restrictions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new graph network using given nodes, edges, weights, and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
- Parameters
-
[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: - true
- false
[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. - create_graph_merge_tolerance: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-5'.
- create_graph_recreate: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values: The default value is create_graph_false.
- create_graph_save_persist: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values: The default value is create_graph_false.
- create_graph_add_table_monitor: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see createTableMonitor. Supported values: The default value is create_graph_false.
- create_graph_graph_table: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
- create_graph_add_turns: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values: The default value is create_graph_false.
- create_graph_is_partitioned: Supported values: The default value is create_graph_false.
- create_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
- create_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: The default value is create_graph_true.
- create_graph_label_delimiter: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
- create_graph_allow_multiple_edges: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values: The default value is create_graph_true.
- create_graph_embedding_table: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ createGraph() [4/4]
| CreateGraphResponse& createGraph | ( | const std::string & | graphName, |
| const bool | directedGraph, | ||
| const std::vector< std::string > & | nodes, | ||
| const std::vector< std::string > & | edges, | ||
| const std::vector< std::string > & | weights, | ||
| const std::vector< std::string > & | restrictions, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateGraphResponse & | response_ | ||
| ) | const |
Creates a new graph network using given nodes, edges, weights, and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some graph examples before using this endpoint.
- Parameters
-
[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: - true
- false
[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. - create_graph_merge_tolerance: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-5'.
- create_graph_recreate: If set to true and the graph (using graphName) already exists, the graph is deleted and recreated. Supported values: The default value is create_graph_false.
- create_graph_save_persist: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values: The default value is create_graph_false.
- create_graph_add_table_monitor: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see createTableMonitor. Supported values: The default value is create_graph_false.
- create_graph_graph_table: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
- create_graph_add_turns: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values: The default value is create_graph_false.
- create_graph_is_partitioned: Supported values: The default value is create_graph_false.
- create_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server with the most available memory.
- create_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: The default value is create_graph_true.
- create_graph_label_delimiter: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
- create_graph_allow_multiple_edges: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values: The default value is create_graph_true.
- create_graph_embedding_table: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createJob() [1/4]
| CreateJobResponse createJob | ( | const CreateJobRequest & | request_ | ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createJob() [2/4]
| CreateJobResponse& createJob | ( | const CreateJobRequest & | request_, |
| CreateJobResponse & | response_ | ||
| ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createJob() [3/4]
| CreateJobResponse 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.
- Parameters
-
[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. - create_job_remove_job_on_complete: Supported values:
- create_job_job_tag: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-'
- Returns
- Response object containing the result of the operation.
◆ createJob() [4/4]
| CreateJobResponse& createJob | ( | const std::string & | endpoint, |
| const std::string & | requestEncoding, | ||
| const std::vector< uint8_t > & | data, | ||
| const std::string & | dataStr, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateJobResponse & | response_ | ||
| ) | const |
Create a job which will run asynchronously.
The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob.
- Parameters
-
[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. - create_job_remove_job_on_complete: Supported values:
- create_job_job_tag: Tag to use for submitted job. The same tag could be used on backup cluster to retrieve response for the job. Tags can use letter, numbers, '_' and '-'
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createJoinTable() [1/4]
| CreateJoinTableResponse createJoinTable | ( | const CreateJoinTableRequest & | request_ | ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createJoinTable() [2/4]
| CreateJoinTableResponse& createJoinTable | ( | const CreateJoinTableRequest & | request_, |
| CreateJoinTableResponse & | response_ | ||
| ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createJoinTable() [3/4]
| CreateJoinTableResponse createJoinTable | ( | const std::string & | joinTableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
- Parameters
-
[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. - create_join_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of joinTableName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_join_table_name. Supported values: The default value is create_join_table_false.
- create_join_table_collection_name: [DEPRECATED–please specify the containing schema for the join as part of joinTableName and use createSchema to create the schema if non-existent] Name of a schema for the join. If the schema is non-existent, it will be automatically created. The default value is ''.
- create_join_table_max_query_dimensions: No longer used.
- create_join_table_optimize_lookups: Use more memory to speed up the joining of tables. Supported values: The default value is create_join_table_false.
- create_join_table_strategy_definition: The tier strategy for the table and its columns.
- create_join_table_ttl: Sets the TTL of the join table specified in joinTableName.
- create_join_table_view_id: view this projection is part of. The default value is ''.
- create_join_table_no_count: Return a count of 0 for the join table for logging and for showTable; optimization needed for large overlapped equi-join stencils. The default value is 'false'.
- create_join_table_chunk_size: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size
- create_join_table_enable_virtual_chunking: Collect chunks with accumulated size less than chunk_size into a single chunk. The default value is 'false'.
- create_join_table_enable_pk_equi_join: Use equi-join to do primary key joins rather than using primary-key-index
- Returns
- Response object containing the result of the operation.
◆ createJoinTable() [4/4]
| CreateJoinTableResponse& createJoinTable | ( | const std::string & | joinTableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateJoinTableResponse & | response_ | ||
| ) | const |
Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
- Parameters
-
[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. - create_join_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of joinTableName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_join_table_name. Supported values: The default value is create_join_table_false.
- create_join_table_collection_name: [DEPRECATED–please specify the containing schema for the join as part of joinTableName and use createSchema to create the schema if non-existent] Name of a schema for the join. If the schema is non-existent, it will be automatically created. The default value is ''.
- create_join_table_max_query_dimensions: No longer used.
- create_join_table_optimize_lookups: Use more memory to speed up the joining of tables. Supported values: The default value is create_join_table_false.
- create_join_table_strategy_definition: The tier strategy for the table and its columns.
- create_join_table_ttl: Sets the TTL of the join table specified in joinTableName.
- create_join_table_view_id: view this projection is part of. The default value is ''.
- create_join_table_no_count: Return a count of 0 for the join table for logging and for showTable; optimization needed for large overlapped equi-join stencils. The default value is 'false'.
- create_join_table_chunk_size: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size
- create_join_table_enable_virtual_chunking: Collect chunks with accumulated size less than chunk_size into a single chunk. The default value is 'false'.
- create_join_table_enable_pk_equi_join: Use equi-join to do primary key joins rather than using primary-key-index
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createMaterializedView() [1/4]
| CreateMaterializedViewResponse createMaterializedView | ( | const CreateMaterializedViewRequest & | request_ | ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createMaterializedView() [2/4]
| CreateMaterializedViewResponse& createMaterializedView | ( | const CreateMaterializedViewRequest & | request_, |
| CreateMaterializedViewResponse & | response_ | ||
| ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createMaterializedView() [3/4]
| CreateMaterializedViewResponse createMaterializedView | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
- Parameters
-
[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. - create_materialized_view_collection_name: [DEPRECATED–please specify the containing schema for the materialized view as part of tableName and use createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
- create_materialized_view_execute_as: User name to use to run the refresh job
-
create_materialized_view_build_materialized_view_policy: Sets startup materialized view rebuild scheme. Supported values:
- create_materialized_view_always: Rebuild as many materialized views as possible before accepting requests.
- create_materialized_view_lazy: Rebuild the necessary materialized views at start, and load the remainder lazily.
- create_materialized_view_on_demand: Rebuild materialized views as requests use them.
- create_materialized_view_system: Rebuild materialized views using the system-configured default.
- create_materialized_view_persist: If true, then the materialized view specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is create_materialized_view_false.
- create_materialized_view_refresh_span: Sets the future time-offset(in seconds) at which periodic refresh stops
- create_materialized_view_refresh_stop_time: When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
-
create_materialized_view_refresh_method: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
- create_materialized_view_manual: Refresh only occurs when manually requested by calling alterTable with an 'action' of 'refresh'
- create_materialized_view_on_query: Refresh any time the view is queried.
- create_materialized_view_on_change: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
- create_materialized_view_periodic: Refresh table periodically at rate specified by refresh_period
- create_materialized_view_refresh_period: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
- create_materialized_view_refresh_start_time: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
- create_materialized_view_ttl: Sets the TTL of the table specified in tableName.
- Returns
- Response object containing the result of the operation.
◆ createMaterializedView() [4/4]
| CreateMaterializedViewResponse& createMaterializedView | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateMaterializedViewResponse & | response_ | ||
| ) | const |
Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
For materialized view details and examples, see Materialized Views.
The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
- Parameters
-
[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. - create_materialized_view_collection_name: [DEPRECATED–please specify the containing schema for the materialized view as part of tableName and use createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema provided is non-existent, it will be automatically created.
- create_materialized_view_execute_as: User name to use to run the refresh job
-
create_materialized_view_build_materialized_view_policy: Sets startup materialized view rebuild scheme. Supported values:
- create_materialized_view_always: Rebuild as many materialized views as possible before accepting requests.
- create_materialized_view_lazy: Rebuild the necessary materialized views at start, and load the remainder lazily.
- create_materialized_view_on_demand: Rebuild materialized views as requests use them.
- create_materialized_view_system: Rebuild materialized views using the system-configured default.
- create_materialized_view_persist: If true, then the materialized view specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is create_materialized_view_false.
- create_materialized_view_refresh_span: Sets the future time-offset(in seconds) at which periodic refresh stops
- create_materialized_view_refresh_stop_time: When refresh_method is periodic, specifies the time at which a periodic refresh is stopped. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
-
create_materialized_view_refresh_method: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
- create_materialized_view_manual: Refresh only occurs when manually requested by calling alterTable with an 'action' of 'refresh'
- create_materialized_view_on_query: Refresh any time the view is queried.
- create_materialized_view_on_change: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
- create_materialized_view_periodic: Refresh table periodically at rate specified by refresh_period
- create_materialized_view_refresh_period: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
- create_materialized_view_refresh_start_time: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
- create_materialized_view_ttl: Sets the TTL of the table specified in tableName.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createProc() [1/4]
| CreateProcResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createProc() [2/4]
| 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createProc() [3/4]
| CreateProcResponse 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.
- Parameters
-
[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: - create_proc_distributed: Input table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data.
- create_proc_nondistributed: The proc command will be invoked only once per execution, and will not have direct access to any tables named as input or output table parameters in the call to executeProc. It will, however, be able to access the database using native API calls.
[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. - create_proc_max_concurrency_per_node: The maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is '0'.
- create_proc_set_environment: A python environment to use when executing the proc. Must be an existing environment, else an error will be returned. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ createProc() [4/4]
| 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.
- Parameters
-
[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: - create_proc_distributed: Input table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data.
- create_proc_nondistributed: The proc command will be invoked only once per execution, and will not have direct access to any tables named as input or output table parameters in the call to executeProc. It will, however, be able to access the database using native API calls.
[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. - create_proc_max_concurrency_per_node: The maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is '0'.
- create_proc_set_environment: A python environment to use when executing the proc. Must be an existing environment, else an error will be returned. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createProjection() [1/4]
| CreateProjectionResponse createProjection | ( | const CreateProjectionRequest & | request_ | ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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)).
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createProjection() [2/4]
| CreateProjectionResponse& createProjection | ( | const CreateProjectionRequest & | request_, |
| CreateProjectionResponse & | response_ | ||
| ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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)).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createProjection() [3/4]
| CreateProjectionResponse 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)).
- Parameters
-
[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. - create_projection_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of projectionName. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_projection_name. Supported values: The default value is create_projection_false.
- create_projection_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of projectionName and use createSchema to create the schema if non-existent] Name of a schema for the projection. If the schema is non-existent, it will be automatically created. The default value is ''.
- create_projection_expression: An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
- create_projection_is_replicated: If true then the projection will be replicated even if the source table is not. Supported values: The default value is create_projection_false.
- create_projection_offset: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
- create_projection_limit: The number of records to keep. The default value is '-9999'.
- create_projection_order_by: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- create_projection_chunk_size: Indicates the number of records per chunk to be used for this projection.
- create_projection_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this projection.
- create_projection_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this projection.
- create_projection_create_indexes: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.
- create_projection_ttl: Sets the TTL of the projection specified in projectionName.
- create_projection_shard_key: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- create_projection_persist: If true, then the projection specified in projectionName will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is create_projection_false.
- create_projection_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values: The default value is create_projection_true.
- create_projection_retain_partitions: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: The default value is create_projection_false.
- create_projection_partition_type: Partitioning scheme to use. Supported values:
- create_projection_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_projection_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_projection_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is create_projection_false.
- create_projection_view_id: ID of view of which this projection is a member. The default value is ''.
- create_projection_strategy_definition: The tier strategy for the table and its columns.
- create_projection_join_window_functions: If set, window functions which require a reshard will be computed separately and joined back together, if the width of the projection is greater than the join_window_functions_threshold. The default value is 'true'.
- create_projection_join_window_functions_threshold: If the projection is greater than this width (in bytes), then window functions which require a reshard will be computed separately and joined back together. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ createProjection() [4/4]
| CreateProjectionResponse& createProjection | ( | const std::string & | tableName, |
| const std::string & | projectionName, | ||
| const std::vector< std::string > & | columnNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateProjectionResponse & | response_ | ||
| ) | const |
Creates a new projection of an existing table.
A projection represents a subset of the columns (potentially including derived columns) of a table.
For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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)).
- Parameters
-
[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. - create_projection_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of projectionName. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_projection_name. Supported values: The default value is create_projection_false.
- create_projection_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of projectionName and use createSchema to create the schema if non-existent] Name of a schema for the projection. If the schema is non-existent, it will be automatically created. The default value is ''.
- create_projection_expression: An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
- create_projection_is_replicated: If true then the projection will be replicated even if the source table is not. Supported values: The default value is create_projection_false.
- create_projection_offset: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
- create_projection_limit: The number of records to keep. The default value is '-9999'.
- create_projection_order_by: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- create_projection_chunk_size: Indicates the number of records per chunk to be used for this projection.
- create_projection_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this projection.
- create_projection_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this projection.
- create_projection_create_indexes: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.
- create_projection_ttl: Sets the TTL of the projection specified in projectionName.
- create_projection_shard_key: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
- create_projection_persist: If true, then the projection specified in projectionName will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is create_projection_false.
- create_projection_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values: The default value is create_projection_true.
- create_projection_retain_partitions: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: The default value is create_projection_false.
- create_projection_partition_type: Partitioning scheme to use. Supported values:
- create_projection_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_projection_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_projection_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is create_projection_false.
- create_projection_view_id: ID of view of which this projection is a member. The default value is ''.
- create_projection_strategy_definition: The tier strategy for the table and its columns.
- create_projection_join_window_functions: If set, window functions which require a reshard will be computed separately and joined back together, if the width of the projection is greater than the join_window_functions_threshold. The default value is 'true'.
- create_projection_join_window_functions_threshold: If the projection is greater than this width (in bytes), then window functions which require a reshard will be computed separately and joined back together. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createResourceGroup() [1/4]
| CreateResourceGroupResponse createResourceGroup | ( | const CreateResourceGroupRequest & | request_ | ) | const |
◆ createResourceGroup() [2/4]
| CreateResourceGroupResponse& createResourceGroup | ( | const CreateResourceGroupRequest & | request_, |
| CreateResourceGroupResponse & | response_ | ||
| ) | const |
Creates a new resource group to facilitate resource management.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createResourceGroup() [3/4]
| CreateResourceGroupResponse createResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::map< std::string, std::string > > & | tierAttributes, | ||
| const std::string & | ranking, | ||
| const std::string & | adjoiningResourceGroup, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new resource group to facilitate resource management.
- Parameters
-
[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'}}. - create_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group.
[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. - create_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
- create_resource_group_max_data: Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is '-1'.
- create_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
- create_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'.
- Returns
- Response object containing the result of the operation.
◆ createResourceGroup() [4/4]
| CreateResourceGroupResponse& createResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::map< std::string, std::string > > & | tierAttributes, | ||
| const std::string & | ranking, | ||
| const std::string & | adjoiningResourceGroup, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateResourceGroupResponse & | response_ | ||
| ) | const |
Creates a new resource group to facilitate resource management.
- Parameters
-
[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'}}. - create_resource_group_max_memory: Maximum amount of memory usable in the given tier at one time for this group.
[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. - create_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is '4'.
- create_resource_group_max_data: Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is '-1'.
- create_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is '1'. The maximum allowed value is '100'.
- create_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. The minimum allowed value is '1'. The maximum allowed value is '10'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createRole() [1/4]
| CreateRoleResponse createRole | ( | const CreateRoleRequest & | request_ | ) | const |
◆ createRole() [2/4]
| CreateRoleResponse& createRole | ( | const CreateRoleRequest & | request_, |
| CreateRoleResponse & | response_ | ||
| ) | const |
Creates a new role.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createRole() [3/4]
| CreateRoleResponse createRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new role.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - create_role_resource_group: Name of an existing resource group to associate with this user
- Returns
- Response object containing the result of the operation.
◆ createRole() [4/4]
| CreateRoleResponse& createRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| CreateRoleResponse & | response_ | ||
| ) | const |
Creates a new role.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. - create_role_resource_group: Name of an existing resource group to associate with this user
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createSchema() [1/4]
| CreateSchemaResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createSchema() [2/4]
| CreateSchemaResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createSchema() [3/4]
| CreateSchemaResponse 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.
- Parameters
-
[in] schemaName Name of the schema to be created. Has the same naming restrictions as tables. [in] options Optional parameters. - create_schema_no_error_if_exists: If true, prevents an error from occurring if the schema already exists. Supported values: The default value is create_schema_false.
- Returns
- Response object containing the result of the operation.
◆ createSchema() [4/4]
| CreateSchemaResponse& 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.
- Parameters
-
[in] schemaName Name of the schema to be created. Has the same naming restrictions as tables. [in] options Optional parameters. - create_schema_no_error_if_exists: If true, prevents an error from occurring if the schema already exists. Supported values: The default value is create_schema_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTable() [1/4]
| CreateTableResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createTable() [2/4]
| CreateTableResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTable() [3/4]
| CreateTableResponse 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.
- Parameters
-
[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. - create_table_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: The default value is create_table_false.
- create_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If is_result_table is true, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is create_table_false.
- create_table_collection_name: [DEPRECATED–please specify the containing schema as part of tableName and use createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
- create_table_is_collection: [DEPRECATED–please use createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values: The default value is create_table_false.
- create_table_disallow_homogeneous_tables: No longer supported; value will be ignored. Supported values: The default value is create_table_false.
- create_table_is_replicated: Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is create_table_false.
- create_table_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- create_table_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- create_table_partition_type: Partitioning scheme to use. Supported values:
- create_table_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_table_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_table_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is create_table_false.
- create_table_ttl: Sets the TTL of the table specified in tableName.
- create_table_chunk_size: Indicates the number of records per chunk to be used for this table.
- create_table_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- create_table_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- create_table_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with store_only or text_search data-handling or that are non-charN strings, and it will not be retained if the server is restarted. Supported values: The default value is create_table_false.
- create_table_strategy_definition: The tier strategy for the table and its columns.
-
create_table_load_vectors_policy: Set startup data loading scheme for the table. Supported values:
- create_table_always: Load as much vector data as possible into memory before accepting requests.
- create_table_lazy: Load the necessary vector data at start, and load the remainder lazily.
- create_table_on_demand: Load vector data as requests use it.
- create_table_system: Load vector data using the system-configured default.
-
create_table_build_pk_index_policy: Set startup primary-key index generation scheme for the table. Supported values:
- create_table_always: Generate as much primary key index data as possible before accepting requests.
- create_table_lazy: Generate the necessary primary key index data at start, and load the remainder lazily.
- create_table_on_demand: Generate primary key index data as requests use it.
- create_table_system: Generate primary key index data using the system-configured default.
- Returns
- Response object containing the result of the operation.
◆ createTable() [4/4]
| 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.
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.
- Parameters
-
[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. - create_table_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: The default value is create_table_false.
- create_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If is_result_table is true, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is create_table_false.
- create_table_collection_name: [DEPRECATED–please specify the containing schema as part of tableName and use createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.
- create_table_is_collection: [DEPRECATED–please use createSchema to create a schema instead] Indicates whether to create a schema instead of a table. Supported values: The default value is create_table_false.
- create_table_disallow_homogeneous_tables: No longer supported; value will be ignored. Supported values: The default value is create_table_false.
- create_table_is_replicated: Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is create_table_false.
- create_table_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- create_table_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- create_table_partition_type: Partitioning scheme to use. Supported values:
- create_table_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_table_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_table_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is create_table_false.
- create_table_ttl: Sets the TTL of the table specified in tableName.
- create_table_chunk_size: Indicates the number of records per chunk to be used for this table.
- create_table_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- create_table_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- create_table_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with store_only or text_search data-handling or that are non-charN strings, and it will not be retained if the server is restarted. Supported values: The default value is create_table_false.
- create_table_strategy_definition: The tier strategy for the table and its columns.
-
create_table_load_vectors_policy: Set startup data loading scheme for the table. Supported values:
- create_table_always: Load as much vector data as possible into memory before accepting requests.
- create_table_lazy: Load the necessary vector data at start, and load the remainder lazily.
- create_table_on_demand: Load vector data as requests use it.
- create_table_system: Load vector data using the system-configured default.
-
create_table_build_pk_index_policy: Set startup primary-key index generation scheme for the table. Supported values:
- create_table_always: Generate as much primary key index data as possible before accepting requests.
- create_table_lazy: Generate the necessary primary key index data at start, and load the remainder lazily.
- create_table_on_demand: Generate primary key index data as requests use it.
- create_table_system: Generate primary key index data using the system-configured default.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTableExternal() [1/4]
| 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.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createTableExternal() [2/4]
| 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.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTableExternal() [3/4]
| 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.
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.
- Parameters
-
[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. - create_table_external_type_id: ID of a currently registered type.
- create_table_external_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same name but a different type exists, it is still an error. Supported values: The default value is create_table_external_false.
- create_table_external_is_replicated: Affects the distribution scheme for the table's data. If true and the given table has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is create_table_external_false.
- create_table_external_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- create_table_external_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- create_table_external_partition_type: Partitioning scheme to use. Supported values:
- create_table_external_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_table_external_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_table_external_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently, only supported for list partitions. Supported values: The default value is create_table_external_false.
- create_table_external_ttl: Sets the TTL of the table specified in tableName.
- create_table_external_chunk_size: Indicates the number of records per chunk to be used for this table.
- create_table_external_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- create_table_external_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- create_table_external_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is create_table_external_false.
- create_table_external_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - create_table_external_bad_record_table_name: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When error_handling is abort, bad records table is not populated.
- create_table_external_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. The default value is '10000'.
- create_table_external_bad_record_table_limit_per_input: For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be bad_record_table_limit and total size of the table per rank is limited to bad_record_table_limit.
- create_table_external_batch_size: Number of records to insert per batch when inserting data. The default value is '50000'.
- create_table_external_column_formats: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- create_table_external_columns_to_load: Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns_to_skip.
- create_table_external_columns_to_skip: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
-
create_table_external_compression_type: Source data compression type. Supported values:
- create_table_external_none: No compression.
- create_table_external_auto: Auto detect compression type
- create_table_external_gzip: gzip file compression.
- create_table_external_bzip2: bzip2 file compression.
- create_table_external_datasource_name: Name of an existing external data source from which data file(s) specified in filepaths will be loaded
- create_table_external_default_column_formats: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to interpret text as "05/04/2000 12:12:11"
-
create_table_external_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- create_table_external_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- create_table_external_ignore_bad_records: Malformed records are skipped.
- create_table_external_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
create_table_external_external_table_type: Specifies whether the external table holds a local copy of the external data. Supported values:
- create_table_external_materialized: Loads a copy of the external data into the database, refreshed on demand
- create_table_external_logical: External data will not be loaded into the database; the data will be retrieved from the source upon servicing each query against the external table
-
create_table_external_file_type: Specifies the type of the file(s) whose records will be inserted. Supported values:
- create_table_external_avro: Avro file format
- create_table_external_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- create_table_external_gdb: Esri/GDB file format
- create_table_external_json: Json file format
- create_table_external_parquet: Apache Parquet file format
- create_table_external_shapefile: ShapeFile file format
-
create_table_external_flatten_columns: Specifies how to handle nested columns. Supported values:
- create_table_external_true: Break up nested columns to multiple columns
- create_table_external_false: Treat nested columns as json columns instead of flattening
- create_table_external_gdal_configuration_options: Comma separated list of gdal conf options, for the specific requets: key=value
-
create_table_external_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- create_table_external_true: Ignore new records whose primary key values collide with those of existing records
- create_table_external_false: Treat as errors any new records whose primary key values collide with those of existing records
-
create_table_external_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- create_table_external_full: Run a type inference on the source data (if needed) and ingest
- create_table_external_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- create_table_external_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- create_table_external_jdbc_fetch_size: The JDBC fetch size, which determines how many rows to fetch per round trip. The default value is '50000'.
- create_table_external_kafka_consumers_per_rank: Number of Kafka consumer threads per rank (valid range 1-6). The default value is '1'.
- create_table_external_kafka_group_id: The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
- create_table_external_kafka_offset_reset_policy: Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. Supported values: The default value is create_table_external_earliest.
- create_table_external_kafka_optimistic_ingest: Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. Supported values: The default value is create_table_external_false.
- create_table_external_kafka_subscription_cancel_after: Sets the Kafka subscription lifespan (in minutes). Expired subscription will be cancelled automatically.
- create_table_external_kafka_type_inference_fetch_timeout: Maximum time to collect Kafka messages before type inferencing on the set of them.
- create_table_external_layer: Geo files layer(s) name(s): comma separated.
-
create_table_external_loading_mode: Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
- create_table_external_head: The head node loads all data. All files must be available to the head node.
- create_table_external_distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- create_table_external_distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
- create_table_external_local_time_offset: Apply an offset to Avro local timestamp columns.
- create_table_external_max_records_to_load: Limit the number of records to load in this request: if this number is larger than batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread).
- create_table_external_num_tasks_per_rank: Number of tasks for reading file per rank. Default will be system configuration parameter, external_file_reader_num_tasks.
- create_table_external_poll_interval: If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is '0'.
- create_table_external_primary_keys: Comma separated list of column names to set as primary keys, when not specified in the type.
-
create_table_external_refresh_method: Method by which the table can be refreshed from its source data. Supported values:
- create_table_external_manual: Refresh only occurs when manually requested by invoking the refresh action of alterTable on this table.
- create_table_external_on_start: Refresh table on database startup and when manually requested by invoking the refresh action of alterTable on this table.
- create_table_external_schema_registry_schema_name: Name of the Avro schema in the schema registry to use when reading Avro records.
- create_table_external_shard_keys: Comma separated list of column names to set as shard keys, when not specified in the type.
- create_table_external_skip_lines: Skip number of lines from begining of file.
- create_table_external_start_offsets: Starting offsets by partition to fetch from kafka. A comma separated list of partition:offset pairs.
- create_table_external_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is create_table_external_false.
-
create_table_external_table_insert_mode: Insertion scheme to use when inserting records from multiple shapefiles. Supported values:
- create_table_external_single: Insert all records into a single table.
- create_table_external_table_per_file: Insert records from each file into a new table corresponding to that file.
- create_table_external_text_comment_string: Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited_text file_type only. The default value is '#'.
- create_table_external_text_delimiter: Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- create_table_external_text_escape_character: Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, & vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited_text file_type only.
- create_table_external_text_has_header: Indicates whether the source data contains a header row. For delimited_text file_type only. Supported values: The default value is create_table_external_true.
- create_table_external_text_header_property_delimiter: Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. For delimited_text file_type only. The default value is '|'.
- create_table_external_text_null_string: Specifies the character string that should be interpreted as a null value in the source data. For delimited_text file_type only. The default value is '\N'.
- create_table_external_text_quote_character: Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited_text file_type only. The default value is '"'.
- create_table_external_text_search_columns: Add 'text_search' property to internally inferenced string columns. Comma seperated list of column names or '*' for all columns. To add 'text_search' property only to string columns greater than or equal to a minimum size, also set the text_search_min_column_length
- create_table_external_text_search_min_column_length: Set the minimum column size for strings to apply the 'text_search' property to. Used only when text_search_columns has a value.
- create_table_external_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is create_table_external_false.
- create_table_external_truncate_table: If set to true, truncates the table specified by tableName prior to loading the file(s). Supported values: The default value is create_table_external_false.
-
create_table_external_type_inference_mode: Optimize type inferencing for either speed or accuracy. Supported values:
- create_table_external_accuracy: Scans data to get exactly-typed & sized columns for all data scanned.
- create_table_external_speed: Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned
- create_table_external_remote_query: Remote SQL query from which data will be sourced
- create_table_external_remote_query_filter_column: Name of column to be used for splitting remote_query into multiple sub-queries using the data distribution of given column
- create_table_external_remote_query_increasing_column: Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP).
- create_table_external_remote_query_partition_column: Alias name for remote_query_filter_column.
-
create_table_external_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be 'upserted'). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- create_table_external_true: Upsert new records when primary keys match existing records
- create_table_external_false: Reject new records when primary keys match existing records
- Returns
- Response object containing the result of the operation.
◆ createTableExternal() [4/4]
| 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.
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.
- Parameters
-
[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. - create_table_external_type_id: ID of a currently registered type.
- create_table_external_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same name but a different type exists, it is still an error. Supported values: The default value is create_table_external_false.
- create_table_external_is_replicated: Affects the distribution scheme for the table's data. If true and the given table has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is create_table_external_false.
- create_table_external_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- create_table_external_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- create_table_external_partition_type: Partitioning scheme to use. Supported values:
- create_table_external_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- create_table_external_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- create_table_external_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently, only supported for list partitions. Supported values: The default value is create_table_external_false.
- create_table_external_ttl: Sets the TTL of the table specified in tableName.
- create_table_external_chunk_size: Indicates the number of records per chunk to be used for this table.
- create_table_external_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- create_table_external_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- create_table_external_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is create_table_external_false.
- create_table_external_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - create_table_external_bad_record_table_name: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When error_handling is abort, bad records table is not populated.
- create_table_external_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. The default value is '10000'.
- create_table_external_bad_record_table_limit_per_input: For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be bad_record_table_limit and total size of the table per rank is limited to bad_record_table_limit.
- create_table_external_batch_size: Number of records to insert per batch when inserting data. The default value is '50000'.
- create_table_external_column_formats: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- create_table_external_columns_to_load: Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns_to_skip.
- create_table_external_columns_to_skip: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
-
create_table_external_compression_type: Source data compression type. Supported values:
- create_table_external_none: No compression.
- create_table_external_auto: Auto detect compression type
- create_table_external_gzip: gzip file compression.
- create_table_external_bzip2: bzip2 file compression.
- create_table_external_datasource_name: Name of an existing external data source from which data file(s) specified in filepaths will be loaded
- create_table_external_default_column_formats: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to interpret text as "05/04/2000 12:12:11"
-
create_table_external_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- create_table_external_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- create_table_external_ignore_bad_records: Malformed records are skipped.
- create_table_external_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
create_table_external_external_table_type: Specifies whether the external table holds a local copy of the external data. Supported values:
- create_table_external_materialized: Loads a copy of the external data into the database, refreshed on demand
- create_table_external_logical: External data will not be loaded into the database; the data will be retrieved from the source upon servicing each query against the external table
-
create_table_external_file_type: Specifies the type of the file(s) whose records will be inserted. Supported values:
- create_table_external_avro: Avro file format
- create_table_external_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- create_table_external_gdb: Esri/GDB file format
- create_table_external_json: Json file format
- create_table_external_parquet: Apache Parquet file format
- create_table_external_shapefile: ShapeFile file format
-
create_table_external_flatten_columns: Specifies how to handle nested columns. Supported values:
- create_table_external_true: Break up nested columns to multiple columns
- create_table_external_false: Treat nested columns as json columns instead of flattening
- create_table_external_gdal_configuration_options: Comma separated list of gdal conf options, for the specific requets: key=value
-
create_table_external_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- create_table_external_true: Ignore new records whose primary key values collide with those of existing records
- create_table_external_false: Treat as errors any new records whose primary key values collide with those of existing records
-
create_table_external_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- create_table_external_full: Run a type inference on the source data (if needed) and ingest
- create_table_external_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- create_table_external_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- create_table_external_jdbc_fetch_size: The JDBC fetch size, which determines how many rows to fetch per round trip. The default value is '50000'.
- create_table_external_kafka_consumers_per_rank: Number of Kafka consumer threads per rank (valid range 1-6). The default value is '1'.
- create_table_external_kafka_group_id: The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
- create_table_external_kafka_offset_reset_policy: Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. Supported values: The default value is create_table_external_earliest.
- create_table_external_kafka_optimistic_ingest: Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. Supported values: The default value is create_table_external_false.
- create_table_external_kafka_subscription_cancel_after: Sets the Kafka subscription lifespan (in minutes). Expired subscription will be cancelled automatically.
- create_table_external_kafka_type_inference_fetch_timeout: Maximum time to collect Kafka messages before type inferencing on the set of them.
- create_table_external_layer: Geo files layer(s) name(s): comma separated.
-
create_table_external_loading_mode: Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
- create_table_external_head: The head node loads all data. All files must be available to the head node.
- create_table_external_distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- create_table_external_distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
- create_table_external_local_time_offset: Apply an offset to Avro local timestamp columns.
- create_table_external_max_records_to_load: Limit the number of records to load in this request: if this number is larger than batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread).
- create_table_external_num_tasks_per_rank: Number of tasks for reading file per rank. Default will be system configuration parameter, external_file_reader_num_tasks.
- create_table_external_poll_interval: If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is '0'.
- create_table_external_primary_keys: Comma separated list of column names to set as primary keys, when not specified in the type.
-
create_table_external_refresh_method: Method by which the table can be refreshed from its source data. Supported values:
- create_table_external_manual: Refresh only occurs when manually requested by invoking the refresh action of alterTable on this table.
- create_table_external_on_start: Refresh table on database startup and when manually requested by invoking the refresh action of alterTable on this table.
- create_table_external_schema_registry_schema_name: Name of the Avro schema in the schema registry to use when reading Avro records.
- create_table_external_shard_keys: Comma separated list of column names to set as shard keys, when not specified in the type.
- create_table_external_skip_lines: Skip number of lines from begining of file.
- create_table_external_start_offsets: Starting offsets by partition to fetch from kafka. A comma separated list of partition:offset pairs.
- create_table_external_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is create_table_external_false.
-
create_table_external_table_insert_mode: Insertion scheme to use when inserting records from multiple shapefiles. Supported values:
- create_table_external_single: Insert all records into a single table.
- create_table_external_table_per_file: Insert records from each file into a new table corresponding to that file.
- create_table_external_text_comment_string: Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited_text file_type only. The default value is '#'.
- create_table_external_text_delimiter: Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- create_table_external_text_escape_character: Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, & vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited_text file_type only.
- create_table_external_text_has_header: Indicates whether the source data contains a header row. For delimited_text file_type only. Supported values: The default value is create_table_external_true.
- create_table_external_text_header_property_delimiter: Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. For delimited_text file_type only. The default value is '|'.
- create_table_external_text_null_string: Specifies the character string that should be interpreted as a null value in the source data. For delimited_text file_type only. The default value is '\N'.
- create_table_external_text_quote_character: Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited_text file_type only. The default value is '"'.
- create_table_external_text_search_columns: Add 'text_search' property to internally inferenced string columns. Comma seperated list of column names or '*' for all columns. To add 'text_search' property only to string columns greater than or equal to a minimum size, also set the text_search_min_column_length
- create_table_external_text_search_min_column_length: Set the minimum column size for strings to apply the 'text_search' property to. Used only when text_search_columns has a value.
- create_table_external_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is create_table_external_false.
- create_table_external_truncate_table: If set to true, truncates the table specified by tableName prior to loading the file(s). Supported values: The default value is create_table_external_false.
-
create_table_external_type_inference_mode: Optimize type inferencing for either speed or accuracy. Supported values:
- create_table_external_accuracy: Scans data to get exactly-typed & sized columns for all data scanned.
- create_table_external_speed: Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned
- create_table_external_remote_query: Remote SQL query from which data will be sourced
- create_table_external_remote_query_filter_column: Name of column to be used for splitting remote_query into multiple sub-queries using the data distribution of given column
- create_table_external_remote_query_increasing_column: Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP).
- create_table_external_remote_query_partition_column: Alias name for remote_query_filter_column.
-
create_table_external_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be 'upserted'). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- create_table_external_true: Upsert new records when primary keys match existing records
- create_table_external_false: Reject new records when primary keys match existing records
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTableMonitor() [1/4]
| CreateTableMonitorResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createTableMonitor() [2/4]
| CreateTableMonitorResponse& createTableMonitor | ( | const CreateTableMonitorRequest & | request_, |
| CreateTableMonitorResponse & | response_ | ||
| ) | const |
Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.
After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor.
For more information on table monitors, see Table Monitors.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTableMonitor() [3/4]
| CreateTableMonitorResponse createTableMonitor | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.
After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor.
For more information on table monitors, see Table Monitors.
- Parameters
-
[in] tableName Name of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules. [in] options Optional parameters. -
create_table_monitor_event: Type of modification event on the target table to be monitored by this table monitor. Supported values:
- create_table_monitor_insert: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
- create_table_monitor_update: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
- create_table_monitor_delete: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
- create_table_monitor_monitor_id: ID to use for this monitor instead of a randomly generated one
- create_table_monitor_datasink_name: Name of an existing data sink to send change data notifications to
- create_table_monitor_destination: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'.
- create_table_monitor_kafka_topic_name: Name of the Kafka topic to publish to if destination in options is specified and is a Kafka broker
- create_table_monitor_increasing_column: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
- create_table_monitor_expression: Filter expression to limit records for notification
-
create_table_monitor_refresh_method: Method controlling when the table monitor reports changes to the tableName. Supported values:
- create_table_monitor_on_change: Report changes as they occur.
- create_table_monitor_periodic: Report changes periodically at rate specified by refresh_period.
- create_table_monitor_refresh_period: When refresh_method is periodic, specifies the period in seconds at which changes are reported.
- create_table_monitor_refresh_start_time: When refresh_method is periodic, specifies the first time at which changes are reported. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
-
create_table_monitor_event: Type of modification event on the target table to be monitored by this table monitor. Supported values:
- Returns
- Response object containing the result of the operation.
◆ createTableMonitor() [4/4]
| CreateTableMonitorResponse& createTableMonitor | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| CreateTableMonitorResponse & | response_ | ||
| ) | const |
Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by tableName) and forwards event notifications to subscribers via ZMQ.
After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an operation of the given type on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that corresponds to the event and can be decoded using typeSchema. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor.
For more information on table monitors, see Table Monitors.
- Parameters
-
[in] tableName Name of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules. [in] options Optional parameters. -
create_table_monitor_event: Type of modification event on the target table to be monitored by this table monitor. Supported values:
- create_table_monitor_insert: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
- create_table_monitor_update: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
- create_table_monitor_delete: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
- create_table_monitor_monitor_id: ID to use for this monitor instead of a randomly generated one
- create_table_monitor_datasink_name: Name of an existing data sink to send change data notifications to
- create_table_monitor_destination: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'.
- create_table_monitor_kafka_topic_name: Name of the Kafka topic to publish to if destination in options is specified and is a Kafka broker
- create_table_monitor_increasing_column: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
- create_table_monitor_expression: Filter expression to limit records for notification
-
create_table_monitor_refresh_method: Method controlling when the table monitor reports changes to the tableName. Supported values:
- create_table_monitor_on_change: Report changes as they occur.
- create_table_monitor_periodic: Report changes periodically at rate specified by refresh_period.
- create_table_monitor_refresh_period: When refresh_method is periodic, specifies the period in seconds at which changes are reported.
- create_table_monitor_refresh_start_time: When refresh_method is periodic, specifies the first time at which changes are reported. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
[out] response_ Response object containing the results of the operation. -
create_table_monitor_event: Type of modification event on the target table to be monitored by this table monitor. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTriggerByArea() [1/4]
| CreateTriggerByAreaResponse createTriggerByArea | ( | const CreateTriggerByAreaRequest & | request_ | ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createTriggerByArea() [2/4]
| CreateTriggerByAreaResponse& createTriggerByArea | ( | const CreateTriggerByAreaRequest & | request_, |
| CreateTriggerByAreaResponse & | response_ | ||
| ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTriggerByArea() [3/4]
| CreateTriggerByAreaResponse 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ createTriggerByArea() [4/4]
| CreateTriggerByAreaResponse& createTriggerByArea | ( | const std::string & | requestId, |
| const std::vector< std::string > & | tableNames, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTriggerByAreaResponse & | response_ | ||
| ) | const |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTriggerByRange() [1/4]
| CreateTriggerByRangeResponse createTriggerByRange | ( | const CreateTriggerByRangeRequest & | request_ | ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createTriggerByRange() [2/4]
| CreateTriggerByRangeResponse& createTriggerByRange | ( | const CreateTriggerByRangeRequest & | request_, |
| CreateTriggerByRangeResponse & | response_ | ||
| ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createTriggerByRange() [3/4]
| CreateTriggerByRangeResponse 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ createTriggerByRange() [4/4]
| CreateTriggerByRangeResponse& createTriggerByRange | ( | const std::string & | requestId, |
| const std::vector< std::string > & | tableNames, | ||
| const std::string & | columnName, | ||
| const double | min, | ||
| const double | max, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateTriggerByRangeResponse & | response_ | ||
| ) | const |
Sets up a simple range trigger for a column_name for one or more tables.
Once the trigger has been activated, any record added to the listed tables(s) via 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createType() [1/4]
| CreateTypeResponse 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:
{"type":"record",
"name":"point",
"fields":[{"name":"msg_id","type":"string"},
{"name":"x","type":"double"},
{"name":"y","type":"double"},
{"name":"TIMESTAMP","type":"double"},
{"name":"source","type":"string"},
{"name":"group_id","type":"string"},
{"name":"OBJECT_ID","type":"string"}]
}
Properties:
{"group_id":["store_only"],
"msg_id":["store_only","text_search"]
}
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createType() [2/4]
| CreateTypeResponse& 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:
{"type":"record",
"name":"point",
"fields":[{"name":"msg_id","type":"string"},
{"name":"x","type":"double"},
{"name":"y","type":"double"},
{"name":"TIMESTAMP","type":"double"},
{"name":"source","type":"string"},
{"name":"group_id","type":"string"},
{"name":"OBJECT_ID","type":"string"}]
}
Properties:
{"group_id":["store_only"],
"msg_id":["store_only","text_search"]
}
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createType() [3/4]
| CreateTypeResponse 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:
{"type":"record",
"name":"point",
"fields":[{"name":"msg_id","type":"string"},
{"name":"x","type":"double"},
{"name":"y","type":"double"},
{"name":"TIMESTAMP","type":"double"},
{"name":"source","type":"string"},
{"name":"group_id","type":"string"},
{"name":"OBJECT_ID","type":"string"}]
}
Properties:
{"group_id":["store_only"],
"msg_id":["store_only","text_search"]
}
- Parameters
-
[in] 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: - create_type_data: Default property for all numeric and string type columns; makes the column available for GPU queries.
- create_type_text_search: Valid only for select 'string' columns. Enables full text search–see Full Text Search for details and applicable string column types. Can be set independently of data and store_only.
- create_type_store_only: Persist the column value but do not make it available to queries (e.g. filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage.
- create_type_disk_optimized: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like filter, filterByList, and filterByValue work as usual but aggregateUnique and aggregateGroupBy are not allowed on columns with this property.
- create_type_timestamp: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900.
- create_type_ulong: Valid only for 'string' columns. It represents an unsigned long integer data type. The string can only be interpreted as an unsigned long data type with minimum value of zero, and maximum value of 18446744073709551615.
- create_type_uuid: Valid only for 'string' columns. It represents an uuid data type. Internally, it is stored as a 128-bit integer.
- create_type_decimal: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property.
- create_type_date: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property.
- create_type_time: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property.
- create_type_datetime: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property.
- create_type_char1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character.
- create_type_char2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
- create_type_char4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
- create_type_char8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
- create_type_char16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
- create_type_char32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
- create_type_char64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
- create_type_char128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
- create_type_char256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
- create_type_boolean: This property provides optimized memory and query performance for int columns. Ints with this property must be between 0 and 1(inclusive)
- create_type_int8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
- create_type_int16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
- create_type_ipv4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255.
- create_type_array: Valid only for 'string' columns. Indicates that this field contains an array. The value type and (optionally) the item count should be specified in parenthesis; e.g., 'array(int, 10)' for a 10-integer array. Both 'array(int)' and 'array(int, -1)' will designate an unlimited-length integer array, though no bounds checking is performed on arrays of any length.
- create_type_json: Valid only for 'string' columns. Indicates that this field contains values in JSON format.
- create_type_vector: Valid only for 'bytes' columns. Indicates that this field contains a vector of floats. The length should be specified in parenthesis, e.g., 'vector(1000)'.
- create_type_wkt: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format.
- create_type_primary_key: This property indicates that this column will be part of (or the entire) primary key.
- create_type_soft_primary_key: This property indicates that this column will be part of (or the entire) soft primary key.
- create_type_shard_key: This property indicates that this column will be part of (or the entire) shard key.
- create_type_nullable: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in typeDefinition. For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record.
- create_type_dict: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with restricted string (charN), int, long or date columns. Dictionary encoding is best for columns where the cardinality (the number of unique values) is expected to be low. This property can save a large amount of memory.
- create_type_init_with_now: For 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timestamps with 'NOW()' upon insert.
- create_type_init_with_uuid: For 'uuid' type, replace empty strings and invalid UUID values with randomly-generated UUIDs upon insert.
- create_type_update_with_now: For 'date', 'time', 'datetime', or 'timestamp' column types, always update the field with 'NOW()' upon any update.
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ createType() [4/4]
| 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.
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:
{"type":"record",
"name":"point",
"fields":[{"name":"msg_id","type":"string"},
{"name":"x","type":"double"},
{"name":"y","type":"double"},
{"name":"TIMESTAMP","type":"double"},
{"name":"source","type":"string"},
{"name":"group_id","type":"string"},
{"name":"OBJECT_ID","type":"string"}]
}
Properties:
{"group_id":["store_only"],
"msg_id":["store_only","text_search"]
}
- Parameters
-
[in] 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: - create_type_data: Default property for all numeric and string type columns; makes the column available for GPU queries.
- create_type_text_search: Valid only for select 'string' columns. Enables full text search–see Full Text Search for details and applicable string column types. Can be set independently of data and store_only.
- create_type_store_only: Persist the column value but do not make it available to queries (e.g. filter)-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage.
- create_type_disk_optimized: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like filter, filterByList, and filterByValue work as usual but aggregateUnique and aggregateGroupBy are not allowed on columns with this property.
- create_type_timestamp: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900.
- create_type_ulong: Valid only for 'string' columns. It represents an unsigned long integer data type. The string can only be interpreted as an unsigned long data type with minimum value of zero, and maximum value of 18446744073709551615.
- create_type_uuid: Valid only for 'string' columns. It represents an uuid data type. Internally, it is stored as a 128-bit integer.
- create_type_decimal: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property.
- create_type_date: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property.
- create_type_time: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property.
- create_type_datetime: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property.
- create_type_char1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character.
- create_type_char2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
- create_type_char4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
- create_type_char8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
- create_type_char16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
- create_type_char32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
- create_type_char64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
- create_type_char128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
- create_type_char256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
- create_type_boolean: This property provides optimized memory and query performance for int columns. Ints with this property must be between 0 and 1(inclusive)
- create_type_int8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
- create_type_int16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
- create_type_ipv4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255.
- create_type_array: Valid only for 'string' columns. Indicates that this field contains an array. The value type and (optionally) the item count should be specified in parenthesis; e.g., 'array(int, 10)' for a 10-integer array. Both 'array(int)' and 'array(int, -1)' will designate an unlimited-length integer array, though no bounds checking is performed on arrays of any length.
- create_type_json: Valid only for 'string' columns. Indicates that this field contains values in JSON format.
- create_type_vector: Valid only for 'bytes' columns. Indicates that this field contains a vector of floats. The length should be specified in parenthesis, e.g., 'vector(1000)'.
- create_type_wkt: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format.
- create_type_primary_key: This property indicates that this column will be part of (or the entire) primary key.
- create_type_soft_primary_key: This property indicates that this column will be part of (or the entire) soft primary key.
- create_type_shard_key: This property indicates that this column will be part of (or the entire) shard key.
- create_type_nullable: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in typeDefinition. For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record.
- create_type_dict: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with restricted string (charN), int, long or date columns. Dictionary encoding is best for columns where the cardinality (the number of unique values) is expected to be low. This property can save a large amount of memory.
- create_type_init_with_now: For 'date', 'time', 'datetime', or 'timestamp' column types, replace empty strings and invalid timestamps with 'NOW()' upon insert.
- create_type_init_with_uuid: For 'uuid' type, replace empty strings and invalid UUID values with randomly-generated UUIDs upon insert.
- create_type_update_with_now: For 'date', 'time', 'datetime', or 'timestamp' column types, always update the field with 'NOW()' upon any update.
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createUnion() [1/4]
| CreateUnionResponse createUnion | ( | const CreateUnionRequest & | request_ | ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createUnion() [2/4]
| CreateUnionResponse& createUnion | ( | const CreateUnionRequest & | request_, |
| CreateUnionResponse & | response_ | ||
| ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createUnion() [3/4]
| CreateUnionResponse createUnion | ( | const std::string & | tableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputColumnNames, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
- Parameters
-
[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. - create_union_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is create_union_false.
- create_union_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of tableName and use createSchema to create the schema if non-existent] Name of the schema for the output table. If the schema provided is non-existent, it will be automatically created. The default value is ''.
-
create_union_mode: If merge_views, then this operation will merge the provided views. All tableNames must be views from the same underlying base table. Supported values:
- create_union_union_all: Retains all rows from the specified tables.
- create_union_union: Retains all unique rows from the specified tables (synonym for union_distinct).
- create_union_union_distinct: Retains all unique rows from the specified tables.
- create_union_except: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
- create_union_except_all: Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
- create_union_intersect: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
- create_union_intersect_all: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
- create_union_merge_views: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected inputColumnNames AND outputColumnNames must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
- create_union_chunk_size: Indicates the number of records per chunk to be used for this output table.
- create_union_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this output table.
- create_union_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this output table.
- create_union_create_indexes: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
- create_union_ttl: Sets the TTL of the output table specified in tableName.
- create_union_persist: If true, then the output table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the output table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is create_union_false.
- create_union_view_id: ID of view of which this output table is a member. The default value is ''.
- create_union_force_replicated: If true, then the output table specified in tableName will be replicated even if the source tables are not. Supported values: The default value is create_union_false.
- create_union_strategy_definition: The tier strategy for the table and its columns.
- Returns
- Response object containing the result of the operation.
◆ createUnion() [4/4]
| CreateUnionResponse& createUnion | ( | const std::string & | tableName, |
| const std::vector< std::string > & | tableNames, | ||
| const std::vector< std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputColumnNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateUnionResponse & | response_ | ||
| ) | const |
Merges data from one or more tables with comparable data types into a new table.
The following merges are supported:
UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
- Parameters
-
[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. - create_union_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is create_union_false.
- create_union_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of tableName and use createSchema to create the schema if non-existent] Name of the schema for the output table. If the schema provided is non-existent, it will be automatically created. The default value is ''.
-
create_union_mode: If merge_views, then this operation will merge the provided views. All tableNames must be views from the same underlying base table. Supported values:
- create_union_union_all: Retains all rows from the specified tables.
- create_union_union: Retains all unique rows from the specified tables (synonym for union_distinct).
- create_union_union_distinct: Retains all unique rows from the specified tables.
- create_union_except: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
- create_union_except_all: Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
- create_union_intersect: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
- create_union_intersect_all: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
- create_union_merge_views: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected inputColumnNames AND outputColumnNames must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
- create_union_chunk_size: Indicates the number of records per chunk to be used for this output table.
- create_union_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this output table.
- create_union_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this output table.
- create_union_create_indexes: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
- create_union_ttl: Sets the TTL of the output table specified in tableName.
- create_union_persist: If true, then the output table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the output table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is create_union_false.
- create_union_view_id: ID of view of which this output table is a member. The default value is ''.
- create_union_force_replicated: If true, then the output table specified in tableName will be replicated even if the source tables are not. Supported values: The default value is create_union_false.
- create_union_strategy_definition: The tier strategy for the table and its columns.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createUserExternal() [1/4]
| CreateUserExternalResponse createUserExternal | ( | const CreateUserExternalRequest & | request_ | ) | const |
Creates a new external user (a user whose credentials are managed by an external LDAP).
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ createUserExternal() [2/4]
| CreateUserExternalResponse& createUserExternal | ( | const CreateUserExternalRequest & | request_, |
| CreateUserExternalResponse & | response_ | ||
| ) | const |
Creates a new external user (a user whose credentials are managed by an external LDAP).
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createUserExternal() [3/4]
| 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).
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. -
create_user_external_activated: Is the user allowed to login. Supported values:
- create_user_external_true: User may login
- create_user_external_false: User may not login
- create_user_external_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: The default value is create_user_external_true.
- create_user_external_default_schema: Default schema to associate with this user
- create_user_external_directory_data_limit: The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
- create_user_external_resource_group: Name of an existing resource group to associate with this user
-
create_user_external_activated: Is the user allowed to login. Supported values:
- Returns
- Response object containing the result of the operation.
◆ createUserExternal() [4/4]
| 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).
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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. -
create_user_external_activated: Is the user allowed to login. Supported values:
- create_user_external_true: User may login
- create_user_external_false: User may not login
- create_user_external_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: The default value is create_user_external_true.
- create_user_external_default_schema: Default schema to associate with this user
- create_user_external_directory_data_limit: The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
- create_user_external_resource_group: Name of an existing resource group to associate with this user
[out] response_ Response object containing the results of the operation. -
create_user_external_activated: Is the user allowed to login. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createUserInternal() [1/4]
| CreateUserInternalResponse createUserInternal | ( | const CreateUserInternalRequest & | request_ | ) | const |
◆ createUserInternal() [2/4]
| CreateUserInternalResponse& createUserInternal | ( | const CreateUserInternalRequest & | request_, |
| CreateUserInternalResponse & | response_ | ||
| ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createUserInternal() [3/4]
| CreateUserInternalResponse createUserInternal | ( | const std::string & | name, |
| const std::string & | password, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
- Parameters
-
[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. -
create_user_internal_activated: Is the user allowed to login. Supported values:
- create_user_internal_true: User may login
- create_user_internal_false: User may not login
- create_user_internal_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: The default value is create_user_internal_true.
- create_user_internal_default_schema: Default schema to associate with this user
- create_user_internal_directory_data_limit: The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
- create_user_internal_resource_group: Name of an existing resource group to associate with this user
-
create_user_internal_activated: Is the user allowed to login. Supported values:
- Returns
- Response object containing the result of the operation.
◆ createUserInternal() [4/4]
| CreateUserInternalResponse& createUserInternal | ( | const std::string & | name, |
| const std::string & | password, | ||
| const std::map< std::string, std::string > & | options, | ||
| CreateUserInternalResponse & | response_ | ||
| ) | const |
Creates a new internal user (a user whose credentials are managed by the database system).
- Parameters
-
[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. -
create_user_internal_activated: Is the user allowed to login. Supported values:
- create_user_internal_true: User may login
- create_user_internal_false: User may not login
- create_user_internal_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: The default value is create_user_internal_true.
- create_user_internal_default_schema: Default schema to associate with this user
- create_user_internal_directory_data_limit: The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
- create_user_internal_resource_group: Name of an existing resource group to associate with this user
[out] response_ Response object containing the results of the operation. -
create_user_internal_activated: Is the user allowed to login. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createVideo() [1/4]
| CreateVideoResponse createVideo | ( | const CreateVideoRequest & | request_ | ) | const |
◆ createVideo() [2/4]
| 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ createVideo() [3/4]
| 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.
- Parameters
-
[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. - create_video_ttl: Sets the TTL of the video.
- create_video_window: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
- create_video_no_error_if_exists: If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. Supported values: The default value is create_video_false.
- create_video_replace_if_exists: If true, deletes any existing video with the same path before creating a new video. Supported values: The default value is create_video_false.
- Returns
- Response object containing the result of the operation.
◆ createVideo() [4/4]
| 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.
- Parameters
-
[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. - create_video_ttl: Sets the TTL of the video.
- create_video_window: Specified using the data-type corresponding to the attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
- create_video_no_error_if_exists: If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. Supported values: The default value is create_video_false.
- create_video_replace_if_exists: If true, deletes any existing video with the same path before creating a new video. Supported values: The default value is create_video_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteDirectory() [1/4]
| DeleteDirectoryResponse deleteDirectory | ( | const DeleteDirectoryRequest & | request_ | ) | const |
◆ deleteDirectory() [2/4]
| DeleteDirectoryResponse& deleteDirectory | ( | const DeleteDirectoryRequest & | request_, |
| DeleteDirectoryResponse & | response_ | ||
| ) | const |
◆ deleteDirectory() [3/4]
| DeleteDirectoryResponse deleteDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a directory from KiFS.
- Parameters
-
[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. - delete_directory_recursive: If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values: The default value is delete_directory_false.
- delete_directory_no_error_if_not_exists: If true, no error is returned if specified directory does not exist. Supported values: The default value is delete_directory_false.
- Returns
- Response object containing the result of the operation.
◆ deleteDirectory() [4/4]
| DeleteDirectoryResponse& deleteDirectory | ( | const std::string & | directoryName, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteDirectoryResponse & | response_ | ||
| ) | const |
Deletes a directory from KiFS.
- Parameters
-
[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. - delete_directory_recursive: If true, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values: The default value is delete_directory_false.
- delete_directory_no_error_if_not_exists: If true, no error is returned if specified directory does not exist. Supported values: The default value is delete_directory_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteFiles() [1/4]
| DeleteFilesResponse deleteFiles | ( | const DeleteFilesRequest & | request_ | ) | const |
◆ deleteFiles() [2/4]
| DeleteFilesResponse& deleteFiles | ( | const DeleteFilesRequest & | request_, |
| DeleteFilesResponse & | response_ | ||
| ) | const |
◆ deleteFiles() [3/4]
| DeleteFilesResponse deleteFiles | ( | const std::vector< std::string > & | fileNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes one or more files from KiFS.
- Parameters
-
[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. - delete_files_no_error_if_not_exists: If true, no error is returned if a specified file does not exist. Supported values: The default value is delete_files_false.
- Returns
- Response object containing the result of the operation.
◆ deleteFiles() [4/4]
| 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.
- Parameters
-
[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. - delete_files_no_error_if_not_exists: If true, no error is returned if a specified file does not exist. Supported values: The default value is delete_files_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteGraph() [1/4]
| DeleteGraphResponse deleteGraph | ( | const DeleteGraphRequest & | request_ | ) | const |
◆ deleteGraph() [2/4]
| DeleteGraphResponse& deleteGraph | ( | const DeleteGraphRequest & | request_, |
| DeleteGraphResponse & | response_ | ||
| ) | const |
Deletes an existing graph from the graph server and/or persist.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteGraph() [3/4]
| DeleteGraphResponse deleteGraph | ( | const std::string & | graphName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing graph from the graph server and/or persist.
- Parameters
-
[in] graphName Name of the graph to be deleted. [in] options Optional parameters. - delete_graph_delete_persist: If set to true, the graph is removed from the server and persist. If set to false, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. Supported values: The default value is delete_graph_true.
- delete_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
- Returns
- Response object containing the result of the operation.
◆ deleteGraph() [4/4]
| DeleteGraphResponse& deleteGraph | ( | const std::string & | graphName, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteGraphResponse & | response_ | ||
| ) | const |
Deletes an existing graph from the graph server and/or persist.
- Parameters
-
[in] graphName Name of the graph to be deleted. [in] options Optional parameters. - delete_graph_delete_persist: If set to true, the graph is removed from the server and persist. If set to false, the graph is removed from the server but is left in persist. The graph can be reloaded from persist if it is recreated with the same 'graph_name'. Supported values: The default value is delete_graph_true.
- delete_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteProc() [1/4]
| DeleteProcResponse deleteProc | ( | const DeleteProcRequest & | request_ | ) | const |
◆ deleteProc() [2/4]
| DeleteProcResponse& deleteProc | ( | const DeleteProcRequest & | request_, |
| DeleteProcResponse & | response_ | ||
| ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteProc() [3/4]
| DeleteProcResponse deleteProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ deleteProc() [4/4]
| DeleteProcResponse& deleteProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteProcResponse & | response_ | ||
| ) | const |
Deletes a proc.
Any currently running instances of the proc will be killed.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteRecords() [1/4]
| DeleteRecordsResponse deleteRecords | ( | const DeleteRecordsRequest & | request_ | ) | const |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ deleteRecords() [2/4]
| DeleteRecordsResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteRecords() [3/4]
| DeleteRecordsResponse 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.
- Parameters
-
[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. - delete_records_global_expression: An optional global expression to reduce the search space of the expressions. The default value is ''.
- delete_records_record_id: A record ID identifying a single record, obtained at the time of insertion of the record or by calling getRecordsFromCollection with the return_record_ids option. This option cannot be used to delete records from replicated tables.
- delete_records_delete_all_records: If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored. Supported values: The default value is delete_records_false.
- Returns
- Response object containing the result of the operation.
◆ deleteRecords() [4/4]
| DeleteRecordsResponse& deleteRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | expressions, | ||
| const std::map< std::string, std::string > & | options, | ||
| DeleteRecordsResponse & | response_ | ||
| ) | const |
Deletes record(s) matching the provided criteria from the given table.
The record selection criteria can either be one or more expressions (matching multiple records), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
- Parameters
-
[in] 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. - delete_records_global_expression: An optional global expression to reduce the search space of the expressions. The default value is ''.
- delete_records_record_id: A record ID identifying a single record, obtained at the time of insertion of the record or by calling getRecordsFromCollection with the return_record_ids option. This option cannot be used to delete records from replicated tables.
- delete_records_delete_all_records: If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored. Supported values: The default value is delete_records_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteResourceGroup() [1/4]
| DeleteResourceGroupResponse deleteResourceGroup | ( | const DeleteResourceGroupRequest & | request_ | ) | const |
◆ deleteResourceGroup() [2/4]
| DeleteResourceGroupResponse& deleteResourceGroup | ( | const DeleteResourceGroupRequest & | request_, |
| DeleteResourceGroupResponse & | response_ | ||
| ) | const |
◆ deleteResourceGroup() [3/4]
| DeleteResourceGroupResponse deleteResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes a resource group.
- Parameters
-
[in] name Name of the resource group to be deleted. [in] options Optional parameters. - delete_resource_group_cascade_delete: If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. Supported values: The default value is delete_resource_group_false.
- Returns
- Response object containing the result of the operation.
◆ deleteResourceGroup() [4/4]
| DeleteResourceGroupResponse& deleteResourceGroup | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteResourceGroupResponse & | response_ | ||
| ) | const |
Deletes a resource group.
- Parameters
-
[in] name Name of the resource group to be deleted. [in] options Optional parameters. - delete_resource_group_cascade_delete: If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. Supported values: The default value is delete_resource_group_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteRole() [1/4]
| DeleteRoleResponse deleteRole | ( | const DeleteRoleRequest & | request_ | ) | const |
◆ deleteRole() [2/4]
| DeleteRoleResponse& deleteRole | ( | const DeleteRoleRequest & | request_, |
| DeleteRoleResponse & | response_ | ||
| ) | const |
Deletes an existing role.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteRole() [3/4]
| DeleteRoleResponse deleteRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing role.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ deleteRole() [4/4]
| DeleteRoleResponse& deleteRole | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteRoleResponse & | response_ | ||
| ) | const |
Deletes an existing role.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteUser() [1/4]
| DeleteUserResponse deleteUser | ( | const DeleteUserRequest & | request_ | ) | const |
◆ deleteUser() [2/4]
| DeleteUserResponse& deleteUser | ( | const DeleteUserRequest & | request_, |
| DeleteUserResponse & | response_ | ||
| ) | const |
Deletes an existing user.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ deleteUser() [3/4]
| DeleteUserResponse deleteUser | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Deletes an existing user.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ deleteUser() [4/4]
| DeleteUserResponse& deleteUser | ( | const std::string & | name, |
| const std::map< std::string, std::string > & | options, | ||
| DeleteUserResponse & | response_ | ||
| ) | const |
Deletes an existing user.
- Attention
- This method should be used for on-premise deployments only.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ downloadFiles() [1/4]
| DownloadFilesResponse downloadFiles | ( | const DownloadFilesRequest & | request_ | ) | const |
◆ downloadFiles() [2/4]
| DownloadFilesResponse& downloadFiles | ( | const DownloadFilesRequest & | request_, |
| DownloadFilesResponse & | response_ | ||
| ) | const |
◆ downloadFiles() [3/4]
| 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.
- Parameters
-
[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. -
download_files_file_encoding: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
- download_files_base64: Apply base64 encoding to the output file data.
- download_files_none: Do not apply any encoding to the output file data.
-
download_files_file_encoding: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
- Returns
- Response object containing the result of the operation.
◆ downloadFiles() [4/4]
| 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.
- Parameters
-
[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. -
download_files_file_encoding: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
- download_files_base64: Apply base64 encoding to the output file data.
- download_files_none: Do not apply any encoding to the output file data.
[out] response_ Response object containing the results of the operation. -
download_files_file_encoding: Encoding to be applied to the output file data. When using JSON serialization it is recommended to specify this as base64. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropCredential() [1/4]
| DropCredentialResponse dropCredential | ( | const DropCredentialRequest & | request_ | ) | const |
Drop an existing credential.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ dropCredential() [2/4]
| DropCredentialResponse& dropCredential | ( | const DropCredentialRequest & | request_, |
| DropCredentialResponse & | response_ | ||
| ) | const |
Drop an existing credential.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropCredential() [3/4]
| DropCredentialResponse dropCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drop an existing credential.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ dropCredential() [4/4]
| DropCredentialResponse& dropCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options, | ||
| DropCredentialResponse & | response_ | ||
| ) | const |
Drop an existing credential.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropDatasink() [1/4]
| DropDatasinkResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ dropDatasink() [2/4]
| DropDatasinkResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropDatasink() [3/4]
| DropDatasinkResponse 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.
- Parameters
-
[in] name Name of the data sink to be dropped. Must be an existing data sink. [in] options Optional parameters. - drop_datasink_clear_table_monitors: If true, any table monitors that use this data sink will be cleared. Supported values: The default value is drop_datasink_false.
- Returns
- Response object containing the result of the operation.
◆ dropDatasink() [4/4]
| DropDatasinkResponse& 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.
- Parameters
-
[in] name Name of the data sink to be dropped. Must be an existing data sink. [in] options Optional parameters. - drop_datasink_clear_table_monitors: If true, any table monitors that use this data sink will be cleared. Supported values: The default value is drop_datasink_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropDatasource() [1/4]
| DropDatasourceResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ dropDatasource() [2/4]
| DropDatasourceResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropDatasource() [3/4]
| DropDatasourceResponse 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ dropDatasource() [4/4]
| DropDatasourceResponse& 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropEnvironment() [1/4]
| DropEnvironmentResponse dropEnvironment | ( | const DropEnvironmentRequest & | request_ | ) | const |
Drop an existing user-defined function (UDF) environment.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ dropEnvironment() [2/4]
| DropEnvironmentResponse& dropEnvironment | ( | const DropEnvironmentRequest & | request_, |
| DropEnvironmentResponse & | response_ | ||
| ) | const |
Drop an existing user-defined function (UDF) environment.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropEnvironment() [3/4]
| DropEnvironmentResponse dropEnvironment | ( | const std::string & | environmentName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drop an existing user-defined function (UDF) environment.
- Parameters
-
[in] environmentName Name of the environment to be dropped. Must be an existing environment. [in] options Optional parameters. - drop_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values: The default value is drop_environment_false.
- Returns
- Response object containing the result of the operation.
◆ dropEnvironment() [4/4]
| 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.
- Parameters
-
[in] environmentName Name of the environment to be dropped. Must be an existing environment. [in] options Optional parameters. - drop_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values: The default value is drop_environment_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropSchema() [1/4]
| DropSchemaResponse dropSchema | ( | const DropSchemaRequest & | request_ | ) | const |
Drops an existing SQL-style schema, specified in schemaName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ dropSchema() [2/4]
| DropSchemaResponse& dropSchema | ( | const DropSchemaRequest & | request_, |
| DropSchemaResponse & | response_ | ||
| ) | const |
Drops an existing SQL-style schema, specified in schemaName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ dropSchema() [3/4]
| DropSchemaResponse dropSchema | ( | const std::string & | schemaName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Drops an existing SQL-style schema, specified in schemaName.
- Parameters
-
[in] schemaName Name of the schema to be dropped. Must be an existing schema. [in] options Optional parameters. - drop_schema_no_error_if_not_exists: If true and if the schema specified in schemaName does not exist, no error is returned. If false and if the schema specified in schemaName does not exist, then an error is returned. Supported values: The default value is drop_schema_false.
- drop_schema_cascade: If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Supported values: The default value is drop_schema_false.
- Returns
- Response object containing the result of the operation.
◆ dropSchema() [4/4]
| 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.
- Parameters
-
[in] schemaName Name of the schema to be dropped. Must be an existing schema. [in] options Optional parameters. - drop_schema_no_error_if_not_exists: If true and if the schema specified in schemaName does not exist, no error is returned. If false and if the schema specified in schemaName does not exist, then an error is returned. Supported values: The default value is drop_schema_false.
- drop_schema_cascade: If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Supported values: The default value is drop_schema_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ executeProc() [1/4]
| ExecuteProcResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ executeProc() [2/4]
| ExecuteProcResponse& executeProc | ( | const ExecuteProcRequest & | request_, |
| ExecuteProcResponse & | response_ | ||
| ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ executeProc() [3/4]
| ExecuteProcResponse 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.
- Parameters
-
[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. - execute_proc_cache_input: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to executeProc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the clear_complete option of showProcStatus and all proc instances using the cached data have completed. The default value is ''.
- execute_proc_use_cached_input: A comma-delimited list of run IDs (as returned from prior calls to executeProc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in inputTableNames, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.
- execute_proc_run_tag: A string that, if not empty, can be used in subsequent calls to showProcStatus or killProc to identify the proc instance. The default value is ''.
- execute_proc_max_output_lines: The maximum number of lines of output from stdout and stderr to return via showProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is '100'.
- execute_proc_execute_at_startup: If true, an instance of the proc will run when the database is started instead of running immediately. The runId can be retrieved using showProc and used in showProcStatus. Supported values: The default value is execute_proc_false.
- execute_proc_execute_at_startup_as: Sets the alternate user name to execute this proc instance as when execute_at_startup is true. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ executeProc() [4/4]
| ExecuteProcResponse& executeProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | params, | ||
| const std::map< std::string, std::vector< uint8_t > > & | binParams, | ||
| const std::vector< std::string > & | inputTableNames, | ||
| const std::map< std::string, std::vector< std::string > > & | inputColumnNames, | ||
| const std::vector< std::string > & | outputTableNames, | ||
| const std::map< std::string, std::string > & | options, | ||
| ExecuteProcResponse & | response_ | ||
| ) | const |
Executes a proc.
This endpoint is asynchronous and does not wait for the proc to complete before returning.
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.
- Parameters
-
[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. - execute_proc_cache_input: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to executeProc with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the clear_complete option of showProcStatus and all proc instances using the cached data have completed. The default value is ''.
- execute_proc_use_cached_input: A comma-delimited list of run IDs (as returned from prior calls to executeProc) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in inputTableNames, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.
- execute_proc_run_tag: A string that, if not empty, can be used in subsequent calls to showProcStatus or killProc to identify the proc instance. The default value is ''.
- execute_proc_max_output_lines: The maximum number of lines of output from stdout and stderr to return via showProcStatus. If the number of lines output exceeds the maximum, earlier lines are discarded. The default value is '100'.
- execute_proc_execute_at_startup: If true, an instance of the proc will run when the database is started instead of running immediately. The runId can be retrieved using showProc and used in showProcStatus. Supported values: The default value is execute_proc_false.
- execute_proc_execute_at_startup_as: Sets the alternate user name to execute this proc instance as when execute_at_startup is true. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ executeSql() [1/4]
| ExecuteSqlResponse executeSql | ( | const ExecuteSqlRequest & | request_ | ) | const |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ executeSql() [2/4]
| ExecuteSqlResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ executeSql() [3/4]
| 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).
See SQL Support for the complete set of supported SQL commands.
- Parameters
-
[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. - execute_sql_cost_based_optimization: If false, disables the cost-based optimization of the given query. Supported values: The default value is execute_sql_false.
- execute_sql_distributed_joins: If true, enables the use of distributed joins in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: The default value is execute_sql_false.
- execute_sql_distributed_operations: If true, enables the use of distributed operations in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: The default value is execute_sql_false.
-
execute_sql_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into or updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record insert/update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any insert/update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values:
- execute_sql_true: Ignore inserts/updates that result in primary key collisions with existing records
- execute_sql_false: Treat as errors any inserts/updates that result in primary key collisions with existing records
- execute_sql_late_materialization: If true, Joins/Filters results will always be materialized ( saved to result tables format). Supported values: The default value is execute_sql_false.
- execute_sql_paging_table: When empty or the specified paging table not exists, the system will create a paging table and return when query output has more records than the user asked. If the paging table exists in the system, the records from the paging table are returned without evaluating the query.
- execute_sql_paging_table_ttl: Sets the TTL of the paging table.
- execute_sql_parallel_execution: If false, disables the parallel step execution of the given query. Supported values: The default value is execute_sql_true.
- execute_sql_plan_cache: If false, disables plan caching for the given query. Supported values: The default value is execute_sql_true.
- execute_sql_prepare_mode: If true, compiles a query into an execution plan and saves it in query cache. Query execution is not performed and an empty response will be returned to user. Supported values: The default value is execute_sql_false.
- execute_sql_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values: The default value is execute_sql_true.
- execute_sql_query_parameters: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and requestSchemaStr.
- execute_sql_results_caching: If false, disables caching of the results of the given query. Supported values: The default value is execute_sql_true.
- execute_sql_rule_based_optimization: If false, disables rule-based rewrite optimizations for the given query. Supported values: The default value is execute_sql_true.
- execute_sql_ssq_optimization: If false, scalar subqueries will be translated into joins. Supported values: The default value is execute_sql_true.
- execute_sql_ttl: Sets the TTL of the intermediate result tables used in query execution.
-
execute_sql_update_on_existing_pk: Specifies the record collision policy for inserting into or updating a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted or updated will be replaced by that record. If set to false, any such primary key collision will result in the insert/update being rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
- execute_sql_true: Replace the collided-into record with the record inserted or updated when a new/modified record causes a primary key collision with an existing record
- execute_sql_false: Reject the insert or update when it results in a primary key collision with an existing record
- execute_sql_validate_change_column: When changing a column using alter table, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values: The default value is execute_sql_true.
- execute_sql_current_schema: Use the supplied value as the default schema when processing this SQL command.
- Returns
- Response object containing the result of the operation.
◆ executeSql() [4/4]
| 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).
See SQL Support for the complete set of supported SQL commands.
- Parameters
-
[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. - execute_sql_cost_based_optimization: If false, disables the cost-based optimization of the given query. Supported values: The default value is execute_sql_false.
- execute_sql_distributed_joins: If true, enables the use of distributed joins in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: The default value is execute_sql_false.
- execute_sql_distributed_operations: If true, enables the use of distributed operations in servicing the given query. Any query requiring a distributed join will succeed, though hints can be used in the query to change the distribution of the source data to allow the query to succeed. Supported values: The default value is execute_sql_false.
-
execute_sql_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into or updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record insert/update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any insert/update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values:
- execute_sql_true: Ignore inserts/updates that result in primary key collisions with existing records
- execute_sql_false: Treat as errors any inserts/updates that result in primary key collisions with existing records
- execute_sql_late_materialization: If true, Joins/Filters results will always be materialized ( saved to result tables format). Supported values: The default value is execute_sql_false.
- execute_sql_paging_table: When empty or the specified paging table not exists, the system will create a paging table and return when query output has more records than the user asked. If the paging table exists in the system, the records from the paging table are returned without evaluating the query.
- execute_sql_paging_table_ttl: Sets the TTL of the paging table.
- execute_sql_parallel_execution: If false, disables the parallel step execution of the given query. Supported values: The default value is execute_sql_true.
- execute_sql_plan_cache: If false, disables plan caching for the given query. Supported values: The default value is execute_sql_true.
- execute_sql_prepare_mode: If true, compiles a query into an execution plan and saves it in query cache. Query execution is not performed and an empty response will be returned to user. Supported values: The default value is execute_sql_false.
- execute_sql_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values: The default value is execute_sql_true.
- execute_sql_query_parameters: Query parameters in JSON array or arrays (for inserting multiple rows). This can be used instead of data and requestSchemaStr.
- execute_sql_results_caching: If false, disables caching of the results of the given query. Supported values: The default value is execute_sql_true.
- execute_sql_rule_based_optimization: If false, disables rule-based rewrite optimizations for the given query. Supported values: The default value is execute_sql_true.
- execute_sql_ssq_optimization: If false, scalar subqueries will be translated into joins. Supported values: The default value is execute_sql_true.
- execute_sql_ttl: Sets the TTL of the intermediate result tables used in query execution.
-
execute_sql_update_on_existing_pk: Specifies the record collision policy for inserting into or updating a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted or updated will be replaced by that record. If set to false, any such primary key collision will result in the insert/update being rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
- execute_sql_true: Replace the collided-into record with the record inserted or updated when a new/modified record causes a primary key collision with an existing record
- execute_sql_false: Reject the insert or update when it results in a primary key collision with an existing record
- execute_sql_validate_change_column: When changing a column using alter table, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values: The default value is execute_sql_true.
- execute_sql_current_schema: Use the supplied value as the default schema when processing this SQL command.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ executeSqlRaw() [1/2]
| RawExecuteSqlResponse executeSqlRaw | ( | const ExecuteSqlRequest & | request_ | ) | const |
Execute a SQL statement (query, DML, or DDL).
See SQL Support for the complete set of supported SQL commands.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ executeSqlRaw() [2/2]
| RawExecuteSqlResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ exportQueryMetrics() [1/4]
| ExportQueryMetricsResponse exportQueryMetrics | ( | const ExportQueryMetricsRequest & | request_ | ) | const |
◆ exportQueryMetrics() [2/4]
| ExportQueryMetricsResponse& exportQueryMetrics | ( | const ExportQueryMetricsRequest & | request_, |
| ExportQueryMetricsResponse & | response_ | ||
| ) | const |
Export query metrics to a given destination.
Returns query metrics.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ exportQueryMetrics() [3/4]
| ExportQueryMetricsResponse exportQueryMetrics | ( | const std::map< std::string, std::string > & | options | ) | const |
Export query metrics to a given destination.
Returns query metrics.
- Parameters
-
[in] options Optional parameters. - export_query_metrics_expression: Filter for multi query export
- export_query_metrics_filepath: Path to export target specified as a filename or existing directory.
-
export_query_metrics_format: Specifies which format to export the metrics. Supported values:
- export_query_metrics_json: Generic json output
- export_query_metrics_json_trace_event: Chromium/Perfetto trace event format
- export_query_metrics_job_id: Export query metrics for the currently running job
- export_query_metrics_limit: Record limit per file for multi query export
- Returns
- Response object containing the result of the operation.
◆ exportQueryMetrics() [4/4]
| ExportQueryMetricsResponse& exportQueryMetrics | ( | const std::map< std::string, std::string > & | options, |
| ExportQueryMetricsResponse & | response_ | ||
| ) | const |
Export query metrics to a given destination.
Returns query metrics.
- Parameters
-
[in] options Optional parameters. - export_query_metrics_expression: Filter for multi query export
- export_query_metrics_filepath: Path to export target specified as a filename or existing directory.
-
export_query_metrics_format: Specifies which format to export the metrics. Supported values:
- export_query_metrics_json: Generic json output
- export_query_metrics_json_trace_event: Chromium/Perfetto trace event format
- export_query_metrics_job_id: Export query metrics for the currently running job
- export_query_metrics_limit: Record limit per file for multi query export
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ exportRecordsToFiles() [1/4]
| ExportRecordsToFilesResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ exportRecordsToFiles() [2/4]
| ExportRecordsToFilesResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ exportRecordsToFiles() [3/4]
| 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.
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.
- Parameters
-
[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. - export_records_to_files_batch_size: Number of records to be exported as a batch. The default value is '1000000'.
- export_records_to_files_column_formats: For each source column specified, applies the column-property-bound format. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- export_records_to_files_columns_to_export: Specifies a comma-delimited list of columns from the source table to export, written to the output file in the order they are given. Column names can be provided, in which case the target file will use those names as the column headers as well. Alternatively, column numbers can be specified–discretely or as a range. For example, a value of '5,7,1..3' will write values from the fifth column in the source table into the first column in the target file, from the seventh column in the source table into the second column in the target file, and from the first through third columns in the source table into the third through fifth columns in the target file. Mutually exclusive with columns_to_skip.
- export_records_to_files_columns_to_skip: Comma-separated list of column names or column numbers to not export. All columns in the source table not specified will be written to the target file in the order they appear in the table definition. Mutually exclusive with columns_to_export.
- export_records_to_files_datasink_name: Datasink name, created using createDatasink.
- export_records_to_files_default_column_formats: Specifies the default format to use to write data. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given source column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless custom column_formats for that annotation are specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to write text as "05/04/2000 12:12:11"
- export_records_to_files_export_ddl: Save DDL to a separate file. The default value is 'false'.
- export_records_to_files_file_extension: Extension to give the export file. The default value is '.csv'.
-
export_records_to_files_file_type: Specifies the file format to use when exporting data. Supported values:
- export_records_to_files_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- export_records_to_files_parquet
- export_records_to_files_kinetica_header: Whether to include a Kinetica proprietary header. Will not be written if text_has_header is false. Supported values: The default value is export_records_to_files_false.
- export_records_to_files_kinetica_header_delimiter: If a Kinetica proprietary header is included, then specify a property separator. Different from column delimiter. The default value is '|'.
- export_records_to_files_compression_type: File compression type. GZip can be applied to text and Parquet files. Snappy can only be applied to Parquet files, and is the default compression for them. Supported values:
- export_records_to_files_single_file: Save records to a single file. This option may be ignored if file size exceeds internal file size limits (this limit will differ on different targets). Supported values: The default value is export_records_to_files_true.
- export_records_to_files_single_file_max_size: Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is ''.
- export_records_to_files_text_delimiter: Specifies the character to write out to delimit field values and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- export_records_to_files_text_has_header: Indicates whether to write out a header row. For delimited_text file_type only. Supported values: The default value is export_records_to_files_true.
- export_records_to_files_text_null_string: Specifies the character string that should be written out for the null value in the data. For delimited_text file_type only. The default value is '\N'.
- Returns
- Response object containing the result of the operation.
◆ exportRecordsToFiles() [4/4]
| 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.
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.
- Parameters
-
[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. - export_records_to_files_batch_size: Number of records to be exported as a batch. The default value is '1000000'.
- export_records_to_files_column_formats: For each source column specified, applies the column-property-bound format. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- export_records_to_files_columns_to_export: Specifies a comma-delimited list of columns from the source table to export, written to the output file in the order they are given. Column names can be provided, in which case the target file will use those names as the column headers as well. Alternatively, column numbers can be specified–discretely or as a range. For example, a value of '5,7,1..3' will write values from the fifth column in the source table into the first column in the target file, from the seventh column in the source table into the second column in the target file, and from the first through third columns in the source table into the third through fifth columns in the target file. Mutually exclusive with columns_to_skip.
- export_records_to_files_columns_to_skip: Comma-separated list of column names or column numbers to not export. All columns in the source table not specified will be written to the target file in the order they appear in the table definition. Mutually exclusive with columns_to_export.
- export_records_to_files_datasink_name: Datasink name, created using createDatasink.
- export_records_to_files_default_column_formats: Specifies the default format to use to write data. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given source column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless custom column_formats for that annotation are specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to write text as "05/04/2000 12:12:11"
- export_records_to_files_export_ddl: Save DDL to a separate file. The default value is 'false'.
- export_records_to_files_file_extension: Extension to give the export file. The default value is '.csv'.
-
export_records_to_files_file_type: Specifies the file format to use when exporting data. Supported values:
- export_records_to_files_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- export_records_to_files_parquet
- export_records_to_files_kinetica_header: Whether to include a Kinetica proprietary header. Will not be written if text_has_header is false. Supported values: The default value is export_records_to_files_false.
- export_records_to_files_kinetica_header_delimiter: If a Kinetica proprietary header is included, then specify a property separator. Different from column delimiter. The default value is '|'.
- export_records_to_files_compression_type: File compression type. GZip can be applied to text and Parquet files. Snappy can only be applied to Parquet files, and is the default compression for them. Supported values:
- export_records_to_files_single_file: Save records to a single file. This option may be ignored if file size exceeds internal file size limits (this limit will differ on different targets). Supported values: The default value is export_records_to_files_true.
- export_records_to_files_single_file_max_size: Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is ''.
- export_records_to_files_text_delimiter: Specifies the character to write out to delimit field values and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- export_records_to_files_text_has_header: Indicates whether to write out a header row. For delimited_text file_type only. Supported values: The default value is export_records_to_files_true.
- export_records_to_files_text_null_string: Specifies the character string that should be written out for the null value in the data. For delimited_text file_type only. The default value is '\N'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ exportRecordsToTable() [1/4]
| ExportRecordsToTableResponse exportRecordsToTable | ( | const ExportRecordsToTableRequest & | request_ | ) | const |
◆ exportRecordsToTable() [2/4]
| ExportRecordsToTableResponse& exportRecordsToTable | ( | const ExportRecordsToTableRequest & | request_, |
| ExportRecordsToTableResponse & | response_ | ||
| ) | const |
Exports records from source table to the specified target table in an external database.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ exportRecordsToTable() [3/4]
| 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.
- Parameters
-
[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. - export_records_to_table_batch_size: Batch size, which determines how many rows to export per round trip. The default value is '200000'.
- export_records_to_table_datasink_name: Name of an existing external data sink to which table name specified in tableName will be exported
- export_records_to_table_jdbc_session_init_statement: Executes the statement per each jdbc session before doing actual load. The default value is ''.
- export_records_to_table_jdbc_connection_init_statement: Executes the statement once before doing actual load. The default value is ''.
- export_records_to_table_remote_table: Name of the target table to which source table is exported. When this option is specified remote_query cannot be specified. The default value is ''.
- export_records_to_table_use_st_geomfrom_casts: Wraps parametrized variables with st_geomfromtext or st_geomfromwkb based on source column type. Supported values: The default value is export_records_to_table_false.
- export_records_to_table_use_indexed_parameters: Uses $n style syntax when generating insert query for remote_table option. Supported values: The default value is export_records_to_table_false.
- Returns
- Response object containing the result of the operation.
◆ exportRecordsToTable() [4/4]
| 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.
- Parameters
-
[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. - export_records_to_table_batch_size: Batch size, which determines how many rows to export per round trip. The default value is '200000'.
- export_records_to_table_datasink_name: Name of an existing external data sink to which table name specified in tableName will be exported
- export_records_to_table_jdbc_session_init_statement: Executes the statement per each jdbc session before doing actual load. The default value is ''.
- export_records_to_table_jdbc_connection_init_statement: Executes the statement once before doing actual load. The default value is ''.
- export_records_to_table_remote_table: Name of the target table to which source table is exported. When this option is specified remote_query cannot be specified. The default value is ''.
- export_records_to_table_use_st_geomfrom_casts: Wraps parametrized variables with st_geomfromtext or st_geomfromwkb based on source column type. Supported values: The default value is export_records_to_table_false.
- export_records_to_table_use_indexed_parameters: Uses $n style syntax when generating insert query for remote_table option. Supported values: The default value is export_records_to_table_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filter() [1/4]
| FilterResponse filter | ( | const FilterRequest & | request_ | ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filter() [2/4]
| FilterResponse& filter | ( | const FilterRequest & | request_, |
| FilterResponse & | response_ | ||
| ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filter() [3/4]
| FilterResponse filter | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | expression, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
- Parameters
-
[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. - filter_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_false.
- filter_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_view_id: view this filtered-view is part of. The default value is ''.
- filter_ttl: Sets the TTL of the view specified in viewName.
- Returns
- Response object containing the result of the operation.
◆ filter() [4/4]
| FilterResponse& filter | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | expression, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterResponse & | response_ | ||
| ) | const |
Filters data based on the specified expression.
The results are stored in a result set with the given viewName.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
- Parameters
-
[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. - filter_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_false.
- filter_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_view_id: view this filtered-view is part of. The default value is ''.
- filter_ttl: Sets the TTL of the view specified in viewName.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByArea() [1/4]
| FilterByAreaResponse filterByArea | ( | const FilterByAreaRequest & | request_ | ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByArea() [2/4]
| FilterByAreaResponse& filterByArea | ( | const FilterByAreaRequest & | request_, |
| FilterByAreaResponse & | response_ | ||
| ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByArea() [3/4]
| FilterByAreaResponse filterByArea | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[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. - filter_by_area_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_area_false.
- filter_by_area_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByArea() [4/4]
| FilterByAreaResponse& filterByArea | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::string & | yColumnName, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByAreaResponse & | response_ | ||
| ) | const |
Calculates which objects from a table are within a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[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. - filter_by_area_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_area_false.
- filter_by_area_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByAreaGeometry() [1/4]
| FilterByAreaGeometryResponse filterByAreaGeometry | ( | const FilterByAreaGeometryRequest & | request_ | ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByAreaGeometry() [2/4]
| FilterByAreaGeometryResponse& filterByAreaGeometry | ( | const FilterByAreaGeometryRequest & | request_, |
| FilterByAreaGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByAreaGeometry() [3/4]
| FilterByAreaGeometryResponse filterByAreaGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[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. - filter_by_area_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_area_geometry_false.
- filter_by_area_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByAreaGeometry() [4/4]
| FilterByAreaGeometryResponse& filterByAreaGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::vector< double > & | xVector, | ||
| const std::vector< double > & | yVector, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByAreaGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
- Parameters
-
[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. - filter_by_area_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_area_geometry_false.
- filter_by_area_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] The schema for the newly created view. If the schema is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByBox() [1/4]
| FilterByBoxResponse filterByBox | ( | const FilterByBoxRequest & | request_ | ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByBox() [2/4]
| FilterByBoxResponse& filterByBox | ( | const FilterByBoxRequest & | request_, |
| FilterByBoxResponse & | response_ | ||
| ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByBox() [3/4]
| FilterByBoxResponse filterByBox | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const std::string & | yColumnName, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[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. - filter_by_box_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_box_false.
- filter_by_box_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByBox() [4/4]
| FilterByBoxResponse& filterByBox | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const std::string & | yColumnName, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByBoxResponse & | response_ | ||
| ) | const |
Calculates how many objects within the given table lie in a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[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. - filter_by_box_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_box_false.
- filter_by_box_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByBoxGeometry() [1/4]
| FilterByBoxGeometryResponse filterByBoxGeometry | ( | const FilterByBoxGeometryRequest & | request_ | ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByBoxGeometry() [2/4]
| FilterByBoxGeometryResponse& filterByBoxGeometry | ( | const FilterByBoxGeometryRequest & | request_, |
| FilterByBoxGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByBoxGeometry() [3/4]
| FilterByBoxGeometryResponse filterByBoxGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[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. - filter_by_box_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_box_geometry_false.
- filter_by_box_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByBoxGeometry() [4/4]
| FilterByBoxGeometryResponse& filterByBoxGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByBoxGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a rectangular box.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
- Parameters
-
[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. - filter_by_box_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_box_geometry_false.
- filter_by_box_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByGeometry() [1/4]
| FilterByGeometryResponse filterByGeometry | ( | const FilterByGeometryRequest & | request_ | ) | const |
◆ filterByGeometry() [2/4]
| FilterByGeometryResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByGeometry() [3/4]
| FilterByGeometryResponse 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.
- Parameters
-
[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: - filter_by_geometry_contains: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry.
- filter_by_geometry_crosses: Matches records that cross the given WKT.
- filter_by_geometry_disjoint: Matches records that are disjoint from the given WKT.
- filter_by_geometry_equals: Matches records that are the same as the given WKT.
- filter_by_geometry_intersects: Matches records that intersect the given WKT.
- filter_by_geometry_overlaps: Matches records that overlap the given WKT.
- filter_by_geometry_touches: Matches records that touch the given WKT.
- filter_by_geometry_within: Matches records that are within the given WKT.
[in] options Optional parameters. - filter_by_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_geometry_false.
- filter_by_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByGeometry() [4/4]
| 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.
The filtering geometry is provided by inputWkt.
- Parameters
-
[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: - filter_by_geometry_contains: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry.
- filter_by_geometry_crosses: Matches records that cross the given WKT.
- filter_by_geometry_disjoint: Matches records that are disjoint from the given WKT.
- filter_by_geometry_equals: Matches records that are the same as the given WKT.
- filter_by_geometry_intersects: Matches records that intersect the given WKT.
- filter_by_geometry_overlaps: Matches records that overlap the given WKT.
- filter_by_geometry_touches: Matches records that touch the given WKT.
- filter_by_geometry_within: Matches records that are within the given WKT.
[in] options Optional parameters. - filter_by_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_geometry_false.
- filter_by_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByList() [1/4]
| FilterByListResponse filterByList | ( | const FilterByListRequest & | request_ | ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByList() [2/4]
| FilterByListResponse& filterByList | ( | const FilterByListRequest & | request_, |
| FilterByListResponse & | response_ | ||
| ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByList() [3/4]
| FilterByListResponse filterByList | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::map< std::string, std::vector< std::string > > & | columnValuesMap, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
- Parameters
-
[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. - filter_by_list_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_list_false.
- filter_by_list_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
-
filter_by_list_filter_mode: String indicating the filter mode, either 'in_list' or 'not_in_list'. Supported values:
- filter_by_list_in_list: The filter will match all items that are in the provided list(s).
- filter_by_list_not_in_list: The filter will match all items that are not in the provided list(s).
- Returns
- Response object containing the result of the operation.
◆ filterByList() [4/4]
| FilterByListResponse& filterByList | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::map< std::string, std::vector< std::string > > & | columnValuesMap, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByListResponse & | response_ | ||
| ) | const |
Calculates which records from a table have values in the given list for the corresponding column.
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
- Parameters
-
[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. - filter_by_list_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_list_false.
- filter_by_list_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
-
filter_by_list_filter_mode: String indicating the filter mode, either 'in_list' or 'not_in_list'. Supported values:
- filter_by_list_in_list: The filter will match all items that are in the provided list(s).
- filter_by_list_not_in_list: The filter will match all items that are not in the provided list(s).
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByRadius() [1/4]
| FilterByRadiusResponse filterByRadius | ( | const FilterByRadiusRequest & | request_ | ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByRadius() [2/4]
| FilterByRadiusResponse& filterByRadius | ( | const FilterByRadiusRequest & | request_, |
| FilterByRadiusResponse & | response_ | ||
| ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByRadius() [3/4]
| FilterByRadiusResponse filterByRadius | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | xCenter, | ||
| const std::string & | yColumnName, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
- Parameters
-
[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. - filter_by_radius_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_radius_false.
- filter_by_radius_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByRadius() [4/4]
| FilterByRadiusResponse& filterByRadius | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | xColumnName, | ||
| const double | xCenter, | ||
| const std::string & | yColumnName, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByRadiusResponse & | response_ | ||
| ) | const |
Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
- Parameters
-
[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. - filter_by_radius_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_radius_false.
- filter_by_radius_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByRadiusGeometry() [1/4]
| FilterByRadiusGeometryResponse filterByRadiusGeometry | ( | const FilterByRadiusGeometryRequest & | request_ | ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByRadiusGeometry() [2/4]
| FilterByRadiusGeometryResponse& filterByRadiusGeometry | ( | const FilterByRadiusGeometryRequest & | request_, |
| FilterByRadiusGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByRadiusGeometry() [3/4]
| FilterByRadiusGeometryResponse filterByRadiusGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | xCenter, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
- Parameters
-
[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. - filter_by_radius_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_radius_geometry_false.
- filter_by_radius_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByRadiusGeometry() [4/4]
| FilterByRadiusGeometryResponse& filterByRadiusGeometry | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | xCenter, | ||
| const double | yCenter, | ||
| const double | radius, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByRadiusGeometryResponse & | response_ | ||
| ) | const |
Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI).
The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
- Parameters
-
[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. - filter_by_radius_geometry_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_radius_geometry_false.
- filter_by_radius_geometry_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByRange() [1/4]
| FilterByRangeResponse filterByRange | ( | const FilterByRangeRequest & | request_ | ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByRange() [2/4]
| FilterByRangeResponse& filterByRange | ( | const FilterByRangeRequest & | request_, |
| FilterByRangeResponse & | response_ | ||
| ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByRange() [3/4]
| FilterByRangeResponse filterByRange | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | lowerBound, | ||
| const double | upperBound, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
- Parameters
-
[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. - filter_by_range_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_range_false.
- filter_by_range_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByRange() [4/4]
| FilterByRangeResponse& filterByRange | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const double | lowerBound, | ||
| const double | upperBound, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByRangeResponse & | response_ | ||
| ) | const |
Calculates which objects from a table have a column that is within the given bounds.
An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
- Parameters
-
[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. - filter_by_range_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_range_false.
- filter_by_range_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterBySeries() [1/4]
| FilterBySeriesResponse filterBySeries | ( | const FilterBySeriesRequest & | request_ | ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterBySeries() [2/4]
| FilterBySeriesResponse& filterBySeries | ( | const FilterBySeriesRequest & | request_, |
| FilterBySeriesResponse & | response_ | ||
| ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterBySeries() [3/4]
| FilterBySeriesResponse filterBySeries | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | trackId, | ||
| const std::vector< std::string > & | targetTrackIds, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
- Parameters
-
[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. - filter_by_series_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_series_false.
- filter_by_series_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_series_spatial_radius: A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter. The minimum allowed value is '0'.
- filter_by_series_time_radius: A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter. The minimum allowed value is '0'.
- filter_by_series_spatial_distance_metric: A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Supported values:
- Returns
- Response object containing the result of the operation.
◆ filterBySeries() [4/4]
| FilterBySeriesResponse& filterBySeries | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | trackId, | ||
| const std::vector< std::string > & | targetTrackIds, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterBySeriesResponse & | response_ | ||
| ) | const |
Filters objects matching all points of the given track (works only on track type data).
It allows users to specify a particular track to find all other points in the table that fall within specified ranges (spatial and temporal) of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).
This operation is synchronous, meaning that a response will not be returned until all the objects are fully available.
- Parameters
-
[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. - filter_by_series_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_series_false.
- filter_by_series_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_series_spatial_radius: A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter. The minimum allowed value is '0'.
- filter_by_series_time_radius: A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter. The minimum allowed value is '0'.
- filter_by_series_spatial_distance_metric: A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Supported values:
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByString() [1/4]
| FilterByStringResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByString() [2/4]
| 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.
Setting case_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByString() [3/4]
| FilterByStringResponse 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.
- Parameters
-
[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: - filter_by_string_search: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
- filter_by_string_equals: Exact whole-string match (accelerated).
- filter_by_string_contains: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
- filter_by_string_starts_with: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
- filter_by_string_regex: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
[in] columnNames List of columns on which to apply the filter. Ignored for search mode. [in] options Optional parameters. - filter_by_string_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_string_false.
- filter_by_string_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_string_case_sensitive: If false then string filtering will ignore case. Does not apply to search mode. Supported values: The default value is filter_by_string_true.
- Returns
- Response object containing the result of the operation.
◆ filterByString() [4/4]
| 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.
Setting case_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.
- Parameters
-
[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: - filter_by_string_search: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
- filter_by_string_equals: Exact whole-string match (accelerated).
- filter_by_string_contains: Partial substring match (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
- filter_by_string_starts_with: Strings that start with the given expression (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
- filter_by_string_regex: Full regular expression search (not accelerated). If the column is a string type (non-charN) and the number of records is too large, it will return 0.
[in] columnNames List of columns on which to apply the filter. Ignored for search mode. [in] options Optional parameters. - filter_by_string_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_string_false.
- filter_by_string_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_string_case_sensitive: If false then string filtering will ignore case. Does not apply to search mode. Supported values: The default value is filter_by_string_true.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByTable() [1/4]
| FilterByTableResponse filterByTable | ( | const FilterByTableRequest & | request_ | ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByTable() [2/4]
| FilterByTableResponse& filterByTable | ( | const FilterByTableRequest & | request_, |
| FilterByTableResponse & | response_ | ||
| ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByTable() [3/4]
| FilterByTableResponse filterByTable | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::string & | sourceTableName, | ||
| const std::string & | sourceTableColumnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
- Parameters
-
[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. - filter_by_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_table_false.
- filter_by_table_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_table_filter_mode: String indicating the filter mode, either in_table or not_in_table. Supported values: The default value is filter_by_table_in_table.
- filter_by_table_mode: Mode - should be either spatial or normal. Supported values: The default value is filter_by_table_normal.
- filter_by_table_buffer: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
-
filter_by_table_buffer_method: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
- filter_by_table_normal
- filter_by_table_geos: Use geos 1 edge per corner algorithm
- filter_by_table_max_partition_size: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
- filter_by_table_max_partition_score: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
- filter_by_table_x_column_name: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
- filter_by_table_y_column_name: Name of column containing y value of point being filtered in spatial mode. The default value is 'y'.
- Returns
- Response object containing the result of the operation.
◆ filterByTable() [4/4]
| FilterByTableResponse& filterByTable | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const std::string & | columnName, | ||
| const std::string & | sourceTableName, | ||
| const std::string & | sourceTableColumnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByTableResponse & | response_ | ||
| ) | const |
Filters objects in one table based on objects in another table.
The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
- Parameters
-
[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. - filter_by_table_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_table_false.
- filter_by_table_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- filter_by_table_filter_mode: String indicating the filter mode, either in_table or not_in_table. Supported values: The default value is filter_by_table_in_table.
- filter_by_table_mode: Mode - should be either spatial or normal. Supported values: The default value is filter_by_table_normal.
- filter_by_table_buffer: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
-
filter_by_table_buffer_method: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
- filter_by_table_normal
- filter_by_table_geos: Use geos 1 edge per corner algorithm
- filter_by_table_max_partition_size: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
- filter_by_table_max_partition_score: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
- filter_by_table_x_column_name: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
- filter_by_table_y_column_name: Name of column containing y value of point being filtered in spatial mode. The default value is 'y'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByValue() [1/4]
| FilterByValueResponse filterByValue | ( | const FilterByValueRequest & | request_ | ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ filterByValue() [2/4]
| FilterByValueResponse& filterByValue | ( | const FilterByValueRequest & | request_, |
| FilterByValueResponse & | response_ | ||
| ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ filterByValue() [3/4]
| FilterByValueResponse filterByValue | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const bool | isString, | ||
| const double | value, | ||
| const std::string & | valueStr, | ||
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
- Parameters
-
[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. - filter_by_value_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_value_false.
- filter_by_value_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
- Returns
- Response object containing the result of the operation.
◆ filterByValue() [4/4]
| FilterByValueResponse& filterByValue | ( | const std::string & | tableName, |
| const std::string & | viewName, | ||
| const bool | isString, | ||
| const double | value, | ||
| const std::string & | valueStr, | ||
| const std::string & | columnName, | ||
| const std::map< std::string, std::string > & | options, | ||
| FilterByValueResponse & | response_ | ||
| ) | const |
Calculates which objects from a table has a particular value for a particular column.
The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
- Parameters
-
[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. - filter_by_value_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is filter_by_value_false.
- filter_by_value_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getJob() [1/4]
| GetJobResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ getJob() [2/4]
| GetJobResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getJob() [3/4]
| GetJobResponse 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.
- Parameters
-
[in] jobId A unique identifier for the job whose status and result is to be fetched. [in] options Optional parameters. - get_job_job_tag: Job tag returned in call to create the job
- Returns
- Response object containing the result of the operation.
◆ getJob() [4/4]
| GetJobResponse& getJob | ( | const int64_t | jobId, |
| const std::map< std::string, std::string > & | options, | ||
| GetJobResponse & | response_ | ||
| ) | const |
Get the status and result of asynchronously running job.
See the createJob for starting an asynchronous job. Some fields of the response are filled only after the submitted job has finished execution.
- Parameters
-
[in] jobId A unique identifier for the job whose status and result is to be fetched. [in] options Optional parameters. - get_job_job_tag: Job tag returned in call to create the job
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getRecords() [1/12]
template<typename TResponse >
| GetRecordsResponse<TResponse> getRecords | ( | const GetRecordsRequest & | request_ | ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 28711 of file GPUdbFunctions.hpp.
◆ getRecords() [2/12]
template<typename TResponse >
| GetRecordsResponse<TResponse>& getRecords | ( | const GetRecordsRequest & | request_, |
| GetRecordsResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 28753 of file GPUdbFunctions.hpp.
◆ getRecords() [3/12]
template<typename TResponse >
| GetRecordsResponse<TResponse> getRecords | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_expression: Optional filter expression to apply to the table.
- get_records_fast_index_lookup: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values: The default value is get_records_true.
- get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
- get_records_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_ascending.
- Returns
- Response object containing the result of the operation.
Definition at line 28853 of file GPUdbFunctions.hpp.
◆ getRecords() [4/12]
template<typename TResponse >
| GetRecordsResponse<TResponse>& getRecords | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_expression: Optional filter expression to apply to the table.
- get_records_fast_index_lookup: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values: The default value is get_records_true.
- get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
- get_records_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_ascending.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 28960 of file GPUdbFunctions.hpp.
◆ getRecords() [5/12]
template<typename TResponse >
| GetRecordsResponse<TResponse> getRecords | ( | const ::avro::ValidSchema & | schema_, |
| const GetRecordsRequest & | request_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] schema_ Avro schema object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 29006 of file GPUdbFunctions.hpp.
◆ getRecords() [6/12]
template<typename TResponse >
| GetRecordsResponse<TResponse> getRecords | ( | const Type & | type_, |
| const GetRecordsRequest & | request_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] type_ Type object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 29048 of file GPUdbFunctions.hpp.
◆ getRecords() [7/12]
template<typename TResponse >
| GetRecordsResponse<TResponse>& getRecords | ( | const ::avro::ValidSchema & | schema_, |
| const GetRecordsRequest & | request_, | ||
| GetRecordsResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] schema_ Avro schema object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 29092 of file GPUdbFunctions.hpp.
◆ getRecords() [8/12]
template<typename TResponse >
| GetRecordsResponse<TResponse>& getRecords | ( | const Type & | type_, |
| const GetRecordsRequest & | request_, | ||
| GetRecordsResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] type_ Type object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 29136 of file GPUdbFunctions.hpp.
◆ getRecords() [9/12]
template<typename TResponse >
| GetRecordsResponse<TResponse> getRecords | ( | const ::avro::ValidSchema & | schema_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_expression: Optional filter expression to apply to the table.
- get_records_fast_index_lookup: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values: The default value is get_records_true.
- get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
- get_records_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_ascending.
- Returns
- Response object containing the result of the operation.
Definition at line 29238 of file GPUdbFunctions.hpp.
◆ getRecords() [10/12]
template<typename TResponse >
| GetRecordsResponse<TResponse> getRecords | ( | const Type & | type_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_expression: Optional filter expression to apply to the table.
- get_records_fast_index_lookup: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values: The default value is get_records_true.
- get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
- get_records_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_ascending.
- Returns
- Response object containing the result of the operation.
Definition at line 29345 of file GPUdbFunctions.hpp.
◆ getRecords() [11/12]
template<typename TResponse >
| GetRecordsResponse<TResponse>& getRecords | ( | const ::avro::ValidSchema & | schema_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_expression: Optional filter expression to apply to the table.
- get_records_fast_index_lookup: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values: The default value is get_records_true.
- get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
- get_records_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_ascending.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 29454 of file GPUdbFunctions.hpp.
◆ getRecords() [12/12]
template<typename TResponse >
| GetRecordsResponse<TResponse>& getRecords | ( | const Type & | type_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_expression: Optional filter expression to apply to the table.
- get_records_fast_index_lookup: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values: The default value is get_records_true.
- get_records_sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied).
- get_records_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_ascending.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 29563 of file GPUdbFunctions.hpp.
◆ getRecordsByColumn() [1/4]
| GetRecordsByColumnResponse getRecordsByColumn | ( | const GetRecordsByColumnRequest & | request_ | ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ getRecordsByColumn() [2/4]
| GetRecordsByColumnResponse& getRecordsByColumn | ( | const GetRecordsByColumnRequest & | request_, |
| GetRecordsByColumnResponse & | response_ | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getRecordsByColumn() [3/4]
| GetRecordsByColumnResponse 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.
- Parameters
-
[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 - get_records_by_column_expression: Optional filter expression to apply to the table.
- get_records_by_column_sort_by: Optional column that the data should be sorted by. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''.
- get_records_by_column_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_by_column_ascending.
- get_records_by_column_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
- get_records_by_column_convert_wkts_to_wkbs: If true, then WKT string columns will be returned as WKB bytes. Supported values: The default value is get_records_by_column_false.
- get_records_by_column_route_to_tom: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
- Returns
- Response object containing the result of the operation.
◆ getRecordsByColumn() [4/4]
| GetRecordsByColumnResponse& getRecordsByColumn | ( | const std::string & | tableName, |
| const std::vector< std::string > & | columnNames, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsByColumnResponse & | response_ | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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.
- Parameters
-
[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 - get_records_by_column_expression: Optional filter expression to apply to the table.
- get_records_by_column_sort_by: Optional column that the data should be sorted by. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''.
- get_records_by_column_sort_order: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values: The default value is get_records_by_column_ascending.
- get_records_by_column_order_by: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
- get_records_by_column_convert_wkts_to_wkbs: If true, then WKT string columns will be returned as WKB bytes. Supported values: The default value is get_records_by_column_false.
- get_records_by_column_route_to_tom: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getRecordsByColumnRaw() [1/2]
| RawGetRecordsByColumnResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ getRecordsByColumnRaw() [2/2]
| RawGetRecordsByColumnResponse& getRecordsByColumnRaw | ( | const GetRecordsByColumnRequest & | request_, |
| RawGetRecordsByColumnResponse & | response_ | ||
| ) | const |
For a given table, retrieves the values from the requested column(s).
Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
Window functions, which can perform operations like moving averages, are available through this endpoint as well as 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getRecordsBySeries() [1/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse> getRecordsBySeries | ( | const GetRecordsBySeriesRequest & | request_ | ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 30109 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [2/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries | ( | const GetRecordsBySeriesRequest & | request_, |
| GetRecordsBySeriesResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30161 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [3/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse> getRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
Definition at line 30230 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [4/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsBySeriesResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30308 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [5/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse> getRecordsBySeries | ( | const ::avro::ValidSchema & | schema_, |
| const GetRecordsBySeriesRequest & | request_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] schema_ Avro schema object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 30367 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [6/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse> getRecordsBySeries | ( | const Type & | type_, |
| const GetRecordsBySeriesRequest & | request_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] type_ Type object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 30419 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [7/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries | ( | const ::avro::ValidSchema & | schema_, |
| const GetRecordsBySeriesRequest & | request_, | ||
| GetRecordsBySeriesResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] schema_ Avro schema object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30474 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [8/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries | ( | const Type & | type_, |
| const GetRecordsBySeriesRequest & | request_, | ||
| GetRecordsBySeriesResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] type_ Type object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30528 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [9/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse> getRecordsBySeries | ( | const ::avro::ValidSchema & | schema_, |
| const std::string & | tableName, | ||
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
Definition at line 30599 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [10/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse> getRecordsBySeries | ( | const Type & | type_, |
| const std::string & | tableName, | ||
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
Definition at line 30677 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [11/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries | ( | const ::avro::ValidSchema & | schema_, |
| const std::string & | tableName, | ||
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsBySeriesResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30757 of file GPUdbFunctions.hpp.
◆ getRecordsBySeries() [12/12]
template<typename TResponse >
| GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries | ( | const Type & | type_, |
| const std::string & | tableName, | ||
| const std::string & | worldTableName, | ||
| const int32_t | offset, | ||
| const int32_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsBySeriesResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30837 of file GPUdbFunctions.hpp.
◆ getRecordsBySeriesRaw() [1/2]
| RawGetRecordsBySeriesResponse getRecordsBySeriesRaw | ( | const GetRecordsBySeriesRequest & | request_ | ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ getRecordsBySeriesRaw() [2/2]
| RawGetRecordsBySeriesResponse& getRecordsBySeriesRaw | ( | const GetRecordsBySeriesRequest & | request_, |
| RawGetRecordsBySeriesResponse & | response_ | ||
| ) | const |
Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.
This operation supports paging through the data via the offset and limit parameters.
In contrast to 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getRecordsFromCollection() [1/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection | ( | const GetRecordsFromCollectionRequest & | request_ | ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 30937 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [2/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection | ( | const GetRecordsFromCollectionRequest & | request_, |
| GetRecordsFromCollectionResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 30980 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [3/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: The default value is get_records_from_collection_false.
- get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.
- Returns
- Response object containing the result of the operation.
Definition at line 31062 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [4/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection | ( | const std::string & | tableName, |
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsFromCollectionResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: The default value is get_records_from_collection_false.
- get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 31153 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [5/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection | ( | const ::avro::ValidSchema & | schema_, |
| const GetRecordsFromCollectionRequest & | request_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] schema_ Avro schema object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 31199 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [6/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection | ( | const Type & | type_, |
| const GetRecordsFromCollectionRequest & | request_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] type_ Type object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 31241 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [7/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection | ( | const ::avro::ValidSchema & | schema_, |
| const GetRecordsFromCollectionRequest & | request_, | ||
| GetRecordsFromCollectionResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] schema_ Avro schema object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 31287 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [8/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection | ( | const Type & | type_, |
| const GetRecordsFromCollectionRequest & | request_, | ||
| GetRecordsFromCollectionResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[in] type_ Type object used for decoding returned objects. [in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 31333 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [9/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection | ( | const ::avro::ValidSchema & | schema_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: The default value is get_records_from_collection_false.
- get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.
- Returns
- Response object containing the result of the operation.
Definition at line 31417 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [10/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection | ( | const Type & | type_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: The default value is get_records_from_collection_false.
- get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.
- Returns
- Response object containing the result of the operation.
Definition at line 31506 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [11/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection | ( | const ::avro::ValidSchema & | schema_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsFromCollectionResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: The default value is get_records_from_collection_false.
- get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 31599 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollection() [12/12]
template<typename TResponse >
| GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection | ( | const Type & | type_, |
| const std::string & | tableName, | ||
| const int64_t | offset, | ||
| const int64_t | limit, | ||
| const std::map< std::string, std::string > & | options, | ||
| GetRecordsFromCollectionResponse< TResponse > & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Template Parameters
-
TResponse The type of object being retrieved.
- Parameters
-
[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 - get_records_from_collection_return_record_ids: If true then return the internal record ID along with each returned record. Supported values: The default value is get_records_from_collection_false.
- get_records_from_collection_expression: Optional filter expression to apply to the table. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 31692 of file GPUdbFunctions.hpp.
◆ getRecordsFromCollectionRaw() [1/2]
| RawGetRecordsFromCollectionResponse getRecordsFromCollectionRaw | ( | const GetRecordsFromCollectionRequest & | request_ | ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ getRecordsFromCollectionRaw() [2/2]
| RawGetRecordsFromCollectionResponse& getRecordsFromCollectionRaw | ( | const GetRecordsFromCollectionRequest & | request_, |
| RawGetRecordsFromCollectionResponse & | response_ | ||
| ) | const |
Retrieves records from a collection.
The operation can optionally return the record IDs which can be used in certain queries such as 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)
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ getRecordsRaw() [1/2]
| RawGetRecordsResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ getRecordsRaw() [2/2]
| RawGetRecordsResponse& getRecordsRaw | ( | const GetRecordsRequest & | request_, |
| RawGetRecordsResponse & | response_ | ||
| ) | const |
Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
This operation can be performed on tables 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermission() [1/4]
| GrantPermissionResponse grantPermission | ( | const GrantPermissionRequest & | request_ | ) | const |
◆ grantPermission() [2/4]
| GrantPermissionResponse& grantPermission | ( | const GrantPermissionRequest & | request_, |
| GrantPermissionResponse & | response_ | ||
| ) | const |
Grant user or role the specified permission on the specified object.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermission() [3/4]
| 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.
- Parameters
-
[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: - grant_permission_context: Context
- grant_permission_credential: Credential
- grant_permission_datasink: Data Sink
- grant_permission_datasource: Data Source
- grant_permission_directory: KIFS File Directory
- grant_permission_graph: A Graph object
- grant_permission_proc: UDF Procedure
- grant_permission_schema: Schema
- grant_permission_sql_proc: SQL Procedure
- grant_permission_system: System-level access
- grant_permission_table: Database Table
- grant_permission_table_monitor: Table monitor
[in] permission Permission being granted. Supported values: - grant_permission_admin: Full read/write and administrative access on the object.
- grant_permission_connect: Connect access on the given data source or data sink.
- grant_permission_create: Ability to create new objects of this type.
- grant_permission_delete: Delete rows from tables.
- grant_permission_execute: Ability to Execute the Procedure object.
- grant_permission_insert: Insert access to tables.
- grant_permission_read: Ability to read, list and use the object.
- grant_permission_update: Update access to the table.
- grant_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
- grant_permission_write: Access to write, change and delete objects.
[in] options Optional parameters. - grant_permission_columns: Apply table security to these columns, comma-separated. The default value is ''.
- grant_permission_filter_expression: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
- grant_permission_with_grant_option: Allow the recipient to grant the same permission (or subset) to others. Supported values: The default value is grant_permission_false.
- Returns
- Response object containing the result of the operation.
◆ grantPermission() [4/4]
| 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.
- Parameters
-
[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: - grant_permission_context: Context
- grant_permission_credential: Credential
- grant_permission_datasink: Data Sink
- grant_permission_datasource: Data Source
- grant_permission_directory: KIFS File Directory
- grant_permission_graph: A Graph object
- grant_permission_proc: UDF Procedure
- grant_permission_schema: Schema
- grant_permission_sql_proc: SQL Procedure
- grant_permission_system: System-level access
- grant_permission_table: Database Table
- grant_permission_table_monitor: Table monitor
[in] permission Permission being granted. Supported values: - grant_permission_admin: Full read/write and administrative access on the object.
- grant_permission_connect: Connect access on the given data source or data sink.
- grant_permission_create: Ability to create new objects of this type.
- grant_permission_delete: Delete rows from tables.
- grant_permission_execute: Ability to Execute the Procedure object.
- grant_permission_insert: Insert access to tables.
- grant_permission_read: Ability to read, list and use the object.
- grant_permission_update: Update access to the table.
- grant_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
- grant_permission_write: Access to write, change and delete objects.
[in] options Optional parameters. - grant_permission_columns: Apply table security to these columns, comma-separated. The default value is ''.
- grant_permission_filter_expression: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
- grant_permission_with_grant_option: Allow the recipient to grant the same permission (or subset) to others. Supported values: The default value is grant_permission_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionCredential() [1/4]
| GrantPermissionCredentialResponse grantPermissionCredential | ( | const GrantPermissionCredentialRequest & | request_ | ) | const |
Grants a credential-level permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionCredential() [2/4]
| GrantPermissionCredentialResponse& grantPermissionCredential | ( | const GrantPermissionCredentialRequest & | request_, |
| GrantPermissionCredentialResponse & | response_ | ||
| ) | const |
Grants a credential-level permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionCredential() [3/4]
| 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.
- Parameters
-
[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: - grant_permission_credential_credential_admin: Full read/write and administrative access on the credential.
- grant_permission_credential_credential_read: Ability to read and use the credential.
[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.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionCredential() [4/4]
| 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.
- Parameters
-
[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: - grant_permission_credential_credential_admin: Full read/write and administrative access on the credential.
- grant_permission_credential_credential_read: Ability to read and use the credential.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionDatasource() [1/4]
| GrantPermissionDatasourceResponse grantPermissionDatasource | ( | const GrantPermissionDatasourceRequest & | request_ | ) | const |
Grants a data source permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionDatasource() [2/4]
| GrantPermissionDatasourceResponse& grantPermissionDatasource | ( | const GrantPermissionDatasourceRequest & | request_, |
| GrantPermissionDatasourceResponse & | response_ | ||
| ) | const |
Grants a data source permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionDatasource() [3/4]
| 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.
- Parameters
-
[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: - grant_permission_datasource_admin: Admin access on the given data source
- grant_permission_datasource_connect: Connect access on the given data source
[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.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionDatasource() [4/4]
| 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.
- Parameters
-
[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: - grant_permission_datasource_admin: Admin access on the given data source
- grant_permission_datasource_connect: Connect access on the given data source
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionDirectory() [1/4]
| GrantPermissionDirectoryResponse grantPermissionDirectory | ( | const GrantPermissionDirectoryRequest & | request_ | ) | const |
◆ grantPermissionDirectory() [2/4]
| GrantPermissionDirectoryResponse& grantPermissionDirectory | ( | const GrantPermissionDirectoryRequest & | request_, |
| GrantPermissionDirectoryResponse & | response_ | ||
| ) | const |
Grants a KiFS directory-level permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionDirectory() [3/4]
| 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.
- Parameters
-
[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: - grant_permission_directory_directory_read: For files in the directory, access to list files, download files, or use files in server side functions
- grant_permission_directory_directory_write: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access
[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.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionDirectory() [4/4]
| 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.
- Parameters
-
[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: - grant_permission_directory_directory_read: For files in the directory, access to list files, download files, or use files in server side functions
- grant_permission_directory_directory_write: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionProc() [1/4]
| GrantPermissionProcResponse grantPermissionProc | ( | const GrantPermissionProcRequest & | request_ | ) | const |
◆ grantPermissionProc() [2/4]
| GrantPermissionProcResponse& grantPermissionProc | ( | const GrantPermissionProcRequest & | request_, |
| GrantPermissionProcResponse & | response_ | ||
| ) | const |
Grants a proc-level permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionProc() [3/4]
| GrantPermissionProcResponse grantPermissionProc | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | procName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a proc-level permission to a user or role.
- Parameters
-
[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: - grant_permission_proc_proc_admin: Admin access to the proc.
- grant_permission_proc_proc_execute: Execute access to the proc.
[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.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionProc() [4/4]
| GrantPermissionProcResponse& grantPermissionProc | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | procName, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionProcResponse & | response_ | ||
| ) | const |
Grants a proc-level permission to a user or role.
- Parameters
-
[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: - grant_permission_proc_proc_admin: Admin access to the proc.
- grant_permission_proc_proc_execute: Execute access to the proc.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionSystem() [1/4]
| GrantPermissionSystemResponse grantPermissionSystem | ( | const GrantPermissionSystemRequest & | request_ | ) | const |
◆ grantPermissionSystem() [2/4]
| GrantPermissionSystemResponse& grantPermissionSystem | ( | const GrantPermissionSystemRequest & | request_, |
| GrantPermissionSystemResponse & | response_ | ||
| ) | const |
Grants a system-level permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionSystem() [3/4]
| GrantPermissionSystemResponse grantPermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a system-level permission to a user or role.
- Parameters
-
[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: - grant_permission_system_system_admin: Full access to all data and system functions.
- grant_permission_system_system_user_admin: Access to administer users and roles that do not have system_admin permission.
- grant_permission_system_system_write: Read and write access to all tables.
- grant_permission_system_system_read: Read-only access to all tables.
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionSystem() [4/4]
| GrantPermissionSystemResponse& grantPermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionSystemResponse & | response_ | ||
| ) | const |
Grants a system-level permission to a user or role.
- Parameters
-
[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: - grant_permission_system_system_admin: Full access to all data and system functions.
- grant_permission_system_system_user_admin: Access to administer users and roles that do not have system_admin permission.
- grant_permission_system_system_write: Read and write access to all tables.
- grant_permission_system_system_read: Read-only access to all tables.
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionTable() [1/4]
| GrantPermissionTableResponse grantPermissionTable | ( | const GrantPermissionTableRequest & | request_ | ) | const |
◆ grantPermissionTable() [2/4]
| GrantPermissionTableResponse& grantPermissionTable | ( | const GrantPermissionTableRequest & | request_, |
| GrantPermissionTableResponse & | response_ | ||
| ) | const |
Grants a table-level permission to a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantPermissionTable() [3/4]
| GrantPermissionTableResponse grantPermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::string & | filterExpression, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants a table-level permission to a user or role.
- Parameters
-
[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: - grant_permission_table_table_admin: Full read/write and administrative access to the table.
- grant_permission_table_table_insert: Insert access to the table.
- grant_permission_table_table_update: Update access to the table.
- grant_permission_table_table_delete: Delete access to the table.
- grant_permission_table_table_read: Read access to the table.
[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. - grant_permission_table_columns: Apply security to these columns, comma-separated. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ grantPermissionTable() [4/4]
| GrantPermissionTableResponse& grantPermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::string & | filterExpression, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantPermissionTableResponse & | response_ | ||
| ) | const |
Grants a table-level permission to a user or role.
- Parameters
-
[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: - grant_permission_table_table_admin: Full read/write and administrative access to the table.
- grant_permission_table_table_insert: Insert access to the table.
- grant_permission_table_table_update: Update access to the table.
- grant_permission_table_table_delete: Delete access to the table.
- grant_permission_table_table_read: Read access to the table.
[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. - grant_permission_table_columns: Apply security to these columns, comma-separated. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ grantRole() [1/4]
| GrantRoleResponse grantRole | ( | const GrantRoleRequest & | request_ | ) | const |
◆ grantRole() [2/4]
| GrantRoleResponse& grantRole | ( | const GrantRoleRequest & | request_, |
| GrantRoleResponse & | response_ | ||
| ) | const |
◆ grantRole() [3/4]
| GrantRoleResponse grantRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Grants membership in a role to a user or role.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ grantRole() [4/4]
| GrantRoleResponse& grantRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options, | ||
| GrantRoleResponse & | response_ | ||
| ) | const |
Grants membership in a role to a user or role.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasPermission() [1/4]
| HasPermissionResponse hasPermission | ( | const HasPermissionRequest & | request_ | ) | const |
◆ hasPermission() [2/4]
| HasPermissionResponse& hasPermission | ( | const HasPermissionRequest & | request_, |
| HasPermissionResponse & | response_ | ||
| ) | const |
Checks if the specified user has the specified permission on the specified object.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasPermission() [3/4]
| 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.
- Parameters
-
[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: - has_permission_context: Context
- has_permission_credential: Credential
- has_permission_datasink: Data Sink
- has_permission_datasource: Data Source
- has_permission_directory: KiFS File Directory
- has_permission_graph: A Graph object
- has_permission_proc: UDF Procedure
- has_permission_schema: Schema
- has_permission_sql_proc: SQL Procedure
- has_permission_system: System-level access
- has_permission_table: Database Table
- has_permission_table_monitor: Table monitor
[in] permission Permission to check for. Supported values: - has_permission_admin: Full read/write and administrative access on the object.
- has_permission_connect: Connect access on the given data source or data sink.
- has_permission_create: Ability to create new objects of this type.
- has_permission_delete: Delete rows from tables.
- has_permission_execute: Ability to Execute the Procedure object.
- has_permission_insert: Insert access to tables.
- has_permission_read: Ability to read, list and use the object.
- has_permission_update: Update access to the table.
- has_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
- has_permission_write: Access to write, change and delete objects.
[in] options Optional parameters. - has_permission_no_error_if_not_exists: If false will return an error if the provided object does not exist or is blank. If true then it will return false for hasPermission. Supported values: The default value is has_permission_false.
- Returns
- Response object containing the result of the operation.
◆ hasPermission() [4/4]
| 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.
- Parameters
-
[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: - has_permission_context: Context
- has_permission_credential: Credential
- has_permission_datasink: Data Sink
- has_permission_datasource: Data Source
- has_permission_directory: KiFS File Directory
- has_permission_graph: A Graph object
- has_permission_proc: UDF Procedure
- has_permission_schema: Schema
- has_permission_sql_proc: SQL Procedure
- has_permission_system: System-level access
- has_permission_table: Database Table
- has_permission_table_monitor: Table monitor
[in] permission Permission to check for. Supported values: - has_permission_admin: Full read/write and administrative access on the object.
- has_permission_connect: Connect access on the given data source or data sink.
- has_permission_create: Ability to create new objects of this type.
- has_permission_delete: Delete rows from tables.
- has_permission_execute: Ability to Execute the Procedure object.
- has_permission_insert: Insert access to tables.
- has_permission_read: Ability to read, list and use the object.
- has_permission_update: Update access to the table.
- has_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
- has_permission_write: Access to write, change and delete objects.
[in] options Optional parameters. - has_permission_no_error_if_not_exists: If false will return an error if the provided object does not exist or is blank. If true then it will return false for hasPermission. Supported values: The default value is has_permission_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasProc() [1/4]
| HasProcResponse hasProc | ( | const HasProcRequest & | request_ | ) | const |
◆ hasProc() [2/4]
| HasProcResponse& hasProc | ( | const HasProcRequest & | request_, |
| HasProcResponse & | response_ | ||
| ) | const |
Checks the existence of a proc with the given name.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasProc() [3/4]
| HasProcResponse hasProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks the existence of a proc with the given name.
- Parameters
-
[in] procName Name of the proc to check for existence. [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ hasProc() [4/4]
| HasProcResponse& hasProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| HasProcResponse & | response_ | ||
| ) | const |
Checks the existence of a proc with the given name.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasRole() [1/4]
| HasRoleResponse hasRole | ( | const HasRoleRequest & | request_ | ) | const |
◆ hasRole() [2/4]
| HasRoleResponse& hasRole | ( | const HasRoleRequest & | request_, |
| HasRoleResponse & | response_ | ||
| ) | const |
Checks if the specified user has the specified role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasRole() [3/4]
| 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.
- Parameters
-
[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. - has_role_no_error_if_not_exists: If false will return an error if the provided role does not exist or is blank. If true then it will return false for hasRole. Supported values: The default value is has_role_false.
- has_role_only_direct: If false will search recursively if the principal is a member of role. If true then principal must directly be a member of role. Supported values: The default value is has_role_false.
- Returns
- Response object containing the result of the operation.
◆ hasRole() [4/4]
| 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.
- Parameters
-
[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. - has_role_no_error_if_not_exists: If false will return an error if the provided role does not exist or is blank. If true then it will return false for hasRole. Supported values: The default value is has_role_false.
- has_role_only_direct: If false will search recursively if the principal is a member of role. If true then principal must directly be a member of role. Supported values: The default value is has_role_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasSchema() [1/4]
| HasSchemaResponse hasSchema | ( | const HasSchemaRequest & | request_ | ) | const |
◆ hasSchema() [2/4]
| HasSchemaResponse& hasSchema | ( | const HasSchemaRequest & | request_, |
| HasSchemaResponse & | response_ | ||
| ) | const |
Checks for the existence of a schema with the given name.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasSchema() [3/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ hasSchema() [4/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasTable() [1/4]
| HasTableResponse hasTable | ( | const HasTableRequest & | request_ | ) | const |
◆ hasTable() [2/4]
| HasTableResponse& hasTable | ( | const HasTableRequest & | request_, |
| HasTableResponse & | response_ | ||
| ) | const |
Checks for the existence of a table with the given name.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasTable() [3/4]
| HasTableResponse hasTable | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Checks for the existence of a table with the given name.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ hasTable() [4/4]
| HasTableResponse& hasTable | ( | const std::string & | tableName, |
| const std::map< std::string, std::string > & | options, | ||
| HasTableResponse & | response_ | ||
| ) | const |
Checks for the existence of a table with the given name.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ hasType() [1/4]
| HasTypeResponse hasType | ( | const HasTypeRequest & | request_ | ) | const |
◆ hasType() [2/4]
| HasTypeResponse& hasType | ( | const HasTypeRequest & | request_, |
| HasTypeResponse & | response_ | ||
| ) | const |
◆ hasType() [3/4]
| HasTypeResponse hasType | ( | const std::string & | typeId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Check for the existence of a type.
- Parameters
-
[in] typeId Id of the type returned in response to createType request. [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ hasType() [4/4]
| HasTypeResponse& hasType | ( | const std::string & | typeId, |
| const std::map< std::string, std::string > & | options, | ||
| HasTypeResponse & | response_ | ||
| ) | const |
Check for the existence of a type.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecords() [1/4]
template<typename TRequest >
| InsertRecordsResponse insertRecords | ( | const InsertRecordsRequest< TRequest > & | request_ | ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 33400 of file GPUdbFunctions.hpp.
◆ insertRecords() [2/4]
template<typename TRequest >
| InsertRecordsResponse& insertRecords | ( | const InsertRecordsRequest< TRequest > & | request_, |
| InsertRecordsResponse & | response_ | ||
| ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 33441 of file GPUdbFunctions.hpp.
◆ insertRecords() [3/4]
template<typename TRequest >
| InsertRecordsResponse insertRecords | ( | const std::string & | tableName, |
| const std::vector< TRequest > & | data, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[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. -
insert_records_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_true: Upsert new records when primary keys match existing records
- insert_records_false: Reject new records when primary keys match existing records
-
insert_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by allow_partial_batch & return_individual_errors. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_false: Treat as errors any new records whose primary key values collide with those of existing records
- insert_records_return_record_ids: If true then return the internal record id along for each inserted record. Supported values: The default value is insert_records_false.
- insert_records_truncate_strings: If set to true, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is insert_records_false.
- insert_records_return_individual_errors: If set to true, success will always be returned, and any errors found will be included in the info map. The "bad_record_indices" entry is a comma-separated list of bad records (0-based). And if so, there will also be an "error_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is insert_records_false.
- insert_records_allow_partial_batch: If set to true, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is insert_records_false.
- insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. Supported values: The default value is insert_records_false.
-
insert_records_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values:
- Returns
- Response object containing the result of the operation.
Definition at line 33651 of file GPUdbFunctions.hpp.
◆ insertRecords() [4/4]
template<typename TRequest >
| InsertRecordsResponse& insertRecords | ( | const std::string & | tableName, |
| const std::vector< TRequest > & | data, | ||
| const std::map< std::string, std::string > & | options, | ||
| InsertRecordsResponse & | response_ | ||
| ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[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. -
insert_records_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_true: Upsert new records when primary keys match existing records
- insert_records_false: Reject new records when primary keys match existing records
-
insert_records_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by allow_partial_batch & return_individual_errors. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_false: Treat as errors any new records whose primary key values collide with those of existing records
- insert_records_return_record_ids: If true then return the internal record id along for each inserted record. Supported values: The default value is insert_records_false.
- insert_records_truncate_strings: If set to true, any strings which are too long for their target charN string columns will be truncated to fit. Supported values: The default value is insert_records_false.
- insert_records_return_individual_errors: If set to true, success will always be returned, and any errors found will be included in the info map. The "bad_record_indices" entry is a comma-separated list of bad records (0-based). And if so, there will also be an "error_N" entry for each record with an error, where N is the index (0-based). Supported values: The default value is insert_records_false.
- insert_records_allow_partial_batch: If set to true, all correct records will be inserted and incorrect records will be rejected and reported. Otherwise, the entire batch will be rejected if any records are incorrect. Supported values: The default value is insert_records_false.
- insert_records_dry_run: If set to true, no data will be saved and any errors will be returned. Supported values: The default value is insert_records_false.
[out] response_ Response object containing the results of the operation. -
insert_records_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk, allow_partial_batch, & return_individual_errors. If the specified table does not have a primary key, then this option has no effect. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 33865 of file GPUdbFunctions.hpp.
◆ insertRecordsFromFiles() [1/4]
| InsertRecordsFromFilesResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ insertRecordsFromFiles() [2/4]
| InsertRecordsFromFilesResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsFromFiles() [3/4]
| 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.
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.
- Parameters
-
[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. - insert_records_from_files_type_id: ID of a currently registered type.
- insert_records_from_files_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same name but a different type exists, it is still an error. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_is_replicated: Affects the distribution scheme for the table's data. If true and the given table has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- insert_records_from_files_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- insert_records_from_files_partition_type: Partitioning scheme to use. Supported values:
- insert_records_from_files_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- insert_records_from_files_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- insert_records_from_files_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently, only supported for list partitions. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_ttl: Sets the TTL of the table specified in tableName.
- insert_records_from_files_chunk_size: Indicates the number of records per chunk to be used for this table.
- insert_records_from_files_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- insert_records_from_files_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- insert_records_from_files_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - insert_records_from_files_bad_record_table_name: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When error_handling is abort, bad records table is not populated.
- insert_records_from_files_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. The default value is '10000'.
- insert_records_from_files_bad_record_table_limit_per_input: For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be bad_record_table_limit and total size of the table per rank is limited to bad_record_table_limit.
- insert_records_from_files_batch_size: Number of records to insert per batch when inserting data. The default value is '50000'.
- insert_records_from_files_column_formats: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- insert_records_from_files_columns_to_load: Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns_to_skip.
- insert_records_from_files_columns_to_skip: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
-
insert_records_from_files_compression_type: Source data compression type. Supported values:
- insert_records_from_files_none: No compression.
- insert_records_from_files_auto: Auto detect compression type
- insert_records_from_files_gzip: gzip file compression.
- insert_records_from_files_bzip2: bzip2 file compression.
- insert_records_from_files_datasource_name: Name of an existing external data source from which data file(s) specified in filepaths will be loaded
- insert_records_from_files_default_column_formats: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to interpret text as "05/04/2000 12:12:11"
-
insert_records_from_files_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- insert_records_from_files_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- insert_records_from_files_ignore_bad_records: Malformed records are skipped.
- insert_records_from_files_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
insert_records_from_files_file_type: Specifies the type of the file(s) whose records will be inserted. Supported values:
- insert_records_from_files_avro: Avro file format
- insert_records_from_files_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- insert_records_from_files_gdb: Esri/GDB file format
- insert_records_from_files_json: Json file format
- insert_records_from_files_parquet: Apache Parquet file format
- insert_records_from_files_shapefile: ShapeFile file format
-
insert_records_from_files_flatten_columns: Specifies how to handle nested columns. Supported values:
- insert_records_from_files_true: Break up nested columns to multiple columns
- insert_records_from_files_false: Treat nested columns as json columns instead of flattening
- insert_records_from_files_gdal_configuration_options: Comma separated list of gdal conf options, for the specific requets: key=value
-
insert_records_from_files_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_from_files_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_from_files_false: Treat as errors any new records whose primary key values collide with those of existing records
-
insert_records_from_files_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- insert_records_from_files_full: Run a type inference on the source data (if needed) and ingest
- insert_records_from_files_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- insert_records_from_files_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- insert_records_from_files_kafka_consumers_per_rank: Number of Kafka consumer threads per rank (valid range 1-6). The default value is '1'.
- insert_records_from_files_kafka_group_id: The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
- insert_records_from_files_kafka_offset_reset_policy: Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. Supported values: The default value is insert_records_from_files_earliest.
- insert_records_from_files_kafka_optimistic_ingest: Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_kafka_subscription_cancel_after: Sets the Kafka subscription lifespan (in minutes). Expired subscription will be cancelled automatically.
- insert_records_from_files_kafka_type_inference_fetch_timeout: Maximum time to collect Kafka messages before type inferencing on the set of them.
- insert_records_from_files_layer: Geo files layer(s) name(s): comma separated.
-
insert_records_from_files_loading_mode: Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
- insert_records_from_files_head: The head node loads all data. All files must be available to the head node.
- insert_records_from_files_distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- insert_records_from_files_distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
- insert_records_from_files_local_time_offset: Apply an offset to Avro local timestamp columns.
- insert_records_from_files_max_records_to_load: Limit the number of records to load in this request: if this number is larger than batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread).
- insert_records_from_files_num_tasks_per_rank: Number of tasks for reading file per rank. Default will be system configuration parameter, external_file_reader_num_tasks.
- insert_records_from_files_poll_interval: If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is '0'.
- insert_records_from_files_primary_keys: Comma separated list of column names to set as primary keys, when not specified in the type.
- insert_records_from_files_schema_registry_schema_name: Name of the Avro schema in the schema registry to use when reading Avro records.
- insert_records_from_files_shard_keys: Comma separated list of column names to set as shard keys, when not specified in the type.
- insert_records_from_files_skip_lines: Skip number of lines from begining of file.
- insert_records_from_files_start_offsets: Starting offsets by partition to fetch from kafka. A comma separated list of partition:offset pairs.
- insert_records_from_files_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is insert_records_from_files_false.
-
insert_records_from_files_table_insert_mode: Insertion scheme to use when inserting records from multiple shapefiles. Supported values:
- insert_records_from_files_single: Insert all records into a single table.
- insert_records_from_files_table_per_file: Insert records from each file into a new table corresponding to that file.
- insert_records_from_files_text_comment_string: Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited_text file_type only. The default value is '#'.
- insert_records_from_files_text_delimiter: Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- insert_records_from_files_text_escape_character: Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, & vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited_text file_type only.
- insert_records_from_files_text_has_header: Indicates whether the source data contains a header row. For delimited_text file_type only. Supported values: The default value is insert_records_from_files_true.
- insert_records_from_files_text_header_property_delimiter: Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. For delimited_text file_type only. The default value is '|'.
- insert_records_from_files_text_null_string: Specifies the character string that should be interpreted as a null value in the source data. For delimited_text file_type only. The default value is '\N'.
- insert_records_from_files_text_quote_character: Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited_text file_type only. The default value is '"'.
- insert_records_from_files_text_search_columns: Add 'text_search' property to internally inferenced string columns. Comma seperated list of column names or '*' for all columns. To add 'text_search' property only to string columns greater than or equal to a minimum size, also set the text_search_min_column_length
- insert_records_from_files_text_search_min_column_length: Set the minimum column size for strings to apply the 'text_search' property to. Used only when text_search_columns has a value.
- insert_records_from_files_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_truncate_table: If set to true, truncates the table specified by tableName prior to loading the file(s). Supported values: The default value is insert_records_from_files_false.
-
insert_records_from_files_type_inference_mode: Optimize type inferencing for either speed or accuracy. Supported values:
- insert_records_from_files_accuracy: Scans data to get exactly-typed & sized columns for all data scanned.
- insert_records_from_files_speed: Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned
-
insert_records_from_files_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be 'upserted'). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_from_files_true: Upsert new records when primary keys match existing records
- insert_records_from_files_false: Reject new records when primary keys match existing records
- Returns
- Response object containing the result of the operation.
◆ insertRecordsFromFiles() [4/4]
| 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.
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.
- Parameters
-
[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. - insert_records_from_files_type_id: ID of a currently registered type.
- insert_records_from_files_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same name but a different type exists, it is still an error. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_is_replicated: Affects the distribution scheme for the table's data. If true and the given table has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- insert_records_from_files_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- insert_records_from_files_partition_type: Partitioning scheme to use. Supported values:
- insert_records_from_files_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- insert_records_from_files_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- insert_records_from_files_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently, only supported for list partitions. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_ttl: Sets the TTL of the table specified in tableName.
- insert_records_from_files_chunk_size: Indicates the number of records per chunk to be used for this table.
- insert_records_from_files_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- insert_records_from_files_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- insert_records_from_files_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - insert_records_from_files_bad_record_table_name: Name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When error_handling is abort, bad records table is not populated.
- insert_records_from_files_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. The default value is '10000'.
- insert_records_from_files_bad_record_table_limit_per_input: For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be bad_record_table_limit and total size of the table per rank is limited to bad_record_table_limit.
- insert_records_from_files_batch_size: Number of records to insert per batch when inserting data. The default value is '50000'.
- insert_records_from_files_column_formats: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- insert_records_from_files_columns_to_load: Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns_to_skip.
- insert_records_from_files_columns_to_skip: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
-
insert_records_from_files_compression_type: Source data compression type. Supported values:
- insert_records_from_files_none: No compression.
- insert_records_from_files_auto: Auto detect compression type
- insert_records_from_files_gzip: gzip file compression.
- insert_records_from_files_bzip2: bzip2 file compression.
- insert_records_from_files_datasource_name: Name of an existing external data source from which data file(s) specified in filepaths will be loaded
- insert_records_from_files_default_column_formats: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to interpret text as "05/04/2000 12:12:11"
-
insert_records_from_files_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- insert_records_from_files_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- insert_records_from_files_ignore_bad_records: Malformed records are skipped.
- insert_records_from_files_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
insert_records_from_files_file_type: Specifies the type of the file(s) whose records will be inserted. Supported values:
- insert_records_from_files_avro: Avro file format
- insert_records_from_files_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- insert_records_from_files_gdb: Esri/GDB file format
- insert_records_from_files_json: Json file format
- insert_records_from_files_parquet: Apache Parquet file format
- insert_records_from_files_shapefile: ShapeFile file format
-
insert_records_from_files_flatten_columns: Specifies how to handle nested columns. Supported values:
- insert_records_from_files_true: Break up nested columns to multiple columns
- insert_records_from_files_false: Treat nested columns as json columns instead of flattening
- insert_records_from_files_gdal_configuration_options: Comma separated list of gdal conf options, for the specific requets: key=value
-
insert_records_from_files_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_from_files_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_from_files_false: Treat as errors any new records whose primary key values collide with those of existing records
-
insert_records_from_files_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- insert_records_from_files_full: Run a type inference on the source data (if needed) and ingest
- insert_records_from_files_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- insert_records_from_files_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- insert_records_from_files_kafka_consumers_per_rank: Number of Kafka consumer threads per rank (valid range 1-6). The default value is '1'.
- insert_records_from_files_kafka_group_id: The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
- insert_records_from_files_kafka_offset_reset_policy: Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. Supported values: The default value is insert_records_from_files_earliest.
- insert_records_from_files_kafka_optimistic_ingest: Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_kafka_subscription_cancel_after: Sets the Kafka subscription lifespan (in minutes). Expired subscription will be cancelled automatically.
- insert_records_from_files_kafka_type_inference_fetch_timeout: Maximum time to collect Kafka messages before type inferencing on the set of them.
- insert_records_from_files_layer: Geo files layer(s) name(s): comma separated.
-
insert_records_from_files_loading_mode: Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
- insert_records_from_files_head: The head node loads all data. All files must be available to the head node.
- insert_records_from_files_distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- insert_records_from_files_distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
- insert_records_from_files_local_time_offset: Apply an offset to Avro local timestamp columns.
- insert_records_from_files_max_records_to_load: Limit the number of records to load in this request: if this number is larger than batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread).
- insert_records_from_files_num_tasks_per_rank: Number of tasks for reading file per rank. Default will be system configuration parameter, external_file_reader_num_tasks.
- insert_records_from_files_poll_interval: If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is '0'.
- insert_records_from_files_primary_keys: Comma separated list of column names to set as primary keys, when not specified in the type.
- insert_records_from_files_schema_registry_schema_name: Name of the Avro schema in the schema registry to use when reading Avro records.
- insert_records_from_files_shard_keys: Comma separated list of column names to set as shard keys, when not specified in the type.
- insert_records_from_files_skip_lines: Skip number of lines from begining of file.
- insert_records_from_files_start_offsets: Starting offsets by partition to fetch from kafka. A comma separated list of partition:offset pairs.
- insert_records_from_files_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is insert_records_from_files_false.
-
insert_records_from_files_table_insert_mode: Insertion scheme to use when inserting records from multiple shapefiles. Supported values:
- insert_records_from_files_single: Insert all records into a single table.
- insert_records_from_files_table_per_file: Insert records from each file into a new table corresponding to that file.
- insert_records_from_files_text_comment_string: Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited_text file_type only. The default value is '#'.
- insert_records_from_files_text_delimiter: Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- insert_records_from_files_text_escape_character: Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, & vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited_text file_type only.
- insert_records_from_files_text_has_header: Indicates whether the source data contains a header row. For delimited_text file_type only. Supported values: The default value is insert_records_from_files_true.
- insert_records_from_files_text_header_property_delimiter: Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. For delimited_text file_type only. The default value is '|'.
- insert_records_from_files_text_null_string: Specifies the character string that should be interpreted as a null value in the source data. For delimited_text file_type only. The default value is '\N'.
- insert_records_from_files_text_quote_character: Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited_text file_type only. The default value is '"'.
- insert_records_from_files_text_search_columns: Add 'text_search' property to internally inferenced string columns. Comma seperated list of column names or '*' for all columns. To add 'text_search' property only to string columns greater than or equal to a minimum size, also set the text_search_min_column_length
- insert_records_from_files_text_search_min_column_length: Set the minimum column size for strings to apply the 'text_search' property to. Used only when text_search_columns has a value.
- insert_records_from_files_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is insert_records_from_files_false.
- insert_records_from_files_truncate_table: If set to true, truncates the table specified by tableName prior to loading the file(s). Supported values: The default value is insert_records_from_files_false.
-
insert_records_from_files_type_inference_mode: Optimize type inferencing for either speed or accuracy. Supported values:
- insert_records_from_files_accuracy: Scans data to get exactly-typed & sized columns for all data scanned.
- insert_records_from_files_speed: Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned
-
insert_records_from_files_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be 'upserted'). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_from_files_true: Upsert new records when primary keys match existing records
- insert_records_from_files_false: Reject new records when primary keys match existing records
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsFromPayload() [1/4]
| 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.
The table will be created if it doesn't already exist.
Returns once all records are processed.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ insertRecordsFromPayload() [2/4]
| 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.
The table will be created if it doesn't already exist.
Returns once all records are processed.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsFromPayload() [3/4]
| 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.
The table will be created if it doesn't already exist.
Returns once all records are processed.
- Parameters
-
[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. - insert_records_from_payload_type_id: ID of a currently registered type. The default value is ''.
- insert_records_from_payload_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_is_replicated: Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- insert_records_from_payload_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- insert_records_from_payload_partition_type: Partitioning scheme to use. Supported values:
- insert_records_from_payload_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- insert_records_from_payload_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- insert_records_from_payload_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_ttl: Sets the TTL of the table specified in tableName.
- insert_records_from_payload_chunk_size: Indicates the number of records per chunk to be used for this table.
- insert_records_from_payload_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- insert_records_from_payload_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- insert_records_from_payload_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - insert_records_from_payload_avro_header_bytes: Optional number of bytes to skip when reading an avro record.
- insert_records_from_payload_avro_num_records: Optional number of avro records, if data includes only records.
- insert_records_from_payload_avro_schema: Optional string representing avro schema, for insert records in avro format, that does not include is schema.
- insert_records_from_payload_avro_schemaless: When user provides 'avro_schema', avro data is assumed to be schemaless, unless specified. Default is 'true' when given avro_schema. Igonred when avro_schema is not given. Supported values:
- insert_records_from_payload_bad_record_table_name: Optional name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string).
- insert_records_from_payload_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000
- insert_records_from_payload_bad_record_table_limit_per_input: For subscriptions: A positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be 'bad_record_table_limit' and total size of the table per rank is limited to 'bad_record_table_limit'
- insert_records_from_payload_batch_size: Internal tuning parameter–number of records per batch when inserting data.
- insert_records_from_payload_column_formats: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- insert_records_from_payload_columns_to_load: Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns_to_skip.
- insert_records_from_payload_columns_to_skip: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
-
insert_records_from_payload_compression_type: Optional: payload compression type. Supported values:
- insert_records_from_payload_none: Uncompressed
- insert_records_from_payload_auto: Default. Auto detect compression type
- insert_records_from_payload_gzip: gzip file compression.
- insert_records_from_payload_bzip2: bzip2 file compression.
- insert_records_from_payload_default_column_formats: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to interpret text as "05/04/2000 12:12:11"
-
insert_records_from_payload_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- insert_records_from_payload_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- insert_records_from_payload_ignore_bad_records: Malformed records are skipped.
- insert_records_from_payload_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
insert_records_from_payload_file_type: Specifies the type of the file(s) whose records will be inserted. Supported values:
- insert_records_from_payload_avro: Avro file format
- insert_records_from_payload_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- insert_records_from_payload_gdb: Esri/GDB file format
- insert_records_from_payload_json: Json file format
- insert_records_from_payload_parquet: Apache Parquet file format
- insert_records_from_payload_shapefile: ShapeFile file format
-
insert_records_from_payload_flatten_columns: Specifies how to handle nested columns. Supported values:
- insert_records_from_payload_true: Break up nested columns to multiple columns
- insert_records_from_payload_false: Treat nested columns as json columns instead of flattening
- insert_records_from_payload_gdal_configuration_options: Comma separated list of gdal conf options, for the specific requets: key=value. The default value is ''.
-
insert_records_from_payload_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_from_payload_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_from_payload_false: Treat as errors any new records whose primary key values collide with those of existing records
-
insert_records_from_payload_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- insert_records_from_payload_full: Run a type inference on the source data (if needed) and ingest
- insert_records_from_payload_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- insert_records_from_payload_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- insert_records_from_payload_layer: Optional: geo files layer(s) name(s): comma separated. The default value is ''.
-
insert_records_from_payload_loading_mode: Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
- insert_records_from_payload_head: The head node loads all data. All files must be available to the head node.
- insert_records_from_payload_distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- insert_records_from_payload_distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
- insert_records_from_payload_local_time_offset: For Avro local timestamp columns
- insert_records_from_payload_max_records_to_load: Limit the number of records to load in this request: If this number is larger than a batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread). The default value is ''.
- insert_records_from_payload_num_tasks_per_rank: Optional: number of tasks for reading file per rank. Default will be external_file_reader_num_tasks
- insert_records_from_payload_poll_interval: If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds.
- insert_records_from_payload_primary_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_payload_schema_registry_schema_id
- insert_records_from_payload_schema_registry_schema_name
- insert_records_from_payload_schema_registry_schema_version
- insert_records_from_payload_shard_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_payload_skip_lines: Skip number of lines from begining of file.
- insert_records_from_payload_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_table_insert_mode: Optional: table_insert_mode. When inserting records from multiple files: if table_per_file then insert from each file into a new table. Currently supported only for shapefiles. Supported values: The default value is insert_records_from_payload_single.
- insert_records_from_payload_text_comment_string: Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited_text file_type only. The default value is '#'.
- insert_records_from_payload_text_delimiter: Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- insert_records_from_payload_text_escape_character: Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, & vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited_text file_type only.
- insert_records_from_payload_text_has_header: Indicates whether the source data contains a header row. For delimited_text file_type only. Supported values: The default value is insert_records_from_payload_true.
- insert_records_from_payload_text_header_property_delimiter: Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. For delimited_text file_type only. The default value is '|'.
- insert_records_from_payload_text_null_string: Specifies the character string that should be interpreted as a null value in the source data. For delimited_text file_type only. The default value is '\N'.
- insert_records_from_payload_text_quote_character: Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited_text file_type only. The default value is '"'.
- insert_records_from_payload_text_search_columns: Add 'text_search' property to internally inferenced string columns. Comma seperated list of column names or '*' for all columns. To add text_search property only to string columns of minimum size, set also the option 'text_search_min_column_length'
- insert_records_from_payload_text_search_min_column_length: Set minimum column size. Used only when 'text_search_columns' has a value.
- insert_records_from_payload_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_truncate_table: If set to true, truncates the table specified by tableName prior to loading the file(s). Supported values: The default value is insert_records_from_payload_false.
-
insert_records_from_payload_type_inference_mode: optimize type inference for: Supported values:
- insert_records_from_payload_accuracy: Scans data to get exactly-typed & sized columns for all data scanned.
- insert_records_from_payload_speed: Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned
-
insert_records_from_payload_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_from_payload_true: Upsert new records when primary keys match existing records
- insert_records_from_payload_false: Reject new records when primary keys match existing records
- Returns
- Response object containing the result of the operation.
◆ insertRecordsFromPayload() [4/4]
| 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.
The table will be created if it doesn't already exist.
Returns once all records are processed.
- Parameters
-
[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. - insert_records_from_payload_type_id: ID of a currently registered type. The default value is ''.
- insert_records_from_payload_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_is_replicated: Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- insert_records_from_payload_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- insert_records_from_payload_partition_type: Partitioning scheme to use. Supported values:
- insert_records_from_payload_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- insert_records_from_payload_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- insert_records_from_payload_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_ttl: Sets the TTL of the table specified in tableName.
- insert_records_from_payload_chunk_size: Indicates the number of records per chunk to be used for this table.
- insert_records_from_payload_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this table.
- insert_records_from_payload_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this table.
- insert_records_from_payload_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - insert_records_from_payload_avro_header_bytes: Optional number of bytes to skip when reading an avro record.
- insert_records_from_payload_avro_num_records: Optional number of avro records, if data includes only records.
- insert_records_from_payload_avro_schema: Optional string representing avro schema, for insert records in avro format, that does not include is schema.
- insert_records_from_payload_avro_schemaless: When user provides 'avro_schema', avro data is assumed to be schemaless, unless specified. Default is 'true' when given avro_schema. Igonred when avro_schema is not given. Supported values:
- insert_records_from_payload_bad_record_table_name: Optional name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string).
- insert_records_from_payload_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000
- insert_records_from_payload_bad_record_table_limit_per_input: For subscriptions: A positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload. Default value will be 'bad_record_table_limit' and total size of the table per rank is limited to 'bad_record_table_limit'
- insert_records_from_payload_batch_size: Internal tuning parameter–number of records per batch when inserting data.
- insert_records_from_payload_column_formats: For each target column specified, applies the column-property-bound format to the source data loaded into that column. Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, & datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., '{ "order_date" : { "date" : "%Y.%m.%d" }, "order_time" : { "time" : "%H:%M:%S" } }'. See default_column_formats for valid format syntax.
- insert_records_from_payload_columns_to_load: Specifies a comma-delimited list of columns from the source data to load. If more than one file is being loaded, this list applies to all files. Column numbers can be specified discretely or as a range. For example, a value of '5,7,1..3' will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table. If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn't exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of 'C, B, A' will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful. Mutually exclusive with columns_to_skip.
- insert_records_from_payload_columns_to_skip: Specifies a comma-delimited list of columns from the source data to skip. Mutually exclusive with columns_to_load.
-
insert_records_from_payload_compression_type: Optional: payload compression type. Supported values:
- insert_records_from_payload_none: Uncompressed
- insert_records_from_payload_auto: Default. Auto detect compression type
- insert_records_from_payload_gzip: gzip file compression.
- insert_records_from_payload_bzip2: bzip2 file compression.
- insert_records_from_payload_default_column_formats: Specifies the default format to be applied to source data loaded into columns with the corresponding column property. Currently supported column properties include date, time, & datetime. This default column-property-bound format can be overridden by specifying a column property & format for a given target column in column_formats. For each specified annotation, the format will apply to all columns with that annotation unless a custom column_formats for that annotation is specified. The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., '{ "date" : "%Y.%m.%d", "time" : "%H:%M:%S" }'. Column formats are specified as a string of control characters and plain text. The supported control characters are 'Y', 'm', 'd', 'H', 'M', 'S', and 's', which follow the Linux 'strptime()' specification, as well as 's', which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds). Formats for the 'date' annotation must include the 'Y', 'm', and 'd' control characters. Formats for the 'time' annotation must include the 'H', 'M', and either 'S' or 's' (but not both) control characters. Formats for the 'datetime' annotation meet both the 'date' and 'time' control character requirements. For example, '{"datetime" : "%m/%d/%Y %H:%M:%S" }' would be used to interpret text as "05/04/2000 12:12:11"
-
insert_records_from_payload_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- insert_records_from_payload_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- insert_records_from_payload_ignore_bad_records: Malformed records are skipped.
- insert_records_from_payload_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
insert_records_from_payload_file_type: Specifies the type of the file(s) whose records will be inserted. Supported values:
- insert_records_from_payload_avro: Avro file format
- insert_records_from_payload_delimited_text: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- insert_records_from_payload_gdb: Esri/GDB file format
- insert_records_from_payload_json: Json file format
- insert_records_from_payload_parquet: Apache Parquet file format
- insert_records_from_payload_shapefile: ShapeFile file format
-
insert_records_from_payload_flatten_columns: Specifies how to handle nested columns. Supported values:
- insert_records_from_payload_true: Break up nested columns to multiple columns
- insert_records_from_payload_false: Treat nested columns as json columns instead of flattening
- insert_records_from_payload_gdal_configuration_options: Comma separated list of gdal conf options, for the specific requets: key=value. The default value is ''.
-
insert_records_from_payload_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_from_payload_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_from_payload_false: Treat as errors any new records whose primary key values collide with those of existing records
-
insert_records_from_payload_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- insert_records_from_payload_full: Run a type inference on the source data (if needed) and ingest
- insert_records_from_payload_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- insert_records_from_payload_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- insert_records_from_payload_layer: Optional: geo files layer(s) name(s): comma separated. The default value is ''.
-
insert_records_from_payload_loading_mode: Scheme for distributing the extraction and loading of data from the source data file(s). This option applies only when loading files that are local to the database. Supported values:
- insert_records_from_payload_head: The head node loads all data. All files must be available to the head node.
- insert_records_from_payload_distributed_shared: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- insert_records_from_payload_distributed_local: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn't exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
- insert_records_from_payload_local_time_offset: For Avro local timestamp columns
- insert_records_from_payload_max_records_to_load: Limit the number of records to load in this request: If this number is larger than a batch_size, then the number of records loaded will be limited to the next whole number of batch_size (per working thread). The default value is ''.
- insert_records_from_payload_num_tasks_per_rank: Optional: number of tasks for reading file per rank. Default will be external_file_reader_num_tasks
- insert_records_from_payload_poll_interval: If true, the number of seconds between attempts to load external files into the table. If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds.
- insert_records_from_payload_primary_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_payload_schema_registry_schema_id
- insert_records_from_payload_schema_registry_schema_name
- insert_records_from_payload_schema_registry_schema_version
- insert_records_from_payload_shard_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_payload_skip_lines: Skip number of lines from begining of file.
- insert_records_from_payload_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_table_insert_mode: Optional: table_insert_mode. When inserting records from multiple files: if table_per_file then insert from each file into a new table. Currently supported only for shapefiles. Supported values: The default value is insert_records_from_payload_single.
- insert_records_from_payload_text_comment_string: Specifies the character string that should be interpreted as a comment line prefix in the source data. All lines in the data starting with the provided string are ignored. For delimited_text file_type only. The default value is '#'.
- insert_records_from_payload_text_delimiter: Specifies the character delimiting field values in the source data and field names in the header (if present). For delimited_text file_type only. The default value is ','.
- insert_records_from_payload_text_escape_character: Specifies the character that is used to escape other characters in the source data. An 'a', 'b', 'f', 'n', 'r', 't', or 'v' preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, & vertical tab, respectively. For example, the escape character followed by an 'n' will be interpreted as a newline within a field value. The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not. For delimited_text file_type only.
- insert_records_from_payload_text_has_header: Indicates whether the source data contains a header row. For delimited_text file_type only. Supported values: The default value is insert_records_from_payload_true.
- insert_records_from_payload_text_header_property_delimiter: Specifies the delimiter for column properties in the header row (if present). Cannot be set to same value as text_delimiter. For delimited_text file_type only. The default value is '|'.
- insert_records_from_payload_text_null_string: Specifies the character string that should be interpreted as a null value in the source data. For delimited_text file_type only. The default value is '\N'.
- insert_records_from_payload_text_quote_character: Specifies the character that should be interpreted as a field value quoting character in the source data. The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string. For delimited_text file_type only. The default value is '"'.
- insert_records_from_payload_text_search_columns: Add 'text_search' property to internally inferenced string columns. Comma seperated list of column names or '*' for all columns. To add text_search property only to string columns of minimum size, set also the option 'text_search_min_column_length'
- insert_records_from_payload_text_search_min_column_length: Set minimum column size. Used only when 'text_search_columns' has a value.
- insert_records_from_payload_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is insert_records_from_payload_false.
- insert_records_from_payload_truncate_table: If set to true, truncates the table specified by tableName prior to loading the file(s). Supported values: The default value is insert_records_from_payload_false.
-
insert_records_from_payload_type_inference_mode: optimize type inference for: Supported values:
- insert_records_from_payload_accuracy: Scans data to get exactly-typed & sized columns for all data scanned.
- insert_records_from_payload_speed: Scans data and picks the widest possible column types so that 'all' values will fit with minimum data scanned
-
insert_records_from_payload_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_from_payload_true: Upsert new records when primary keys match existing records
- insert_records_from_payload_false: Reject new records when primary keys match existing records
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsFromQuery() [1/4]
| InsertRecordsFromQueryResponse insertRecordsFromQuery | ( | const InsertRecordsFromQueryRequest & | request_ | ) | const |
◆ insertRecordsFromQuery() [2/4]
| InsertRecordsFromQueryResponse& insertRecordsFromQuery | ( | const InsertRecordsFromQueryRequest & | request_, |
| InsertRecordsFromQueryResponse & | response_ | ||
| ) | const |
Computes remote query result and inserts the result data into a new or existing table.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsFromQuery() [3/4]
| 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.
- Parameters
-
[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. - insert_records_from_query_type_id: ID of a currently registered type. The default value is ''.
- insert_records_from_query_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_is_replicated: Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- insert_records_from_query_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- insert_records_from_query_partition_type: Partitioning scheme to use. Supported values:
- insert_records_from_query_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- insert_records_from_query_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- insert_records_from_query_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_ttl: Sets the TTL of the table specified in tableName.
- insert_records_from_query_chunk_size: Indicates the number of records per chunk to be used for this table.
- insert_records_from_query_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - insert_records_from_query_bad_record_table_name: Optional name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When error handling is Abort, bad records table is not populated.
- insert_records_from_query_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000
- insert_records_from_query_batch_size: Number of records per batch when inserting data.
- insert_records_from_query_datasource_name: Name of an existing external data source from which table will be loaded
-
insert_records_from_query_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- insert_records_from_query_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- insert_records_from_query_ignore_bad_records: Malformed records are skipped.
- insert_records_from_query_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
insert_records_from_query_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_from_query_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_from_query_false: Treat as errors any new records whose primary key values collide with those of existing records
-
insert_records_from_query_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- insert_records_from_query_full: Run a type inference on the source data (if needed) and ingest
- insert_records_from_query_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- insert_records_from_query_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- insert_records_from_query_jdbc_fetch_size: The JDBC fetch size, which determines how many rows to fetch per round trip.
- insert_records_from_query_jdbc_session_init_statement: Executes the statement per each jdbc session before doing actual load. The default value is ''.
- insert_records_from_query_num_splits_per_rank: Optional: number of splits for reading data per rank. Default will be external_file_reader_num_tasks. The default value is ''.
- insert_records_from_query_num_tasks_per_rank: Optional: number of tasks for reading data per rank. Default will be external_file_reader_num_tasks
- insert_records_from_query_primary_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_query_shard_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_query_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_truncate_table: If set to true, truncates the table specified by tableName prior to loading the data. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_remote_query: Remote SQL query from which data will be sourced
- insert_records_from_query_remote_query_order_by: Name of column to be used for splitting the query into multiple sub-queries using ordering of given column. The default value is ''.
- insert_records_from_query_remote_query_filter_column: Name of column to be used for splitting the query into multiple sub-queries using the data distribution of given column. The default value is ''.
- insert_records_from_query_remote_query_increasing_column: Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP). The default value is ''.
- insert_records_from_query_remote_query_partition_column: Alias name for remote_query_filter_column. The default value is ''.
- insert_records_from_query_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is insert_records_from_query_false.
-
insert_records_from_query_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_from_query_true: Upsert new records when primary keys match existing records
- insert_records_from_query_false: Reject new records when primary keys match existing records
- Returns
- Response object containing the result of the operation.
◆ insertRecordsFromQuery() [4/4]
| 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.
- Parameters
-
[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. - insert_records_from_query_type_id: ID of a currently registered type. The default value is ''.
- insert_records_from_query_no_error_if_exists: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_is_replicated: Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_foreign_keys: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
- insert_records_from_query_foreign_shard_key: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.
- insert_records_from_query_partition_type: Partitioning scheme to use. Supported values:
- insert_records_from_query_partition_keys: Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.
- insert_records_from_query_partition_definitions: Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.
- insert_records_from_query_is_automatic_partition: If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_ttl: Sets the TTL of the table specified in tableName.
- insert_records_from_query_chunk_size: Indicates the number of records per chunk to be used for this table.
- insert_records_from_query_is_result_table: Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data-handling, and it will not be retained if the server is restarted. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_strategy_definition: The tier strategy for the table and its columns.
[in] options Optional parameters. - insert_records_from_query_bad_record_table_name: Optional name of a table to which records that were rejected are written. The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When error handling is Abort, bad records table is not populated.
- insert_records_from_query_bad_record_table_limit: A positive integer indicating the maximum number of records that can be written to the bad-record-table. Default value is 10000
- insert_records_from_query_batch_size: Number of records per batch when inserting data.
- insert_records_from_query_datasource_name: Name of an existing external data source from which table will be loaded
-
insert_records_from_query_error_handling: Specifies how errors should be handled upon insertion. Supported values:
- insert_records_from_query_permissive: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- insert_records_from_query_ignore_bad_records: Malformed records are skipped.
- insert_records_from_query_abort: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
-
insert_records_from_query_ignore_existing_pk: Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when update_on_existing_pk is false). If set to true, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If false, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by error_handling. If the specified table does not have a primary key or if upsert mode is in effect (update_on_existing_pk is true), then this option has no effect. Supported values:
- insert_records_from_query_true: Ignore new records whose primary key values collide with those of existing records
- insert_records_from_query_false: Treat as errors any new records whose primary key values collide with those of existing records
-
insert_records_from_query_ingestion_mode: Whether to do a full load, dry run, or perform a type inference on the source data. Supported values:
- insert_records_from_query_full: Run a type inference on the source data (if needed) and ingest
- insert_records_from_query_dry_run: Does not load data, but walks through the source data and determines the number of valid records, taking into account the current mode of error_handling.
- insert_records_from_query_type_inference_only: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
- insert_records_from_query_jdbc_fetch_size: The JDBC fetch size, which determines how many rows to fetch per round trip.
- insert_records_from_query_jdbc_session_init_statement: Executes the statement per each jdbc session before doing actual load. The default value is ''.
- insert_records_from_query_num_splits_per_rank: Optional: number of splits for reading data per rank. Default will be external_file_reader_num_tasks. The default value is ''.
- insert_records_from_query_num_tasks_per_rank: Optional: number of tasks for reading data per rank. Default will be external_file_reader_num_tasks
- insert_records_from_query_primary_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_query_shard_keys: Optional: comma separated list of column names, to set as primary keys, when not specified in the type. The default value is ''.
- insert_records_from_query_subscribe: Continuously poll the data source to check for new data and load it into the table. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_truncate_table: If set to true, truncates the table specified by tableName prior to loading the data. Supported values: The default value is insert_records_from_query_false.
- insert_records_from_query_remote_query: Remote SQL query from which data will be sourced
- insert_records_from_query_remote_query_order_by: Name of column to be used for splitting the query into multiple sub-queries using ordering of given column. The default value is ''.
- insert_records_from_query_remote_query_filter_column: Name of column to be used for splitting the query into multiple sub-queries using the data distribution of given column. The default value is ''.
- insert_records_from_query_remote_query_increasing_column: Column on subscribed remote query result that will increase for new records (e.g., TIMESTAMP). The default value is ''.
- insert_records_from_query_remote_query_partition_column: Alias name for remote_query_filter_column. The default value is ''.
- insert_records_from_query_truncate_strings: If set to true, truncate string values that are longer than the column's type size. Supported values: The default value is insert_records_from_query_false.
-
insert_records_from_query_update_on_existing_pk: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be "upserted"). If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by ignore_existing_pk & error_handling. If the specified table does not have a primary key, then this option has no effect. Supported values:
- insert_records_from_query_true: Upsert new records when primary keys match existing records
- insert_records_from_query_false: Reject new records when primary keys match existing records
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsRandom() [1/4]
| InsertRecordsRandomResponse insertRecordsRandom | ( | const InsertRecordsRandomRequest & | request_ | ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ insertRecordsRandom() [2/4]
| InsertRecordsRandomResponse& insertRecordsRandom | ( | const InsertRecordsRandomRequest & | request_, |
| InsertRecordsRandomResponse & | response_ | ||
| ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsRandom() [3/4]
| InsertRecordsRandomResponse insertRecordsRandom | ( | const std::string & | tableName, |
| const int64_t | count, | ||
| const std::map< std::string, std::map< std::string, double > > & | options | ||
| ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
- Parameters
-
[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: -
insert_records_random_seed: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }.
- insert_records_random_value: The seed value to use
-
insert_records_random_all: This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.
- insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings. If both minimum and maximum are provided, max must be greater than or equal to min. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
- insert_records_random_null_percentage: If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
- insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
-
insert_records_random_attr_name: Use the desired column name in place of attr_name, and set the following parameters for the column specified. This overrides any parameter set by all.
- insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings. If both minimum and maximum are provided, max must be greater than or equal to min. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
- insert_records_random_null_percentage: If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
- insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
-
insert_records_random_track_length: This key-map pair is only valid for track data sets (an error is thrown otherwise). No nulls would be generated for nullable columns.
- insert_records_random_min: Minimum possible length for generated series; default is 100 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max. The minimum allowed value is 1. The maximum allowed value is 500.
- insert_records_random_max: Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min. The minimum allowed value is 1. The maximum allowed value is 500.
-
insert_records_random_seed: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }.
- Returns
- Response object containing the result of the operation.
◆ insertRecordsRandom() [4/4]
| InsertRecordsRandomResponse& insertRecordsRandom | ( | const std::string & | tableName, |
| const int64_t | count, | ||
| const std::map< std::string, std::map< std::string, double > > & | options, | ||
| InsertRecordsRandomResponse & | response_ | ||
| ) | const |
Generates a specified number of random records and adds them to the given table.
There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.
This operation is synchronous, meaning that a response will not be returned until all random records are fully available.
- Parameters
-
[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: -
insert_records_random_seed: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }.
- insert_records_random_value: The seed value to use
-
insert_records_random_all: This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records.
- insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings. If both minimum and maximum are provided, max must be greater than or equal to min. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
- insert_records_random_null_percentage: If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
- insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
-
insert_records_random_attr_name: Use the desired column name in place of attr_name, and set the following parameters for the column specified. This overrides any parameter set by all.
- insert_records_random_min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings. If both minimum and maximum are provided, max must be greater than or equal to min. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
- insert_records_random_interval: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
- insert_records_random_null_percentage: If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
- insert_records_random_cardinality: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
-
insert_records_random_track_length: This key-map pair is only valid for track data sets (an error is thrown otherwise). No nulls would be generated for nullable columns.
- insert_records_random_min: Minimum possible length for generated series; default is 100 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, min must be less than or equal to max. The minimum allowed value is 1. The maximum allowed value is 500.
- insert_records_random_max: Maximum possible length for generated series; default is 500 records per series. Must be an integral value within the range [1, 500]. If both min and max are specified, max must be greater than or equal to min. The minimum allowed value is 1. The maximum allowed value is 500.
[out] response_ Response object containing the results of the operation. -
insert_records_random_seed: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertRecordsRaw() [1/2]
| InsertRecordsResponse insertRecordsRaw | ( | const RawInsertRecordsRequest & | request_ | ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ insertRecordsRaw() [2/2]
| InsertRecordsResponse& insertRecordsRaw | ( | const RawInsertRecordsRequest & | request_, |
| InsertRecordsResponse & | response_ | ||
| ) | const |
Adds multiple records to the specified table.
The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The options parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertSymbol() [1/4]
| InsertSymbolResponse insertSymbol | ( | const InsertSymbolRequest & | request_ | ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ insertSymbol() [2/4]
| InsertSymbolResponse& insertSymbol | ( | const InsertSymbolRequest & | request_, |
| InsertSymbolResponse & | response_ | ||
| ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ insertSymbol() [3/4]
| InsertSymbolResponse insertSymbol | ( | const std::string & | symbolId, |
| const std::string & | symbolFormat, | ||
| const std::vector< uint8_t > & | symbolData, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
- Parameters
-
[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. - insert_symbol_color: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
- Returns
- Response object containing the result of the operation.
◆ insertSymbol() [4/4]
| InsertSymbolResponse& insertSymbol | ( | const std::string & | symbolId, |
| const std::string & | symbolFormat, | ||
| const std::vector< uint8_t > & | symbolData, | ||
| const std::map< std::string, std::string > & | options, | ||
| InsertSymbolResponse & | response_ | ||
| ) | const |
Adds a symbol or icon (i.e. an image) to represent data points when data is rendered visually.
Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used to pick the symbol displayed for each point.
- Parameters
-
[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. - insert_symbol_color: If symbolFormat is 'svg' this is ignored. If symbolFormat is 'svg_path' then this option specifies the color (in RRGGBB hex format) of the path. For example, to have the path rendered in red, used 'FF0000'. If 'color' is not provided then '00FF00' (i.e. green) is used by default.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ killProc() [1/4]
| KillProcResponse killProc | ( | const KillProcRequest & | request_ | ) | const |
◆ killProc() [2/4]
| KillProcResponse& killProc | ( | const KillProcRequest & | request_, |
| KillProcResponse & | response_ | ||
| ) | const |
◆ killProc() [3/4]
| KillProcResponse killProc | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Kills a running proc instance.
- Parameters
-
[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. - kill_proc_run_tag: If runId is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to executeProc. If runId is not specified, kill the proc instance(s) where a matching run tag was provided to executeProc. The default value is ''.
- kill_proc_clear_execute_at_startup: If true, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from executeProc and can be retrieved using showProc. Supported values: The default value is kill_proc_false.
- Returns
- Response object containing the result of the operation.
◆ killProc() [4/4]
| KillProcResponse& killProc | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options, | ||
| KillProcResponse & | response_ | ||
| ) | const |
Kills a running proc instance.
- Parameters
-
[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. - kill_proc_run_tag: If runId is specified, kill the proc instance that has a matching run ID and a matching run tag that was provided to executeProc. If runId is not specified, kill the proc instance(s) where a matching run tag was provided to executeProc. The default value is ''.
- kill_proc_clear_execute_at_startup: If true, kill and remove the instance of the proc matching the auto-start run ID that was created to run when the database is started. The auto-start run ID was returned from executeProc and can be retrieved using showProc. Supported values: The default value is kill_proc_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ lockTable() [1/4]
| LockTableResponse lockTable | ( | const LockTableRequest & | request_ | ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ lockTable() [2/4]
| LockTableResponse& lockTable | ( | const LockTableRequest & | request_, |
| LockTableResponse & | response_ | ||
| ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ lockTable() [3/4]
| LockTableResponse lockTable | ( | const std::string & | tableName, |
| const std::string & | lockType, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
- Parameters
-
[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: - lock_table_status: Show locked status
- lock_table_no_access: Allow no read/write operations
- lock_table_read_only: Allow only read operations
- lock_table_write_only: Allow only write operations
- lock_table_read_write: Allow all read/write operations
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ lockTable() [4/4]
| LockTableResponse& lockTable | ( | const std::string & | tableName, |
| const std::string & | lockType, | ||
| const std::map< std::string, std::string > & | options, | ||
| LockTableResponse & | response_ | ||
| ) | const |
Manages global access to a table's data.
By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
- Parameters
-
[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: - lock_table_status: Show locked status
- lock_table_no_access: Allow no read/write operations
- lock_table_read_only: Allow only read operations
- lock_table_write_only: Allow only write operations
- lock_table_read_write: Allow all read/write operations
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ matchGraph() [1/4]
| MatchGraphResponse matchGraph | ( | const MatchGraphRequest & | request_ | ) | const |
Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ matchGraph() [2/4]
| MatchGraphResponse& matchGraph | ( | const MatchGraphRequest & | request_, |
| MatchGraphResponse & | response_ | ||
| ) | const |
Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ matchGraph() [3/4]
| MatchGraphResponse matchGraph | ( | const std::string & | graphName, |
| const std::vector< std::string > & | samplePoints, | ||
| const std::string & | solveMethod, | ||
| const std::string & | solutionTable, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
- Parameters
-
[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: - match_graph_markov_chain: Matches samplePoints to the graph using the Hidden Markov Model (HMM)-based method, which conducts a range-tree closest-edge search to find the best combinations of possible road segments (num_segments) for each sample point to create the best route. The route is secured one point at a time while looking ahead chain_width number of points, so the prediction is corrected after each point. This solution type is the most accurate but also the most computationally intensive. Related options: num_segments and chain_width.
- match_graph_match_od_pairs: Matches samplePoints to find the most probable path between origin and destination pairs with cost constraints.
- match_graph_match_supply_demand: Matches samplePoints to optimize scheduling multiple supplies (trucks) with varying sizes to varying demand sites with varying capacities per depot. Related options: partial_loading and max_combinations.
- match_graph_match_batch_solves: Matches samplePoints source and destination pairs for the shortest path solves in batch mode.
- match_graph_match_loops: Matches closed loops (Eulerian paths) originating and ending at each graph node within min and max hops (levels).
- match_graph_match_charging_stations: Matches an optimal path across a number of ev-charging stations between source and target locations.
- match_graph_match_similarity: Matches the intersection set(s) by computing the Jaccard similarity score between node pairs.
- match_graph_match_pickup_dropoff: Matches the pickups and dropoffs by optimizing the total trip costs
- match_graph_match_clusters: Matches the graph nodes with a cluster index using Louvain clustering algorithm
- match_graph_match_pattern: Matches a pattern in the graph
- match_graph_match_embedding: Creates vector node embeddings
- match_graph_match_isochrone: Solves for isochrones for a set of input sources
[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. - match_graph_gps_noise: GPS noise value (in meters) to remove redundant sample points. Use -1 to disable noise reduction. The default value accounts for 95% of point variation (+ or -5 meters). The default value is '5.0'.
- match_graph_num_segments: Maximum number of potentially matching road segments for each sample point. For the markov_chain solver, the default is 3. The default value is '3'.
- match_graph_search_radius: Maximum search radius used when snapping sample points onto potentially matching surrounding segments. The default value corresponds to approximately 100 meters. The default value is '0.001'.
- match_graph_chain_width: For the markov_chain solver only. Length of the sample points lookahead window within the Markov kernel; the larger the number, the more accurate the solution. The default value is '9'.
- match_graph_source: Optional WKT starting point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.
- match_graph_destination: Optional WKT ending point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.
-
match_graph_partial_loading: For the match_supply_demand solver only. When false (non-default), trucks do not off-load at the demand (store) side if the remainder is less than the store's need. Supported values:
- match_graph_true: Partial off-loading at multiple store (demand) locations
- match_graph_false: No partial off-loading allowed if supply is less than the store's demand.
- match_graph_max_combinations: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the demand locations - can increase this up to 2M. The default value is '10000'.
- match_graph_max_supply_combinations: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the supply locations if/when 'permute_supplies' is true. The default value is '10000'.
- match_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_aggregated_output: For the match_supply_demand solver only. When it is true (default), each record in the output table shows a particular truck's scheduled cumulative round trip path (MULTILINESTRING) and the corresponding aggregated cost. Otherwise, each record shows a single scheduled truck route (LINESTRING) towards a particular demand location (store id) with its corresponding cost. The default value is 'true'.
- match_graph_output_tracks: For the match_supply_demand solver only. When it is true (non-default), the output will be in tracks format for all the round trips of each truck in which the timestamps are populated directly from the edge weights starting from their originating depots. The default value is 'false'.
- match_graph_max_trip_cost: For the match_supply_demand and match_pickup_dropoff solvers only. If this constraint is greater than zero (default) then the trucks/rides will skip travelling from one demand/pick location to another if the cost between them is greater than this number (distance or time). Zero (default) value means no check is performed. The default value is '0.0'.
-
match_graph_filter_folding_paths: For the markov_chain solver only. When true (non-default), the paths per sequence combination is checked for folding over patterns and can significantly increase the execution time depending on the chain width and the number of gps samples. Supported values:
- match_graph_true: Filter out the folded paths.
- match_graph_false: Do not filter out the folded paths
- match_graph_unit_unloading_cost: For the match_supply_demand solver only. The unit cost per load amount to be delivered. If this value is greater than zero (default) then the additional cost of this unit load multiplied by the total dropped load will be added over to the trip cost to the demand location. The default value is '0.0'.
- match_graph_max_num_threads: For the markov_chain solver only. If specified (greater than zero), the maximum number of threads will not be greater than the specified value. It can be lower due to the memory and the number cores available. Default value of zero allows the algorithm to set the maximal number of threads within these constraints. The default value is '0'.
- match_graph_service_limit: For the match_supply_demand solver only. If specified (greater than zero), any supply actor's total service cost (distance or time) will be limited by the specified value including multiple rounds (if set). The default value is '0.0'.
-
match_graph_enable_reuse: For the match_supply_demand solver only. If specified (true), all supply actors can be scheduled for second rounds from their originating depots. Supported values:
- match_graph_true: Allows reusing supply actors (trucks, e.g.) for scheduling again.
- match_graph_false: Supply actors are scheduled only once from their depots.
- match_graph_max_stops: For the match_supply_demand solver only. If specified (greater than zero), a supply actor (truck) can at most have this many stops (demand locations) in one round trip. Otherwise, it is unlimited. If 'enable_truck_reuse' is on, this condition will be applied separately at each round trip use of the same truck. The default value is '0'.
- match_graph_service_radius: For the match_supply_demand and match_pickup_dropoff solvers only. If specified (greater than zero), it filters the demands/picks outside this radius centered around the supply actor/ride's originating location (distance or time). The default value is '0.0'.
-
match_graph_permute_supplies: For the match_supply_demand solver only. If specified (true), supply side actors are permuted for the demand combinations during msdo optimization - note that this option increases optimization time significantly - use of 'max_combinations' option is recommended to prevent prohibitively long runs. Supported values:
- match_graph_true: Generates sequences over supply side permutations if total supply is less than twice the total demand
- match_graph_false: Permutations are not performed, rather a specific order of supplies based on capacity is computed
-
match_graph_batch_tsm_mode: For the match_supply_demand solver only. When enabled, it sets the number of visits on each demand location by a single salesman at each trip is considered to be (one) 1, otherwise there is no bound. Supported values:
- match_graph_true: Sets only one visit per demand location by a salesman (tsm mode)
- match_graph_false: No preset limit (usual msdo mode)
-
match_graph_round_trip: For the match_supply_demand solver only. When enabled, the supply will have to return back to the origination location. Supported values:
- match_graph_true: The optimization is done for trips in round trip manner always returning to originating locations
- match_graph_false: Supplies do not have to come back to their originating locations in their routes. The routes are considered finished at the final dropoff.
- match_graph_num_cycles: For the match_clusters solver only. Terminates the cluster exchange iterations across 2-step-cycles (outer loop) when quality does not improve during iterations. The default value is '10'.
- match_graph_num_loops_per_cycle: For the match_clusters and match_embedding solvers only. Terminates the cluster exchanges within the first step iterations of a cycle (inner loop) unless convergence is reached. The default value is '10'.
- match_graph_num_output_clusters: For the match_clusters solver only. Limits the output to the top 'num_output_clusters' clusters based on density. Default value of zero outputs all clusters. The default value is '0'.
- match_graph_max_num_clusters: For the match_clusters and match_embedding solvers only. If set (value greater than zero), it terminates when the number of clusters goes below than this number. For embedding solver the default is 8. The default value is '0'.
-
match_graph_cluster_quality_metric: For the match_clusters solver only. The quality metric for Louvain modularity optimization solver. Supported values:
- match_graph_girvan: Uses the Newman Girvan quality metric for cluster solver
- match_graph_spectral: Applies recursive spectral bisection (RSB) partitioning solver
-
match_graph_restricted_type: For the match_supply_demand solver only. Optimization is performed by restricting routes labeled by 'MSDO_ODDEVEN_RESTRICTED' only for this supply actor (truck) type. Supported values:
- match_graph_odd: Applies odd/even rule restrictions to odd tagged vehicles.
- match_graph_even: Applies odd/even rule restrictions to even tagged vehicles.
- match_graph_none: Does not apply odd/even rule restrictions to any vehicles.
- match_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. The default value is ''.
-
match_graph_inverse_solve: For the match_batch_solves solver only. Solves source-destination pairs using inverse shortest path solver. Supported values:
- match_graph_true: Solves using inverse shortest path solver.
- match_graph_false: Solves using direct shortest path solver.
- match_graph_min_loop_level: For the match_loops solver only. Finds closed loops around each node deducible not less than this minimal hop (level) deep. The default value is '0'.
- match_graph_max_loop_level: For the match_loops solver only. Finds closed loops around each node deducible not more than this maximal hop (level) deep. The default value is '5'.
- match_graph_search_limit: For the match_loops solver only. Searches within this limit of nodes per vertex to detect loops. The value zero means there is no limit. The default value is '10000'.
- match_graph_output_batch_size: For the match_loops solver only. Uses this value as the batch size of the number of loops in flushing(inserting) to the output table. The default value is '1000'.
- match_graph_charging_capacity: For the match_charging_stations solver only. This is the maximum ev-charging capacity of a vehicle (distance in meters or time in seconds depending on the unit of the graph weights). The default value is '300000.0'.
- match_graph_charging_candidates: For the match_charging_stations solver only. Solver searches for this many number of stations closest around each base charging location found by capacity. The default value is '10'.
- match_graph_charging_penalty: For the match_charging_stations solver only. This is the penalty for full charging. The default value is '30000.0'.
- match_graph_max_hops: For the match_similarity and match_embedding solvers only. Searches within this maximum hops for source and target node pairs to compute the Jaccard scores. The default value is '3'.
- match_graph_traversal_node_limit: For the match_similarity solver only. Limits the traversal depth if it reaches this many number of nodes. The default value is '1000'.
- match_graph_paired_similarity: For the match_similarity solver only. If true, it computes Jaccard score between each pair, otherwise it will compute Jaccard from the intersection set between the source and target nodes. Supported values: The default value is match_graph_true.
- match_graph_force_undirected: For the match_pattern and match_embedding solvers only. Pattern matching will be using both pattern and graph as undirected if set to true. Supported values: The default value is match_graph_false.
- match_graph_max_vector_dimension: For the match_embedding solver only. Limits the number of dimensions in node vector embeddings. The default value is '1000'.
- match_graph_optimize_embedding_weights: For the match_embedding solvers only. Solves to find the optimal weights per sub feature in vector emdeddings. Supported values: The default value is match_graph_false.
- match_graph_embedding_weights: For the match_embedding solver only. User specified weights per sub feature in vector embeddings. The string contains the comma separated float values for each sub-feature in the vector space. These values will ONLY be used if 'optimize_embedding_weights' is false. The default value is '1.0,1.0,1.0,1.0'.
- match_graph_optimization_sampling_size: For the match_embedding solver only. Sets the number of random nodes from the graph for solving the weights using stochastic gradient descent. The default value is '1000'.
- match_graph_optimization_max_iterations: For the match_embedding solver only. When the iterations (epochs) for the convergence of the stochastic gradient descent algorithm reaches this number it bails out unless relative error between consecutive iterations is below the 'optimization_error_tolerance' option. The default value is '1000'.
- match_graph_optimization_error_tolerance: For the match_embedding solver only. When the relative error between all of the weights' consecutive iterations falls below this threshold the optimization cycle is interrupted unless the number of iterations reaches the limit set by the option 'max_optimization_iterations'. The default value is '0.001'.
- match_graph_optimization_iteration_rate: For the match_embedding solver only. It is otherwise known as the learning rate, which is the proportionality constant in fornt of the gradient term in successive iterations. The default value is '0.3'.
- match_graph_max_radius: For the match_isochrone solver only. Sets the maximal reachability limmit for computing isochrones. Zero means no limit. The default value is '0.0'.
- Returns
- Response object containing the result of the operation.
◆ matchGraph() [4/4]
| MatchGraphResponse& matchGraph | ( | const std::string & | graphName, |
| const std::vector< std::string > & | samplePoints, | ||
| const std::string & | solveMethod, | ||
| const std::string & | solutionTable, | ||
| const std::map< std::string, std::string > & | options, | ||
| MatchGraphResponse & | response_ | ||
| ) | const |
Matches a directed route implied by a given set of latitude/longitude points to an existing underlying road network graph using a given solution type.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /match/graph examples before using this endpoint.
- Parameters
-
[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: - match_graph_markov_chain: Matches samplePoints to the graph using the Hidden Markov Model (HMM)-based method, which conducts a range-tree closest-edge search to find the best combinations of possible road segments (num_segments) for each sample point to create the best route. The route is secured one point at a time while looking ahead chain_width number of points, so the prediction is corrected after each point. This solution type is the most accurate but also the most computationally intensive. Related options: num_segments and chain_width.
- match_graph_match_od_pairs: Matches samplePoints to find the most probable path between origin and destination pairs with cost constraints.
- match_graph_match_supply_demand: Matches samplePoints to optimize scheduling multiple supplies (trucks) with varying sizes to varying demand sites with varying capacities per depot. Related options: partial_loading and max_combinations.
- match_graph_match_batch_solves: Matches samplePoints source and destination pairs for the shortest path solves in batch mode.
- match_graph_match_loops: Matches closed loops (Eulerian paths) originating and ending at each graph node within min and max hops (levels).
- match_graph_match_charging_stations: Matches an optimal path across a number of ev-charging stations between source and target locations.
- match_graph_match_similarity: Matches the intersection set(s) by computing the Jaccard similarity score between node pairs.
- match_graph_match_pickup_dropoff: Matches the pickups and dropoffs by optimizing the total trip costs
- match_graph_match_clusters: Matches the graph nodes with a cluster index using Louvain clustering algorithm
- match_graph_match_pattern: Matches a pattern in the graph
- match_graph_match_embedding: Creates vector node embeddings
- match_graph_match_isochrone: Solves for isochrones for a set of input sources
[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. - match_graph_gps_noise: GPS noise value (in meters) to remove redundant sample points. Use -1 to disable noise reduction. The default value accounts for 95% of point variation (+ or -5 meters). The default value is '5.0'.
- match_graph_num_segments: Maximum number of potentially matching road segments for each sample point. For the markov_chain solver, the default is 3. The default value is '3'.
- match_graph_search_radius: Maximum search radius used when snapping sample points onto potentially matching surrounding segments. The default value corresponds to approximately 100 meters. The default value is '0.001'.
- match_graph_chain_width: For the markov_chain solver only. Length of the sample points lookahead window within the Markov kernel; the larger the number, the more accurate the solution. The default value is '9'.
- match_graph_source: Optional WKT starting point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the starting point. The default value is 'POINT NULL'.
- match_graph_destination: Optional WKT ending point from samplePoints for the solver. The default behavior for the endpoint is to use time to determine the destination point. The default value is 'POINT NULL'.
-
match_graph_partial_loading: For the match_supply_demand solver only. When false (non-default), trucks do not off-load at the demand (store) side if the remainder is less than the store's need. Supported values:
- match_graph_true: Partial off-loading at multiple store (demand) locations
- match_graph_false: No partial off-loading allowed if supply is less than the store's demand.
- match_graph_max_combinations: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the demand locations - can increase this up to 2M. The default value is '10000'.
- match_graph_max_supply_combinations: For the match_supply_demand solver only. This is the cutoff for the number of generated combinations for sequencing the supply locations if/when 'permute_supplies' is true. The default value is '10000'.
- match_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- match_graph_aggregated_output: For the match_supply_demand solver only. When it is true (default), each record in the output table shows a particular truck's scheduled cumulative round trip path (MULTILINESTRING) and the corresponding aggregated cost. Otherwise, each record shows a single scheduled truck route (LINESTRING) towards a particular demand location (store id) with its corresponding cost. The default value is 'true'.
- match_graph_output_tracks: For the match_supply_demand solver only. When it is true (non-default), the output will be in tracks format for all the round trips of each truck in which the timestamps are populated directly from the edge weights starting from their originating depots. The default value is 'false'.
- match_graph_max_trip_cost: For the match_supply_demand and match_pickup_dropoff solvers only. If this constraint is greater than zero (default) then the trucks/rides will skip travelling from one demand/pick location to another if the cost between them is greater than this number (distance or time). Zero (default) value means no check is performed. The default value is '0.0'.
-
match_graph_filter_folding_paths: For the markov_chain solver only. When true (non-default), the paths per sequence combination is checked for folding over patterns and can significantly increase the execution time depending on the chain width and the number of gps samples. Supported values:
- match_graph_true: Filter out the folded paths.
- match_graph_false: Do not filter out the folded paths
- match_graph_unit_unloading_cost: For the match_supply_demand solver only. The unit cost per load amount to be delivered. If this value is greater than zero (default) then the additional cost of this unit load multiplied by the total dropped load will be added over to the trip cost to the demand location. The default value is '0.0'.
- match_graph_max_num_threads: For the markov_chain solver only. If specified (greater than zero), the maximum number of threads will not be greater than the specified value. It can be lower due to the memory and the number cores available. Default value of zero allows the algorithm to set the maximal number of threads within these constraints. The default value is '0'.
- match_graph_service_limit: For the match_supply_demand solver only. If specified (greater than zero), any supply actor's total service cost (distance or time) will be limited by the specified value including multiple rounds (if set). The default value is '0.0'.
-
match_graph_enable_reuse: For the match_supply_demand solver only. If specified (true), all supply actors can be scheduled for second rounds from their originating depots. Supported values:
- match_graph_true: Allows reusing supply actors (trucks, e.g.) for scheduling again.
- match_graph_false: Supply actors are scheduled only once from their depots.
- match_graph_max_stops: For the match_supply_demand solver only. If specified (greater than zero), a supply actor (truck) can at most have this many stops (demand locations) in one round trip. Otherwise, it is unlimited. If 'enable_truck_reuse' is on, this condition will be applied separately at each round trip use of the same truck. The default value is '0'.
- match_graph_service_radius: For the match_supply_demand and match_pickup_dropoff solvers only. If specified (greater than zero), it filters the demands/picks outside this radius centered around the supply actor/ride's originating location (distance or time). The default value is '0.0'.
-
match_graph_permute_supplies: For the match_supply_demand solver only. If specified (true), supply side actors are permuted for the demand combinations during msdo optimization - note that this option increases optimization time significantly - use of 'max_combinations' option is recommended to prevent prohibitively long runs. Supported values:
- match_graph_true: Generates sequences over supply side permutations if total supply is less than twice the total demand
- match_graph_false: Permutations are not performed, rather a specific order of supplies based on capacity is computed
-
match_graph_batch_tsm_mode: For the match_supply_demand solver only. When enabled, it sets the number of visits on each demand location by a single salesman at each trip is considered to be (one) 1, otherwise there is no bound. Supported values:
- match_graph_true: Sets only one visit per demand location by a salesman (tsm mode)
- match_graph_false: No preset limit (usual msdo mode)
-
match_graph_round_trip: For the match_supply_demand solver only. When enabled, the supply will have to return back to the origination location. Supported values:
- match_graph_true: The optimization is done for trips in round trip manner always returning to originating locations
- match_graph_false: Supplies do not have to come back to their originating locations in their routes. The routes are considered finished at the final dropoff.
- match_graph_num_cycles: For the match_clusters solver only. Terminates the cluster exchange iterations across 2-step-cycles (outer loop) when quality does not improve during iterations. The default value is '10'.
- match_graph_num_loops_per_cycle: For the match_clusters and match_embedding solvers only. Terminates the cluster exchanges within the first step iterations of a cycle (inner loop) unless convergence is reached. The default value is '10'.
- match_graph_num_output_clusters: For the match_clusters solver only. Limits the output to the top 'num_output_clusters' clusters based on density. Default value of zero outputs all clusters. The default value is '0'.
- match_graph_max_num_clusters: For the match_clusters and match_embedding solvers only. If set (value greater than zero), it terminates when the number of clusters goes below than this number. For embedding solver the default is 8. The default value is '0'.
-
match_graph_cluster_quality_metric: For the match_clusters solver only. The quality metric for Louvain modularity optimization solver. Supported values:
- match_graph_girvan: Uses the Newman Girvan quality metric for cluster solver
- match_graph_spectral: Applies recursive spectral bisection (RSB) partitioning solver
-
match_graph_restricted_type: For the match_supply_demand solver only. Optimization is performed by restricting routes labeled by 'MSDO_ODDEVEN_RESTRICTED' only for this supply actor (truck) type. Supported values:
- match_graph_odd: Applies odd/even rule restrictions to odd tagged vehicles.
- match_graph_even: Applies odd/even rule restrictions to even tagged vehicles.
- match_graph_none: Does not apply odd/even rule restrictions to any vehicles.
- match_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. The default value is ''.
-
match_graph_inverse_solve: For the match_batch_solves solver only. Solves source-destination pairs using inverse shortest path solver. Supported values:
- match_graph_true: Solves using inverse shortest path solver.
- match_graph_false: Solves using direct shortest path solver.
- match_graph_min_loop_level: For the match_loops solver only. Finds closed loops around each node deducible not less than this minimal hop (level) deep. The default value is '0'.
- match_graph_max_loop_level: For the match_loops solver only. Finds closed loops around each node deducible not more than this maximal hop (level) deep. The default value is '5'.
- match_graph_search_limit: For the match_loops solver only. Searches within this limit of nodes per vertex to detect loops. The value zero means there is no limit. The default value is '10000'.
- match_graph_output_batch_size: For the match_loops solver only. Uses this value as the batch size of the number of loops in flushing(inserting) to the output table. The default value is '1000'.
- match_graph_charging_capacity: For the match_charging_stations solver only. This is the maximum ev-charging capacity of a vehicle (distance in meters or time in seconds depending on the unit of the graph weights). The default value is '300000.0'.
- match_graph_charging_candidates: For the match_charging_stations solver only. Solver searches for this many number of stations closest around each base charging location found by capacity. The default value is '10'.
- match_graph_charging_penalty: For the match_charging_stations solver only. This is the penalty for full charging. The default value is '30000.0'.
- match_graph_max_hops: For the match_similarity and match_embedding solvers only. Searches within this maximum hops for source and target node pairs to compute the Jaccard scores. The default value is '3'.
- match_graph_traversal_node_limit: For the match_similarity solver only. Limits the traversal depth if it reaches this many number of nodes. The default value is '1000'.
- match_graph_paired_similarity: For the match_similarity solver only. If true, it computes Jaccard score between each pair, otherwise it will compute Jaccard from the intersection set between the source and target nodes. Supported values: The default value is match_graph_true.
- match_graph_force_undirected: For the match_pattern and match_embedding solvers only. Pattern matching will be using both pattern and graph as undirected if set to true. Supported values: The default value is match_graph_false.
- match_graph_max_vector_dimension: For the match_embedding solver only. Limits the number of dimensions in node vector embeddings. The default value is '1000'.
- match_graph_optimize_embedding_weights: For the match_embedding solvers only. Solves to find the optimal weights per sub feature in vector emdeddings. Supported values: The default value is match_graph_false.
- match_graph_embedding_weights: For the match_embedding solver only. User specified weights per sub feature in vector embeddings. The string contains the comma separated float values for each sub-feature in the vector space. These values will ONLY be used if 'optimize_embedding_weights' is false. The default value is '1.0,1.0,1.0,1.0'.
- match_graph_optimization_sampling_size: For the match_embedding solver only. Sets the number of random nodes from the graph for solving the weights using stochastic gradient descent. The default value is '1000'.
- match_graph_optimization_max_iterations: For the match_embedding solver only. When the iterations (epochs) for the convergence of the stochastic gradient descent algorithm reaches this number it bails out unless relative error between consecutive iterations is below the 'optimization_error_tolerance' option. The default value is '1000'.
- match_graph_optimization_error_tolerance: For the match_embedding solver only. When the relative error between all of the weights' consecutive iterations falls below this threshold the optimization cycle is interrupted unless the number of iterations reaches the limit set by the option 'max_optimization_iterations'. The default value is '0.001'.
- match_graph_optimization_iteration_rate: For the match_embedding solver only. It is otherwise known as the learning rate, which is the proportionality constant in fornt of the gradient term in successive iterations. The default value is '0.3'.
- match_graph_max_radius: For the match_isochrone solver only. Sets the maximal reachability limmit for computing isochrones. Zero means no limit. The default value is '0.0'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ mergeRecords() [1/4]
| MergeRecordsResponse mergeRecords | ( | const MergeRecordsRequest & | request_ | ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ mergeRecords() [2/4]
| MergeRecordsResponse& mergeRecords | ( | const MergeRecordsRequest & | request_, |
| MergeRecordsResponse & | response_ | ||
| ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ mergeRecords() [3/4]
| MergeRecordsResponse mergeRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | sourceTableNames, | ||
| const std::vector< std::map< std::string, std::string > > & | fieldMaps, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
- Parameters
-
[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. - merge_records_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If persist is false, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is merge_records_false.
- merge_records_collection_name: [DEPRECATED–please specify the containing schema for the merged table as part of tableName and use createSchema to create the schema if non-existent] Name of a schema for the newly created merged table specified by tableName.
- merge_records_is_replicated: Indicates the distribution scheme for the data of the merged table specified in tableName. If true, the table will be replicated. If false, the table will be randomly sharded. Supported values: The default value is merge_records_false.
- merge_records_ttl: Sets the TTL of the merged table specified in tableName.
- merge_records_persist: If true, then the table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is merge_records_true.
- merge_records_chunk_size: Indicates the number of records per chunk to be used for the merged table specified in tableName.
- merge_records_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the merged table specified in tableName.
- merge_records_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the merged table specified in tableName.
- merge_records_view_id: view this result table is part of. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ mergeRecords() [4/4]
| MergeRecordsResponse& mergeRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | sourceTableNames, | ||
| const std::vector< std::map< std::string, std::string > > & | fieldMaps, | ||
| const std::map< std::string, std::string > & | options, | ||
| MergeRecordsResponse & | response_ | ||
| ) | const |
Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
- Parameters
-
[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. - merge_records_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of tableName. If persist is false, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is merge_records_false.
- merge_records_collection_name: [DEPRECATED–please specify the containing schema for the merged table as part of tableName and use createSchema to create the schema if non-existent] Name of a schema for the newly created merged table specified by tableName.
- merge_records_is_replicated: Indicates the distribution scheme for the data of the merged table specified in tableName. If true, the table will be replicated. If false, the table will be randomly sharded. Supported values: The default value is merge_records_false.
- merge_records_ttl: Sets the TTL of the merged table specified in tableName.
- merge_records_persist: If true, then the table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is merge_records_true.
- merge_records_chunk_size: Indicates the number of records per chunk to be used for the merged table specified in tableName.
- merge_records_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for the merged table specified in tableName.
- merge_records_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for the merged table specified in tableName.
- merge_records_view_id: view this result table is part of. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ modifyGraph() [1/4]
| ModifyGraphResponse modifyGraph | ( | const ModifyGraphRequest & | request_ | ) | const |
Update an existing graph network using given nodes, edges, weights, restrictions, and options.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ modifyGraph() [2/4]
| ModifyGraphResponse& modifyGraph | ( | const ModifyGraphRequest & | request_, |
| ModifyGraphResponse & | response_ | ||
| ) | const |
Update an existing graph network using given nodes, edges, weights, restrictions, and options.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ modifyGraph() [3/4]
| ModifyGraphResponse modifyGraph | ( | const std::string & | graphName, |
| const std::vector< std::string > & | nodes, | ||
| const std::vector< std::string > & | edges, | ||
| const std::vector< std::string > & | weights, | ||
| const std::vector< std::string > & | restrictions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Update an existing graph network using given nodes, edges, weights, restrictions, and options.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
- Parameters
-
[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. - modify_graph_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
- modify_graph_export_create_results: If set to true, returns the graph topology in the response as arrays. Supported values: The default value is modify_graph_false.
- modify_graph_enable_graph_draw: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values: The default value is modify_graph_false.
- modify_graph_save_persist: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values: The default value is modify_graph_false.
- modify_graph_add_table_monitor: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see createTableMonitor. Supported values: The default value is modify_graph_false.
- modify_graph_graph_table: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
- modify_graph_remove_label_only: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values: The default value is modify_graph_false.
- modify_graph_add_turns: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values: The default value is modify_graph_false.
- modify_graph_turn_angle: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.
- modify_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: The default value is modify_graph_true.
- modify_graph_label_delimiter: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
- modify_graph_allow_multiple_edges: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values: The default value is modify_graph_true.
- modify_graph_embedding_table: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ modifyGraph() [4/4]
| ModifyGraphResponse& modifyGraph | ( | const std::string & | graphName, |
| const std::vector< std::string > & | nodes, | ||
| const std::vector< std::string > & | edges, | ||
| const std::vector< std::string > & | weights, | ||
| const std::vector< std::string > & | restrictions, | ||
| const std::map< std::string, std::string > & | options, | ||
| ModifyGraphResponse & | response_ | ||
| ) | const |
Update an existing graph network using given nodes, edges, weights, restrictions, and options.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, and Graph REST Tutorial before using this endpoint.
- Parameters
-
[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. - modify_graph_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the graph.
- modify_graph_export_create_results: If set to true, returns the graph topology in the response as arrays. Supported values: The default value is modify_graph_false.
- modify_graph_enable_graph_draw: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values: The default value is modify_graph_false.
- modify_graph_save_persist: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values: The default value is modify_graph_false.
- modify_graph_add_table_monitor: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see createTableMonitor. Supported values: The default value is modify_graph_false.
- modify_graph_graph_table: If specified, the created graph is also created as a table with the given name, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will have the following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
- modify_graph_remove_label_only: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values: The default value is modify_graph_false.
- modify_graph_add_turns: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values: The default value is modify_graph_false.
- modify_graph_turn_angle: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.
- modify_graph_use_rtree: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: The default value is modify_graph_true.
- modify_graph_label_delimiter: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
- modify_graph_allow_multiple_edges: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. Supported values: The default value is modify_graph_true.
- modify_graph_embedding_table: If table exists (should be generated by the match/graph match_embedding solver), the vector embeddings for the newly inserted nodes will be appended into this table. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ queryGraph() [1/4]
| 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.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ queryGraph() [2/4]
| 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.
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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ queryGraph() [3/4]
| 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.
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.
- Parameters
-
[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. - query_graph_force_undirected: If set to true, all inbound edges and outbound edges relative to the node will be returned. If set to false, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graphName is directed and when querying nodes. Consult Directed Graphs for more details. Supported values: The default value is query_graph_false.
- query_graph_limit: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the limit value. The default value is '0'.
- query_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values: The default value is query_graph_false.
- query_graph_and_labels: If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values: The default value is query_graph_false.
- query_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth.
- query_graph_output_charn_length: When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'.
- query_graph_find_common_labels: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values: The default value is query_graph_false.
- Returns
- Response object containing the result of the operation.
◆ queryGraph() [4/4]
| 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.
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.
- Parameters
-
[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. - query_graph_force_undirected: If set to true, all inbound edges and outbound edges relative to the node will be returned. If set to false, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graphName is directed and when querying nodes. Consult Directed Graphs for more details. Supported values: The default value is query_graph_false.
- query_graph_limit: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the limit value. The default value is '0'.
- query_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values: The default value is query_graph_false.
- query_graph_and_labels: If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values: The default value is query_graph_false.
- query_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth.
- query_graph_output_charn_length: When specified (>0 and <=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'.
- query_graph_find_common_labels: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values: The default value is query_graph_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ repartitionGraph() [1/4]
| RepartitionGraphResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ repartitionGraph() [2/4]
| RepartitionGraphResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ repartitionGraph() [3/4]
| RepartitionGraphResponse 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.
- Parameters
-
[in] graphName Name of the graph resource to rebalance. [in] options Optional parameters. - repartition_graph_new_graph_name: If a non-empty value is specified, the original graph will be kept (non-default behaviour) and a new balanced graph will be created under this given name. When the value is empty (default), the generated 'balanced' graph will replace the original 'unbalanced' graph under the same graph name. The default value is ''.
- repartition_graph_source_node: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balaced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ''.
- repartition_graph_sql_request_avro_json: The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ repartitionGraph() [4/4]
| RepartitionGraphResponse& 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.
- Parameters
-
[in] graphName Name of the graph resource to rebalance. [in] options Optional parameters. - repartition_graph_new_graph_name: If a non-empty value is specified, the original graph will be kept (non-default behaviour) and a new balanced graph will be created under this given name. When the value is empty (default), the generated 'balanced' graph will replace the original 'unbalanced' graph under the same graph name. The default value is ''.
- repartition_graph_source_node: The distributed shortest path solve is run from this source node to all the nodes in the graph to create balaced partitions using the iso-distance levels of the solution. The source node is selected by the rebalance algorithm automatically (default case when the value is an empty string). Otherwise, the user specified node is used as the source. The default value is ''.
- repartition_graph_sql_request_avro_json: The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermission() [1/4]
| RevokePermissionResponse revokePermission | ( | const RevokePermissionRequest & | request_ | ) | const |
◆ revokePermission() [2/4]
| RevokePermissionResponse& revokePermission | ( | const RevokePermissionRequest & | request_, |
| RevokePermissionResponse & | response_ | ||
| ) | const |
Revoke user or role the specified permission on the specified object.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermission() [3/4]
| 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.
- Parameters
-
[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: - revoke_permission_context: Context
- revoke_permission_credential: Credential
- revoke_permission_datasink: Data Sink
- revoke_permission_datasource: Data Source
- revoke_permission_directory: KIFS File Directory
- revoke_permission_graph: A Graph object
- revoke_permission_proc: UDF Procedure
- revoke_permission_schema: Schema
- revoke_permission_sql_proc: SQL Procedure
- revoke_permission_system: System-level access
- revoke_permission_table: Database Table
- revoke_permission_table_monitor: Table monitor
[in] permission Permission being revoked. Supported values: - revoke_permission_admin: Full read/write and administrative access on the object.
- revoke_permission_connect: Connect access on the given data source or data sink.
- revoke_permission_create: Ability to create new objects of this type.
- revoke_permission_delete: Delete rows from tables.
- revoke_permission_execute: Ability to Execute the Procedure object.
- revoke_permission_insert: Insert access to tables.
- revoke_permission_read: Ability to read, list and use the object.
- revoke_permission_update: Update access to the table.
- revoke_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
- revoke_permission_write: Access to write, change and delete objects.
[in] options Optional parameters. - revoke_permission_columns: Revoke table security from these columns, comma-separated. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ revokePermission() [4/4]
| 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.
- Parameters
-
[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: - revoke_permission_context: Context
- revoke_permission_credential: Credential
- revoke_permission_datasink: Data Sink
- revoke_permission_datasource: Data Source
- revoke_permission_directory: KIFS File Directory
- revoke_permission_graph: A Graph object
- revoke_permission_proc: UDF Procedure
- revoke_permission_schema: Schema
- revoke_permission_sql_proc: SQL Procedure
- revoke_permission_system: System-level access
- revoke_permission_table: Database Table
- revoke_permission_table_monitor: Table monitor
[in] permission Permission being revoked. Supported values: - revoke_permission_admin: Full read/write and administrative access on the object.
- revoke_permission_connect: Connect access on the given data source or data sink.
- revoke_permission_create: Ability to create new objects of this type.
- revoke_permission_delete: Delete rows from tables.
- revoke_permission_execute: Ability to Execute the Procedure object.
- revoke_permission_insert: Insert access to tables.
- revoke_permission_read: Ability to read, list and use the object.
- revoke_permission_update: Update access to the table.
- revoke_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
- revoke_permission_write: Access to write, change and delete objects.
[in] options Optional parameters. - revoke_permission_columns: Revoke table security from these columns, comma-separated. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionCredential() [1/4]
| RevokePermissionCredentialResponse revokePermissionCredential | ( | const RevokePermissionCredentialRequest & | request_ | ) | const |
Revokes a credential-level permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionCredential() [2/4]
| RevokePermissionCredentialResponse& revokePermissionCredential | ( | const RevokePermissionCredentialRequest & | request_, |
| RevokePermissionCredentialResponse & | response_ | ||
| ) | const |
Revokes a credential-level permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionCredential() [3/4]
| 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.
- Parameters
-
[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: - revoke_permission_credential_credential_admin: Full read/write and administrative access on the credential.
- revoke_permission_credential_credential_read: Ability to read and use the credential.
[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.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionCredential() [4/4]
| 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.
- Parameters
-
[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: - revoke_permission_credential_credential_admin: Full read/write and administrative access on the credential.
- revoke_permission_credential_credential_read: Ability to read and use the credential.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionDatasource() [1/4]
| RevokePermissionDatasourceResponse revokePermissionDatasource | ( | const RevokePermissionDatasourceRequest & | request_ | ) | const |
Revokes a data source permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionDatasource() [2/4]
| RevokePermissionDatasourceResponse& revokePermissionDatasource | ( | const RevokePermissionDatasourceRequest & | request_, |
| RevokePermissionDatasourceResponse & | response_ | ||
| ) | const |
Revokes a data source permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionDatasource() [3/4]
| 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.
- Parameters
-
[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: - revoke_permission_datasource_admin: Admin access on the given data source
- revoke_permission_datasource_connect: Connect access on the given data source
[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.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionDatasource() [4/4]
| 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.
- Parameters
-
[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: - revoke_permission_datasource_admin: Admin access on the given data source
- revoke_permission_datasource_connect: Connect access on the given data source
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionDirectory() [1/4]
| RevokePermissionDirectoryResponse revokePermissionDirectory | ( | const RevokePermissionDirectoryRequest & | request_ | ) | const |
◆ revokePermissionDirectory() [2/4]
| RevokePermissionDirectoryResponse& revokePermissionDirectory | ( | const RevokePermissionDirectoryRequest & | request_, |
| RevokePermissionDirectoryResponse & | response_ | ||
| ) | const |
Revokes a KiFS directory-level permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionDirectory() [3/4]
| 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.
- Parameters
-
[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: - revoke_permission_directory_directory_read: For files in the directory, access to list files, download files, or use files in server side functions
- revoke_permission_directory_directory_write: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read acceess
[in] directoryName Name of the KiFS directory to which the permission revokes access [in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionDirectory() [4/4]
| 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.
- Parameters
-
[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: - revoke_permission_directory_directory_read: For files in the directory, access to list files, download files, or use files in server side functions
- revoke_permission_directory_directory_write: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read acceess
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionProc() [1/4]
| RevokePermissionProcResponse revokePermissionProc | ( | const RevokePermissionProcRequest & | request_ | ) | const |
◆ revokePermissionProc() [2/4]
| RevokePermissionProcResponse& revokePermissionProc | ( | const RevokePermissionProcRequest & | request_, |
| RevokePermissionProcResponse & | response_ | ||
| ) | const |
Revokes a proc-level permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionProc() [3/4]
| RevokePermissionProcResponse revokePermissionProc | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | procName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a proc-level permission from a user or role.
- Parameters
-
[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: - revoke_permission_proc_proc_admin: Admin access to the proc.
- revoke_permission_proc_proc_execute: Execute access to the proc.
[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.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionProc() [4/4]
| RevokePermissionProcResponse& revokePermissionProc | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | procName, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionProcResponse & | response_ | ||
| ) | const |
Revokes a proc-level permission from a user or role.
- Parameters
-
[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: - revoke_permission_proc_proc_admin: Admin access to the proc.
- revoke_permission_proc_proc_execute: Execute access to the proc.
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionSystem() [1/4]
| RevokePermissionSystemResponse revokePermissionSystem | ( | const RevokePermissionSystemRequest & | request_ | ) | const |
◆ revokePermissionSystem() [2/4]
| RevokePermissionSystemResponse& revokePermissionSystem | ( | const RevokePermissionSystemRequest & | request_, |
| RevokePermissionSystemResponse & | response_ | ||
| ) | const |
Revokes a system-level permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionSystem() [3/4]
| RevokePermissionSystemResponse revokePermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a system-level permission from a user or role.
- Parameters
-
[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: - revoke_permission_system_system_admin: Full access to all data and system functions.
- revoke_permission_system_system_user_admin: Access to administer users and roles that do not have system_admin permission.
- revoke_permission_system_system_write: Read and write access to all tables.
- revoke_permission_system_system_read: Read-only access to all tables.
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionSystem() [4/4]
| RevokePermissionSystemResponse& revokePermissionSystem | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionSystemResponse & | response_ | ||
| ) | const |
Revokes a system-level permission from a user or role.
- Parameters
-
[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: - revoke_permission_system_system_admin: Full access to all data and system functions.
- revoke_permission_system_system_user_admin: Access to administer users and roles that do not have system_admin permission.
- revoke_permission_system_system_write: Read and write access to all tables.
- revoke_permission_system_system_read: Read-only access to all tables.
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionTable() [1/4]
| RevokePermissionTableResponse revokePermissionTable | ( | const RevokePermissionTableRequest & | request_ | ) | const |
◆ revokePermissionTable() [2/4]
| RevokePermissionTableResponse& revokePermissionTable | ( | const RevokePermissionTableRequest & | request_, |
| RevokePermissionTableResponse & | response_ | ||
| ) | const |
Revokes a table-level permission from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokePermissionTable() [3/4]
| RevokePermissionTableResponse revokePermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes a table-level permission from a user or role.
- Parameters
-
[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: - revoke_permission_table_table_admin: Full read/write and administrative access to the table.
- revoke_permission_table_table_insert: Insert access to the table.
- revoke_permission_table_table_update: Update access to the table.
- revoke_permission_table_table_delete: Delete access to the table.
- revoke_permission_table_table_read: Read access to the table.
[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. - revoke_permission_table_columns: Apply security to these columns, comma-separated. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ revokePermissionTable() [4/4]
| RevokePermissionTableResponse& revokePermissionTable | ( | const std::string & | name, |
| const std::string & | permission, | ||
| const std::string & | tableName, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokePermissionTableResponse & | response_ | ||
| ) | const |
Revokes a table-level permission from a user or role.
- Parameters
-
[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: - revoke_permission_table_table_admin: Full read/write and administrative access to the table.
- revoke_permission_table_table_insert: Insert access to the table.
- revoke_permission_table_table_update: Update access to the table.
- revoke_permission_table_table_delete: Delete access to the table.
- revoke_permission_table_table_read: Read access to the table.
[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. - revoke_permission_table_columns: Apply security to these columns, comma-separated. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokeRole() [1/4]
| RevokeRoleResponse revokeRole | ( | const RevokeRoleRequest & | request_ | ) | const |
◆ revokeRole() [2/4]
| RevokeRoleResponse& revokeRole | ( | const RevokeRoleRequest & | request_, |
| RevokeRoleResponse & | response_ | ||
| ) | const |
Revokes membership in a role from a user or role.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ revokeRole() [3/4]
| RevokeRoleResponse revokeRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Revokes membership in a role from a user or role.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ revokeRole() [4/4]
| RevokeRoleResponse& revokeRole | ( | const std::string & | role, |
| const std::string & | member, | ||
| const std::map< std::string, std::string > & | options, | ||
| RevokeRoleResponse & | response_ | ||
| ) | const |
Revokes membership in a role from a user or role.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showCredential() [1/4]
| ShowCredentialResponse showCredential | ( | const ShowCredentialRequest & | request_ | ) | const |
Shows information about a specified credential or all credentials.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showCredential() [2/4]
| ShowCredentialResponse& showCredential | ( | const ShowCredentialRequest & | request_, |
| ShowCredentialResponse & | response_ | ||
| ) | const |
Shows information about a specified credential or all credentials.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showCredential() [3/4]
| ShowCredentialResponse showCredential | ( | const std::string & | credentialName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a specified credential or all credentials.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showCredential() [4/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showDatasink() [1/4]
| ShowDatasinkResponse showDatasink | ( | const ShowDatasinkRequest & | request_ | ) | const |
◆ showDatasink() [2/4]
| ShowDatasinkResponse& showDatasink | ( | const ShowDatasinkRequest & | request_, |
| ShowDatasinkResponse & | response_ | ||
| ) | const |
Shows information about a specified data sink or all data sinks.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showDatasink() [3/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showDatasink() [4/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showDatasource() [1/4]
| ShowDatasourceResponse showDatasource | ( | const ShowDatasourceRequest & | request_ | ) | const |
Shows information about a specified data source or all data sources.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showDatasource() [2/4]
| ShowDatasourceResponse& showDatasource | ( | const ShowDatasourceRequest & | request_, |
| ShowDatasourceResponse & | response_ | ||
| ) | const |
Shows information about a specified data source or all data sources.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showDatasource() [3/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showDatasource() [4/4]
| 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showDirectories() [1/4]
| ShowDirectoriesResponse showDirectories | ( | const ShowDirectoriesRequest & | request_ | ) | const |
◆ showDirectories() [2/4]
| ShowDirectoriesResponse& showDirectories | ( | const ShowDirectoriesRequest & | request_, |
| ShowDirectoriesResponse & | response_ | ||
| ) | const |
Shows information about directories in KiFS.
Can be used to show a single directory, or all directories.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showDirectories() [3/4]
| ShowDirectoriesResponse 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showDirectories() [4/4]
| ShowDirectoriesResponse& 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showEnvironment() [1/4]
| ShowEnvironmentResponse showEnvironment | ( | const ShowEnvironmentRequest & | request_ | ) | const |
Shows information about a specified user-defined function (UDF) environment or all environments.
Returns detailed information about existing environments.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showEnvironment() [2/4]
| ShowEnvironmentResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showEnvironment() [3/4]
| 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.
Returns detailed information about existing environments.
- Parameters
-
[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. - show_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values: The default value is show_environment_false.
- Returns
- Response object containing the result of the operation.
◆ showEnvironment() [4/4]
| 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.
Returns detailed information about existing environments.
- Parameters
-
[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. - show_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values: The default value is show_environment_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showFiles() [1/4]
| ShowFilesResponse showFiles | ( | const ShowFilesRequest & | request_ | ) | const |
◆ showFiles() [2/4]
| ShowFilesResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showFiles() [3/4]
| ShowFilesResponse 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showFiles() [4/4]
| 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.
Can be used for individual files, or to show all files in a given directory.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showGraph() [1/4]
| ShowGraphResponse showGraph | ( | const ShowGraphRequest & | request_ | ) | const |
◆ showGraph() [2/4]
| ShowGraphResponse& showGraph | ( | const ShowGraphRequest & | request_, |
| ShowGraphResponse & | response_ | ||
| ) | const |
Shows information and characteristics of graphs that exist on the graph server.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showGraph() [3/4]
| ShowGraphResponse showGraph | ( | const std::string & | graphName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information and characteristics of graphs that exist on the graph server.
- Parameters
-
[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. - show_graph_show_original_request: If set to true, the request that was originally used to create the graph is also returned as JSON. Supported values: The default value is show_graph_true.
- show_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
- Returns
- Response object containing the result of the operation.
◆ showGraph() [4/4]
| ShowGraphResponse& showGraph | ( | const std::string & | graphName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowGraphResponse & | response_ | ||
| ) | const |
Shows information and characteristics of graphs that exist on the graph server.
- Parameters
-
[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. - show_graph_show_original_request: If set to true, the request that was originally used to create the graph is also returned as JSON. Supported values: The default value is show_graph_true.
- show_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showProc() [1/4]
| ShowProcResponse showProc | ( | const ShowProcRequest & | request_ | ) | const |
◆ showProc() [2/4]
| ShowProcResponse& showProc | ( | const ShowProcRequest & | request_, |
| ShowProcResponse & | response_ | ||
| ) | const |
◆ showProc() [3/4]
| ShowProcResponse showProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about a proc.
- Parameters
-
[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. - show_proc_include_files: If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Supported values: The default value is show_proc_false.
- Returns
- Response object containing the result of the operation.
◆ showProc() [4/4]
| ShowProcResponse& showProc | ( | const std::string & | procName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowProcResponse & | response_ | ||
| ) | const |
Shows information about a proc.
- Parameters
-
[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. - show_proc_include_files: If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Supported values: The default value is show_proc_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showProcStatus() [1/4]
| ShowProcStatusResponse 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).
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showProcStatus() [2/4]
| ShowProcStatusResponse& showProcStatus | ( | const ShowProcStatusRequest & | request_, |
| ShowProcStatusResponse & | response_ | ||
| ) | const |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from executeProc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showProcStatus() [3/4]
| ShowProcStatusResponse 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).
- Parameters
-
[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. - show_proc_status_clear_complete: If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values: The default value is show_proc_status_false.
- show_proc_status_run_tag: If runId is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to executeProc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to executeProc. The default value is ''.
- Returns
- Response object containing the result of the operation.
◆ showProcStatus() [4/4]
| ShowProcStatusResponse& showProcStatus | ( | const std::string & | runId, |
| const std::map< std::string, std::string > & | options, | ||
| ShowProcStatusResponse & | response_ | ||
| ) | const |
Shows the statuses of running or completed proc instances.
Results are grouped by run ID (as returned from executeProc) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
- Parameters
-
[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. - show_proc_status_clear_complete: If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values: The default value is show_proc_status_false.
- show_proc_status_run_tag: If runId is specified, return the status for a proc instance that has a matching run ID and a matching run tag that was provided to executeProc. If runId is not specified, return statuses for all proc instances where a matching run tag was provided to executeProc. The default value is ''.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showResourceGroups() [1/4]
| ShowResourceGroupsResponse showResourceGroups | ( | const ShowResourceGroupsRequest & | request_ | ) | const |
◆ showResourceGroups() [2/4]
| ShowResourceGroupsResponse& showResourceGroups | ( | const ShowResourceGroupsRequest & | request_, |
| ShowResourceGroupsResponse & | response_ | ||
| ) | const |
Requests resource group properties.
Returns detailed information about the requested resource groups.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showResourceGroups() [3/4]
| ShowResourceGroupsResponse showResourceGroups | ( | const std::vector< std::string > & | names, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Requests resource group properties.
Returns detailed information about the requested resource groups.
- Parameters
-
[in] names List of names of groups to be shown. A single entry with an empty string returns all groups. [in] options Optional parameters. - show_resource_groups_show_default_values: If true include values of fields that are based on the default resource group. Supported values: The default value is show_resource_groups_true.
- show_resource_groups_show_default_group: If true include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values: The default value is show_resource_groups_true.
- show_resource_groups_show_tier_usage: If true include the resource group usage on the worker ranks in the response. Supported values: The default value is show_resource_groups_false.
- Returns
- Response object containing the result of the operation.
◆ showResourceGroups() [4/4]
| ShowResourceGroupsResponse& showResourceGroups | ( | const std::vector< std::string > & | names, |
| const std::map< std::string, std::string > & | options, | ||
| ShowResourceGroupsResponse & | response_ | ||
| ) | const |
Requests resource group properties.
Returns detailed information about the requested resource groups.
- Parameters
-
[in] names List of names of groups to be shown. A single entry with an empty string returns all groups. [in] options Optional parameters. - show_resource_groups_show_default_values: If true include values of fields that are based on the default resource group. Supported values: The default value is show_resource_groups_true.
- show_resource_groups_show_default_group: If true include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise. Supported values: The default value is show_resource_groups_true.
- show_resource_groups_show_tier_usage: If true include the resource group usage on the worker ranks in the response. Supported values: The default value is show_resource_groups_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showResourceObjects() [1/4]
| ShowResourceObjectsResponse 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showResourceObjects() [2/4]
| ShowResourceObjectsResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showResourceObjects() [3/4]
| 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.
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.
- Parameters
-
[in] options Optional parameters. - show_resource_objects_tiers: Comma-separated list of tiers to query, leave blank for all tiers.
- show_resource_objects_expression: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
- show_resource_objects_order_by: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
- show_resource_objects_limit: An integer indicating the maximum number of results to be returned, per rank, or (-1) 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. The default value is '100'.
- show_resource_objects_table_names: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.
- Returns
- Response object containing the result of the operation.
◆ showResourceObjects() [4/4]
| 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.
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.
- Parameters
-
[in] options Optional parameters. - show_resource_objects_tiers: Comma-separated list of tiers to query, leave blank for all tiers.
- show_resource_objects_expression: An expression to filter the returned objects. Expression is limited to the following operators: =,!=,<,<=,>,>=,+,-,*,AND,OR,LIKE. For details see Expressions. To use a more complex expression, query the ki_catalog.ki_tiered_objects table directly.
- show_resource_objects_order_by: Single column to be sorted by as well as the sort direction, e.g., 'size asc'. Supported values:
- show_resource_objects_limit: An integer indicating the maximum number of results to be returned, per rank, or (-1) 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. The default value is '100'.
- show_resource_objects_table_names: Comma-separated list of tables to restrict the results to. Use '*' to show all tables.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showResourceStatistics() [1/4]
| ShowResourceStatisticsResponse showResourceStatistics | ( | const ShowResourceStatisticsRequest & | request_ | ) | const |
◆ showResourceStatistics() [2/4]
| ShowResourceStatisticsResponse& showResourceStatistics | ( | const ShowResourceStatisticsRequest & | request_, |
| ShowResourceStatisticsResponse & | response_ | ||
| ) | const |
Requests various statistics for storage/memory tiers and resource groups.
Returns statistics on a per-rank basis.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showResourceStatistics() [3/4]
| ShowResourceStatisticsResponse showResourceStatistics | ( | const std::map< std::string, std::string > & | options | ) | const |
Requests various statistics for storage/memory tiers and resource groups.
Returns statistics on a per-rank basis.
- Parameters
-
[in] options Optional parameters. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ showResourceStatistics() [4/4]
| ShowResourceStatisticsResponse& showResourceStatistics | ( | const std::map< std::string, std::string > & | options, |
| ShowResourceStatisticsResponse & | response_ | ||
| ) | const |
Requests various statistics for storage/memory tiers and resource groups.
Returns statistics on a per-rank basis.
- Parameters
-
[in] options Optional parameters. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSchema() [1/4]
| ShowSchemaResponse showSchema | ( | const ShowSchemaRequest & | request_ | ) | const |
Retrieves information about a schema (or all schemas), as specified in schemaName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showSchema() [2/4]
| ShowSchemaResponse& showSchema | ( | const ShowSchemaRequest & | request_, |
| ShowSchemaResponse & | response_ | ||
| ) | const |
Retrieves information about a schema (or all schemas), as specified in schemaName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSchema() [3/4]
| 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.
- Parameters
-
[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. - show_schema_no_error_if_not_exists: If false will return an error if the provided schemaName does not exist. If true then it will return an empty result if the provided schemaName does not exist. Supported values: The default value is show_schema_false.
- Returns
- Response object containing the result of the operation.
◆ showSchema() [4/4]
| 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.
- Parameters
-
[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. - show_schema_no_error_if_not_exists: If false will return an error if the provided schemaName does not exist. If true then it will return an empty result if the provided schemaName does not exist. Supported values: The default value is show_schema_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSecurity() [1/4]
| ShowSecurityResponse showSecurity | ( | const ShowSecurityRequest & | request_ | ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showSecurity() [2/4]
| ShowSecurityResponse& showSecurity | ( | const ShowSecurityRequest & | request_, |
| ShowSecurityResponse & | response_ | ||
| ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSecurity() [3/4]
| ShowSecurityResponse showSecurity | ( | const std::vector< std::string > & | names, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
- Parameters
-
[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. - show_security_show_current_user: If true, returns only security information for the current user. Supported values: The default value is show_security_false.
- Returns
- Response object containing the result of the operation.
◆ showSecurity() [4/4]
| ShowSecurityResponse& showSecurity | ( | const std::vector< std::string > & | names, |
| const std::map< std::string, std::string > & | options, | ||
| ShowSecurityResponse & | response_ | ||
| ) | const |
Shows security information relating to users and/or roles.
If the caller is not a system administrator, only information relating to the caller and their roles is returned.
- Parameters
-
[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. - show_security_show_current_user: If true, returns only security information for the current user. Supported values: The default value is show_security_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSqlProc() [1/4]
| ShowSqlProcResponse showSqlProc | ( | const ShowSqlProcRequest & | request_ | ) | const |
◆ showSqlProc() [2/4]
| ShowSqlProcResponse& showSqlProc | ( | const ShowSqlProcRequest & | request_, |
| ShowSqlProcResponse & | response_ | ||
| ) | const |
Shows information about SQL procedures, including the full definition of each requested procedure.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSqlProc() [3/4]
| ShowSqlProcResponse showSqlProc | ( | const std::string & | procedureName, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Shows information about SQL procedures, including the full definition of each requested procedure.
- Parameters
-
[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. - show_sql_proc_no_error_if_not_exists: If true, no error will be returned if the requested procedure does not exist. If false, an error will be returned if the requested procedure does not exist. Supported values: The default value is show_sql_proc_false.
- Returns
- Response object containing the result of the operation.
◆ showSqlProc() [4/4]
| ShowSqlProcResponse& showSqlProc | ( | const std::string & | procedureName, |
| const std::map< std::string, std::string > & | options, | ||
| ShowSqlProcResponse & | response_ | ||
| ) | const |
Shows information about SQL procedures, including the full definition of each requested procedure.
- Parameters
-
[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. - show_sql_proc_no_error_if_not_exists: If true, no error will be returned if the requested procedure does not exist. If false, an error will be returned if the requested procedure does not exist. Supported values: The default value is show_sql_proc_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showStatistics() [1/4]
| ShowStatisticsResponse showStatistics | ( | const ShowStatisticsRequest & | request_ | ) | const |
◆ showStatistics() [2/4]
| ShowStatisticsResponse& showStatistics | ( | const ShowStatisticsRequest & | request_, |
| ShowStatisticsResponse & | response_ | ||
| ) | const |
Retrieves the collected column statistics for the specified table(s).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showStatistics() [3/4]
| 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).
- Parameters
-
[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. - show_statistics_no_error_if_not_exists: If true and if the table names specified in tableNames does not exist, no error is returned. If false and if the table names specified in tableNames does not exist, then an error is returned. Supported values: The default value is show_statistics_false.
- Returns
- Response object containing the result of the operation.
◆ showStatistics() [4/4]
| 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).
- Parameters
-
[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. - show_statistics_no_error_if_not_exists: If true and if the table names specified in tableNames does not exist, no error is returned. If false and if the table names specified in tableNames does not exist, then an error is returned. Supported values: The default value is show_statistics_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSystemProperties() [1/4]
| ShowSystemPropertiesResponse showSystemProperties | ( | const ShowSystemPropertiesRequest & | request_ | ) | const |
◆ showSystemProperties() [2/4]
| ShowSystemPropertiesResponse& showSystemProperties | ( | const ShowSystemPropertiesRequest & | request_, |
| ShowSystemPropertiesResponse & | response_ | ||
| ) | const |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSystemProperties() [3/4]
| ShowSystemPropertiesResponse showSystemProperties | ( | const std::map< std::string, std::string > & | options | ) | const |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
- Parameters
-
[in] options Optional parameters. - show_system_properties_properties: A list of comma separated names of properties requested. If not specified, all properties will be returned.
- Returns
- Response object containing the result of the operation.
◆ showSystemProperties() [4/4]
| ShowSystemPropertiesResponse& showSystemProperties | ( | const std::map< std::string, std::string > & | options, |
| ShowSystemPropertiesResponse & | response_ | ||
| ) | const |
Returns server configuration and version related information to the caller.
The admin tool uses it to present server related information to the user.
- Parameters
-
[in] options Optional parameters. - show_system_properties_properties: A list of comma separated names of properties requested. If not specified, all properties will be returned.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSystemStatus() [1/4]
| ShowSystemStatusResponse showSystemStatus | ( | const ShowSystemStatusRequest & | request_ | ) | const |
◆ showSystemStatus() [2/4]
| ShowSystemStatusResponse& showSystemStatus | ( | const ShowSystemStatusRequest & | request_, |
| ShowSystemStatusResponse & | response_ | ||
| ) | const |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSystemStatus() [3/4]
| ShowSystemStatusResponse showSystemStatus | ( | const std::map< std::string, std::string > & | options | ) | const |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
- Parameters
-
[in] options Optional parameters, currently unused. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ showSystemStatus() [4/4]
| ShowSystemStatusResponse& showSystemStatus | ( | const std::map< std::string, std::string > & | options, |
| ShowSystemStatusResponse & | response_ | ||
| ) | const |
Provides server configuration and health related status to the caller.
The admin tool uses it to present server related information to the user.
- Parameters
-
[in] options Optional parameters, currently unused. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSystemTiming() [1/4]
| ShowSystemTimingResponse showSystemTiming | ( | const ShowSystemTimingRequest & | request_ | ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showSystemTiming() [2/4]
| ShowSystemTimingResponse& showSystemTiming | ( | const ShowSystemTimingRequest & | request_, |
| ShowSystemTimingResponse & | response_ | ||
| ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showSystemTiming() [3/4]
| ShowSystemTimingResponse showSystemTiming | ( | const std::map< std::string, std::string > & | options | ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
- Parameters
-
[in] options Optional parameters, currently unused. The default value is an empty map.
- Returns
- Response object containing the result of the operation.
◆ showSystemTiming() [4/4]
| ShowSystemTimingResponse& showSystemTiming | ( | const std::map< std::string, std::string > & | options, |
| ShowSystemTimingResponse & | response_ | ||
| ) | const |
Returns the last 100 database requests along with the request timing and internal job id.
The admin tool uses it to present request timing information to the user.
- Parameters
-
[in] options Optional parameters, currently unused. The default value is an empty map. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTable() [1/4]
| ShowTableResponse 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.).
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showTable() [2/4]
| ShowTableResponse& 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.).
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTable() [3/4]
| ShowTableResponse 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.).
- Parameters
-
[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. - show_table_dependencies: Include view dependencies in the output. Supported values: The default value is show_table_false.
- show_table_force_synchronous: If true then the table sizes will wait for read lock before returning. Supported values: The default value is show_table_true.
- show_table_get_cached_sizes: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occuring. Supported values: The default value is show_table_false.
- show_table_get_sizes: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values: The default value is show_table_false.
- show_table_no_error_if_not_exists: If false will return an error if the provided tableName does not exist. If true then it will return an empty result. Supported values: The default value is show_table_false.
- show_table_show_children: If tableName is a schema, then true will return information about the tables and views in the schema, and false will return information about the schema itself. If tableName is a table or view, show_children must be false. If tableName is empty, then show_children must be true. Supported values: The default value is show_table_true.
- show_table_get_column_info: If true then column info (memory usage, etc) will be returned. Supported values: The default value is show_table_false.
- Returns
- Response object containing the result of the operation.
◆ showTable() [4/4]
| 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.
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.).
- Parameters
-
[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. - show_table_dependencies: Include view dependencies in the output. Supported values: The default value is show_table_false.
- show_table_force_synchronous: If true then the table sizes will wait for read lock before returning. Supported values: The default value is show_table_true.
- show_table_get_cached_sizes: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occuring. Supported values: The default value is show_table_false.
- show_table_get_sizes: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values: The default value is show_table_false.
- show_table_no_error_if_not_exists: If false will return an error if the provided tableName does not exist. If true then it will return an empty result. Supported values: The default value is show_table_false.
- show_table_show_children: If tableName is a schema, then true will return information about the tables and views in the schema, and false will return information about the schema itself. If tableName is a table or view, show_children must be false. If tableName is empty, then show_children must be true. Supported values: The default value is show_table_true.
- show_table_get_column_info: If true then column info (memory usage, etc) will be returned. Supported values: The default value is show_table_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTableMetadata() [1/4]
| ShowTableMetadataResponse showTableMetadata | ( | const ShowTableMetadataRequest & | request_ | ) | const |
◆ showTableMetadata() [2/4]
| ShowTableMetadataResponse& showTableMetadata | ( | const ShowTableMetadataRequest & | request_, |
| ShowTableMetadataResponse & | response_ | ||
| ) | const |
Retrieves the user provided metadata for the specified tables.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTableMetadata() [3/4]
| ShowTableMetadataResponse showTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves the user provided metadata for the specified tables.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showTableMetadata() [4/4]
| ShowTableMetadataResponse& showTableMetadata | ( | const std::vector< std::string > & | tableNames, |
| const std::map< std::string, std::string > & | options, | ||
| ShowTableMetadataResponse & | response_ | ||
| ) | const |
Retrieves the user provided metadata for the specified tables.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTableMonitors() [1/4]
| ShowTableMonitorsResponse showTableMonitors | ( | const ShowTableMonitorsRequest & | request_ | ) | const |
Show table monitors and their properties.
Table monitors are created using createTableMonitor. Returns detailed information about existing table monitors.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showTableMonitors() [2/4]
| ShowTableMonitorsResponse& 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTableMonitors() [3/4]
| ShowTableMonitorsResponse 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.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showTableMonitors() [4/4]
| 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.
Table monitors are created using createTableMonitor. Returns detailed information about existing table monitors.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTablesByType() [1/4]
| ShowTablesByTypeResponse showTablesByType | ( | const ShowTablesByTypeRequest & | request_ | ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showTablesByType() [2/4]
| ShowTablesByTypeResponse& showTablesByType | ( | const ShowTablesByTypeRequest & | request_, |
| ShowTablesByTypeResponse & | response_ | ||
| ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTablesByType() [3/4]
| ShowTablesByTypeResponse showTablesByType | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showTablesByType() [4/4]
| ShowTablesByTypeResponse& showTablesByType | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options, | ||
| ShowTablesByTypeResponse & | response_ | ||
| ) | const |
Gets names of the tables whose type matches the given criteria.
Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTriggers() [1/4]
| ShowTriggersResponse showTriggers | ( | const ShowTriggersRequest & | request_ | ) | const |
◆ showTriggers() [2/4]
| ShowTriggersResponse& showTriggers | ( | const ShowTriggersRequest & | request_, |
| ShowTriggersResponse & | response_ | ||
| ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTriggers() [3/4]
| ShowTriggersResponse showTriggers | ( | const std::vector< std::string > & | triggerIds, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ showTriggers() [4/4]
| ShowTriggersResponse& showTriggers | ( | const std::vector< std::string > & | triggerIds, |
| const std::map< std::string, std::string > & | options, | ||
| ShowTriggersResponse & | response_ | ||
| ) | const |
Retrieves information regarding the specified triggers or all existing triggers currently active.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTypes() [1/4]
| ShowTypesResponse showTypes | ( | const ShowTypesRequest & | request_ | ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ showTypes() [2/4]
| ShowTypesResponse& showTypes | ( | const ShowTypesRequest & | request_, |
| ShowTypesResponse & | response_ | ||
| ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showTypes() [3/4]
| ShowTypesResponse showTypes | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
- Parameters
-
[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. - show_types_no_join_types: When set to 'true', no join types will be included. Supported values: The default value is show_types_false.
- Returns
- Response object containing the result of the operation.
◆ showTypes() [4/4]
| ShowTypesResponse& showTypes | ( | const std::string & | typeId, |
| const std::string & | label, | ||
| const std::map< std::string, std::string > & | options, | ||
| ShowTypesResponse & | response_ | ||
| ) | const |
Retrieves information for the specified data type ID or type label.
For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
- Parameters
-
[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. - show_types_no_join_types: When set to 'true', no join types will be included. Supported values: The default value is show_types_false.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showVideo() [1/4]
| ShowVideoResponse showVideo | ( | const ShowVideoRequest & | request_ | ) | const |
◆ showVideo() [2/4]
| ShowVideoResponse& showVideo | ( | const ShowVideoRequest & | request_, |
| ShowVideoResponse & | response_ | ||
| ) | const |
◆ showVideo() [3/4]
| ShowVideoResponse showVideo | ( | const std::vector< std::string > & | paths, |
| const std::map< std::string, std::string > & | options | ||
| ) | const |
◆ showVideo() [4/4]
| ShowVideoResponse& showVideo | ( | const std::vector< std::string > & | paths, |
| const std::map< std::string, std::string > & | options, | ||
| ShowVideoResponse & | response_ | ||
| ) | const |
Retrieves information about rendered videos.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showWal() [1/4]
| ShowWalResponse showWal | ( | const ShowWalRequest & | request_ | ) | const |
◆ showWal() [2/4]
| ShowWalResponse& showWal | ( | const ShowWalRequest & | request_, |
| ShowWalResponse & | response_ | ||
| ) | const |
Requests table wal properties.
Returns information about the requested table wal entries.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ showWal() [3/4]
| ShowWalResponse 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.
- Parameters
-
[in] tableNames List of tables to query. An asterisk returns all tables. [in] options Optional parameters. - show_wal_show_settings: If true include a map of the wal settings for the requested tables. Supported values: The default value is show_wal_true.
- Returns
- Response object containing the result of the operation.
◆ showWal() [4/4]
| ShowWalResponse& 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.
- Parameters
-
[in] tableNames List of tables to query. An asterisk returns all tables. [in] options Optional parameters. - show_wal_show_settings: If true include a map of the wal settings for the requested tables. Supported values: The default value is show_wal_true.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ solveGraph() [1/4]
| SolveGraphResponse solveGraph | ( | const SolveGraphRequest & | request_ | ) | const |
Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ solveGraph() [2/4]
| SolveGraphResponse& solveGraph | ( | const SolveGraphRequest & | request_, |
| SolveGraphResponse & | response_ | ||
| ) | const |
Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ solveGraph() [3/4]
| SolveGraphResponse solveGraph | ( | const std::string & | graphName, |
| const std::vector< std::string > & | weightsOnEdges, | ||
| const std::vector< std::string > & | restrictions, | ||
| const std::string & | solverType, | ||
| const std::vector< std::string > & | sourceNodes, | ||
| const std::vector< std::string > & | destinationNodes, | ||
| const std::string & | solutionTable, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
- Parameters
-
[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: - solve_graph_SHORTEST_PATH: Solves for the optimal (shortest) path based on weights and restrictions from one source to destinations nodes. Also known as the Dijkstra solver.
- solve_graph_PAGE_RANK: Solves for the probability of each destination node being visited based on the links of the graph topology. Weights are not required to use this solver.
- solve_graph_PROBABILITY_RANK: Solves for the transitional probability (Hidden Markov) for each node based on the weights (probability assigned over given edges).
- solve_graph_CENTRALITY: Solves for the degree of a node to depict how many pairs of individuals that would have to go through the node to reach one another in the minimum number of hops. Also known as betweenness.
- solve_graph_MULTIPLE_ROUTING: Solves for finding the minimum cost cumulative path for a round-trip starting from the given source and visiting each given destination node once then returning to the source. Also known as the travelling salesman problem.
- solve_graph_INVERSE_SHORTEST_PATH: Solves for finding the optimal path cost for each destination node to route to the source node. Also known as inverse Dijkstra or the service man routing problem.
- solve_graph_BACKHAUL_ROUTING: Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
- solve_graph_ALLPATHS: Solves for paths that would give costs between max and min solution radia - Make sure to limit by the 'max_solution_targets' option. Min cost shoudl be >= shortest_path cost.
- solve_graph_STATS_ALL: Solves for graph statistics such as graph diameter, longest pairs, vertex valences, topology numbers, average and max cluster sizes, etc.
- solve_graph_CLOSENESS: Solves for the centrality closeness score per node as the sum of the inverse shortest path costs to all nodes in the graph.
[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. - solve_graph_max_solution_radius: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
- solve_graph_min_solution_radius: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
- solve_graph_max_solution_targets: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destinationNodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '1000'.
- solve_graph_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
- solve_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_num_best_paths: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
- solve_graph_max_num_combinations: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
- solve_graph_output_edge_path: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. Supported values: The default value is solve_graph_false.
- solve_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. Supported values: The default value is solve_graph_true.
- solve_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. For SHORTEST_PATH solver type, the input is split amongst the server containing the corresponding graph.
- solve_graph_convergence_limit: For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence. Default value is 1 (one) percent. The default value is '1.0'.
- solve_graph_max_iterations: For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence. Default value is 100. The default value is '100'.
- solve_graph_max_runs: For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. Default value of 0 enables this value to be auto computed by the solver. The default value is '0'.
-
solve_graph_output_clusters: For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. Supported values:
- solve_graph_true: An additional column 'CLUSTER' will be added for each node
- solve_graph_false: No extra cluster info per node will be available in the output
-
solve_graph_solve_heuristic: Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target. Supported values:
- solve_graph_astar: Employs A-STAR heuristics to speed up the shortest path traversal
- solve_graph_none: No heuristics are applied
- solve_graph_astar_radius: For path solvers only when 'solve_heuristic' option is 'astar'. The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'.
- Returns
- Response object containing the result of the operation.
◆ solveGraph() [4/4]
| SolveGraphResponse& solveGraph | ( | const std::string & | graphName, |
| const std::vector< std::string > & | weightsOnEdges, | ||
| const std::vector< std::string > & | restrictions, | ||
| const std::string & | solverType, | ||
| const std::vector< std::string > & | sourceNodes, | ||
| const std::vector< std::string > & | destinationNodes, | ||
| const std::string & | solutionTable, | ||
| const std::map< std::string, std::string > & | options, | ||
| SolveGraphResponse & | response_ | ||
| ) | const |
Solves an existing graph for a type of problem (e.g., shortest path, page rank, travelling salesman, etc.) using source nodes, destination nodes, and additional, optional weights and restrictions.
IMPORTANT: It's highly recommended that you review the Graphs & Solvers concepts documentation, the Graph REST Tutorial, and/or some /solve/graph examples before using this endpoint.
- Parameters
-
[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: - solve_graph_SHORTEST_PATH: Solves for the optimal (shortest) path based on weights and restrictions from one source to destinations nodes. Also known as the Dijkstra solver.
- solve_graph_PAGE_RANK: Solves for the probability of each destination node being visited based on the links of the graph topology. Weights are not required to use this solver.
- solve_graph_PROBABILITY_RANK: Solves for the transitional probability (Hidden Markov) for each node based on the weights (probability assigned over given edges).
- solve_graph_CENTRALITY: Solves for the degree of a node to depict how many pairs of individuals that would have to go through the node to reach one another in the minimum number of hops. Also known as betweenness.
- solve_graph_MULTIPLE_ROUTING: Solves for finding the minimum cost cumulative path for a round-trip starting from the given source and visiting each given destination node once then returning to the source. Also known as the travelling salesman problem.
- solve_graph_INVERSE_SHORTEST_PATH: Solves for finding the optimal path cost for each destination node to route to the source node. Also known as inverse Dijkstra or the service man routing problem.
- solve_graph_BACKHAUL_ROUTING: Solves for optimal routes that connect remote asset nodes to the fixed (backbone) asset nodes.
- solve_graph_ALLPATHS: Solves for paths that would give costs between max and min solution radia - Make sure to limit by the 'max_solution_targets' option. Min cost shoudl be >= shortest_path cost.
- solve_graph_STATS_ALL: Solves for graph statistics such as graph diameter, longest pairs, vertex valences, topology numbers, average and max cluster sizes, etc.
- solve_graph_CLOSENESS: Solves for the centrality closeness score per node as the sum of the inverse shortest path costs to all nodes in the graph.
[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. - solve_graph_max_solution_radius: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
- solve_graph_min_solution_radius: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the destinationNodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
- solve_graph_max_solution_targets: For ALLPATHS, SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the destinationNodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '1000'.
- solve_graph_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
- solve_graph_left_turn_penalty: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_right_turn_penalty: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_intersection_penalty: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_sharp_turn_penalty: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the createGraph was invoked at graph creation. The default value is '0.0'.
- solve_graph_num_best_paths: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
- solve_graph_max_num_combinations: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
- solve_graph_output_edge_path: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. Supported values: The default value is solve_graph_false.
- solve_graph_output_wkt_path: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. Supported values: The default value is solve_graph_true.
- solve_graph_server_id: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. For SHORTEST_PATH solver type, the input is split amongst the server containing the corresponding graph.
- solve_graph_convergence_limit: For PAGE_RANK solvers only; Maximum percent relative threshold on the pagerank scores of each node between consecutive iterations to satisfy convergence. Default value is 1 (one) percent. The default value is '1.0'.
- solve_graph_max_iterations: For PAGE_RANK solvers only; Maximum number of pagerank iterations for satisfying convergence. Default value is 100. The default value is '100'.
- solve_graph_max_runs: For all CENTRALITY solvers only; Sets the maximum number of shortest path runs; maximum possible value is the number of nodes in the graph. Default value of 0 enables this value to be auto computed by the solver. The default value is '0'.
-
solve_graph_output_clusters: For STATS_ALL solvers only; the cluster index for each node will be inserted as an additional column in the output. Supported values:
- solve_graph_true: An additional column 'CLUSTER' will be added for each node
- solve_graph_false: No extra cluster info per node will be available in the output
-
solve_graph_solve_heuristic: Specify heuristic search criterion only for the geo graphs and shortest path solves towards a single target. Supported values:
- solve_graph_astar: Employs A-STAR heuristics to speed up the shortest path traversal
- solve_graph_none: No heuristics are applied
- solve_graph_astar_radius: For path solvers only when 'solve_heuristic' option is 'astar'. The shortest path traversal front includes nodes only within this radius (kilometers) as it moves towards the target location. The default value is '70'.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ updateRecords() [1/4]
template<typename TRequest >
| UpdateRecordsResponse updateRecords | ( | const UpdateRecordsRequest< TRequest > & | request_ | ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
Definition at line 47877 of file GPUdbFunctions.hpp.
◆ updateRecords() [2/4]
template<typename TRequest >
| UpdateRecordsResponse& updateRecords | ( | const UpdateRecordsRequest< TRequest > & | request_, |
| UpdateRecordsResponse & | response_ | ||
| ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 47932 of file GPUdbFunctions.hpp.
◆ updateRecords() [3/4]
template<typename TRequest >
| UpdateRecordsResponse updateRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | expressions, | ||
| const std::vector< std::map< std::string, boost::optional< std::string > > > & | newValuesMaps, | ||
| const std::vector< TRequest > & | data, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[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. - update_records_global_expression: An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ''.
- update_records_bypass_safety_checks: When set to true, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values: The default value is update_records_false.
-
update_records_update_on_existing_pk: Specifies the record collision policy for updating a table with a primary key. There are two ways that a record collision can occur. The first is an "update collision", which happens when the update changes the value of the updated record's primary key, and that new primary key already exists as the primary key of another record in the table. The second is an "insert
collision", which occurs when a given filter in expressions finds no records to update, and the alternate insert record given in data (or recordsToInsertStr) contains a primary key matching that of an existing record in the table. If update_on_existing_pk is set to true, "update
collisions" will result in the existing record collided into being removed and the record updated with values specified in newValuesMaps taking its place; "insert
collisions" will result in the collided-into record being updated with the values in data/recordsToInsertStr (if given). If set to false, the existing collided-into record will remain unchanged, while the update will be rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
- update_records_true: Overwrite the collided-into record when updating a record's primary key or inserting an alternate record causes a primary key collision between the record being updated/inserted and another existing record in the table
- update_records_false: Reject updates which cause primary key collisions between the record being updated/inserted and an existing record in the table
-
update_records_ignore_existing_pk: Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values:
- update_records_true: Ignore updates that result in primary key collisions with existing records
- update_records_false: Treat as errors any updates that result in primary key collisions with existing records
- update_records_update_partition: Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. Supported values: The default value is update_records_false.
- update_records_truncate_strings: If set to true, any strings which are too long for their charN string fields will be truncated to fit. Supported values: The default value is update_records_false.
- update_records_use_expressions_in_new_values_maps: When set to true, all new values in newValuesMaps are considered as expression values. When set to false, all new values in newValuesMaps are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. Supported values: The default value is update_records_false.
- update_records_record_id: ID of a single record to be updated (returned in the call to insertRecords or getRecordsFromCollection).
- Returns
- Response object containing the result of the operation.
Definition at line 48185 of file GPUdbFunctions.hpp.
◆ updateRecords() [4/4]
template<typename TRequest >
| UpdateRecordsResponse& updateRecords | ( | const std::string & | tableName, |
| const std::vector< std::string > & | expressions, | ||
| const std::vector< std::map< std::string, boost::optional< std::string > > > & | newValuesMaps, | ||
| const std::vector< TRequest > & | data, | ||
| const std::map< std::string, std::string > & | options, | ||
| UpdateRecordsResponse & | response_ | ||
| ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
- Template Parameters
-
TRequest The type of object being added.
- Parameters
-
[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. - update_records_global_expression: An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ''.
- update_records_bypass_safety_checks: When set to true, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values: The default value is update_records_false.
-
update_records_update_on_existing_pk: Specifies the record collision policy for updating a table with a primary key. There are two ways that a record collision can occur. The first is an "update collision", which happens when the update changes the value of the updated record's primary key, and that new primary key already exists as the primary key of another record in the table. The second is an "insert
collision", which occurs when a given filter in expressions finds no records to update, and the alternate insert record given in data (or recordsToInsertStr) contains a primary key matching that of an existing record in the table. If update_on_existing_pk is set to true, "update
collisions" will result in the existing record collided into being removed and the record updated with values specified in newValuesMaps taking its place; "insert
collisions" will result in the collided-into record being updated with the values in data/recordsToInsertStr (if given). If set to false, the existing collided-into record will remain unchanged, while the update will be rejected and the error handled as determined by ignore_existing_pk. If the specified table does not have a primary key, then this option has no effect. Supported values:
- update_records_true: Overwrite the collided-into record when updating a record's primary key or inserting an alternate record causes a primary key collision between the record being updated/inserted and another existing record in the table
- update_records_false: Reject updates which cause primary key collisions between the record being updated/inserted and an existing record in the table
-
update_records_ignore_existing_pk: Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (update_on_existing_pk is false). If set to true, any record update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If false, the rejection of any update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if update_on_existing_pk is true, then this option has no effect. Supported values:
- update_records_true: Ignore updates that result in primary key collisions with existing records
- update_records_false: Treat as errors any updates that result in primary key collisions with existing records
- update_records_update_partition: Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. Supported values: The default value is update_records_false.
- update_records_truncate_strings: If set to true, any strings which are too long for their charN string fields will be truncated to fit. Supported values: The default value is update_records_false.
- update_records_use_expressions_in_new_values_maps: When set to true, all new values in newValuesMaps are considered as expression values. When set to false, all new values in newValuesMaps are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. Supported values: The default value is update_records_false.
- update_records_record_id: ID of a single record to be updated (returned in the call to insertRecords or getRecordsFromCollection).
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
Definition at line 48444 of file GPUdbFunctions.hpp.
◆ updateRecordsBySeries() [1/4]
| UpdateRecordsBySeriesResponse updateRecordsBySeries | ( | const UpdateRecordsBySeriesRequest & | request_ | ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ updateRecordsBySeries() [2/4]
| UpdateRecordsBySeriesResponse& updateRecordsBySeries | ( | const UpdateRecordsBySeriesRequest & | request_, |
| UpdateRecordsBySeriesResponse & | response_ | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ updateRecordsBySeries() [3/4]
| UpdateRecordsBySeriesResponse updateRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const std::string & | viewName, | ||
| const std::vector< std::string > & | reserved, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ updateRecordsBySeries() [4/4]
| UpdateRecordsBySeriesResponse& updateRecordsBySeries | ( | const std::string & | tableName, |
| const std::string & | worldTableName, | ||
| const std::string & | viewName, | ||
| const std::vector< std::string > & | reserved, | ||
| const std::map< std::string, std::string > & | options, | ||
| UpdateRecordsBySeriesResponse & | response_ | ||
| ) | const |
Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ updateRecordsRaw() [1/2]
| UpdateRecordsResponse updateRecordsRaw | ( | const RawUpdateRecordsRequest & | request_ | ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ updateRecordsRaw() [2/2]
| UpdateRecordsResponse& updateRecordsRaw | ( | const RawUpdateRecordsRequest & | request_, |
| UpdateRecordsResponse & | response_ | ||
| ) | const |
Runs multiple predicate-based updates in a single call.
With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.
Note that this operation can only be run on an original table and not on a 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.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ uploadFiles() [1/4]
| UploadFilesResponse 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:
- Provide the file name in fileNames, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
- Upload one or more parts by providing the file name, the part data in fileData, the UUID, a multipart_operation value of upload_part, and the part number in the multipart_upload_part_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.
- Complete the upload by providing the file name, the UUID, and a multipart_operation value of complete.
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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ uploadFiles() [2/4]
| UploadFilesResponse& 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:
- Provide the file name in fileNames, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
- Upload one or more parts by providing the file name, the part data in fileData, the UUID, a multipart_operation value of upload_part, and the part number in the multipart_upload_part_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.
- Complete the upload by providing the file name, the UUID, and a multipart_operation value of complete.
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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ uploadFiles() [3/4]
| 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.
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:
- Provide the file name in fileNames, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
- Upload one or more parts by providing the file name, the part data in fileData, the UUID, a multipart_operation value of upload_part, and the part number in the multipart_upload_part_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.
- Complete the upload by providing the file name, the UUID, and a multipart_operation value of complete.
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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[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. -
upload_files_file_encoding: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values:
- upload_files_base64: Specifies that the file data being uploaded has been base64 encoded.
- upload_files_none: The uploaded file data has not been encoded.
-
upload_files_multipart_operation: Multipart upload operation to perform. Supported values:
- upload_files_none: Default, indicates this is not a multipart upload
- upload_files_init: Initialize a multipart file upload
- upload_files_upload_part: Uploads a part of the specified multipart file upload
- upload_files_complete: Complete the specified multipart file upload
- upload_files_cancel: Cancel the specified multipart file upload
- upload_files_multipart_upload_uuid: UUID to uniquely identify a multipart upload
- upload_files_multipart_upload_part_number: Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentially
- upload_files_delete_if_exists: If true, any existing files specified in fileNames will be deleted prior to start of upload. Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values: The default value is upload_files_false.
-
upload_files_file_encoding: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values:
- Returns
- Response object containing the result of the operation.
◆ uploadFiles() [4/4]
| 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.
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:
- Provide the file name in fileNames, the UUID in the multipart_upload_uuid key in options, and a multipart_operation value of init.
- Upload one or more parts by providing the file name, the part data in fileData, the UUID, a multipart_operation value of upload_part, and the part number in the multipart_upload_part_number. The part numbers must start at 1 and increase incrementally. Parts may not be uploaded out of order.
- Complete the upload by providing the file name, the UUID, and a multipart_operation value of complete.
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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[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. -
upload_files_file_encoding: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values:
- upload_files_base64: Specifies that the file data being uploaded has been base64 encoded.
- upload_files_none: The uploaded file data has not been encoded.
-
upload_files_multipart_operation: Multipart upload operation to perform. Supported values:
- upload_files_none: Default, indicates this is not a multipart upload
- upload_files_init: Initialize a multipart file upload
- upload_files_upload_part: Uploads a part of the specified multipart file upload
- upload_files_complete: Complete the specified multipart file upload
- upload_files_cancel: Cancel the specified multipart file upload
- upload_files_multipart_upload_uuid: UUID to uniquely identify a multipart upload
- upload_files_multipart_upload_part_number: Incremental part number for each part in a multipart upload. Part numbers start at 1, increment by 1, and must be uploaded sequentially
- upload_files_delete_if_exists: If true, any existing files specified in fileNames will be deleted prior to start of upload. Otherwise the file is replaced once the upload completes. Rollback of the original file is no longer possible if the upload is cancelled, aborted or fails if the file was deleted beforehand. Supported values: The default value is upload_files_false.
[out] response_ Response object containing the results of the operation. -
upload_files_file_encoding: Encoding that has been applied to the uploaded file data. When using JSON serialization it is recommended to utilize base64. The caller is responsible for encoding the data provided in this payload. Supported values:
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ uploadFilesFromurl() [1/4]
| UploadFilesFromurlResponse 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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ uploadFilesFromurl() [2/4]
| UploadFilesFromurlResponse& 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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ uploadFilesFromurl() [3/4]
| 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.
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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation.
◆ uploadFilesFromurl() [4/4]
| 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.
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: '.' '-' ':' '[' ']' '(' ')' '#' '='.
- Parameters
-
[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.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ visualizeImageChart() [1/4]
| VisualizeImageChartResponse visualizeImageChart | ( | const VisualizeImageChartRequest & | request_ | ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ visualizeImageChart() [2/4]
| VisualizeImageChartResponse& visualizeImageChart | ( | const VisualizeImageChartRequest & | request_, |
| VisualizeImageChartResponse & | response_ | ||
| ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ visualizeImageChart() [3/4]
| VisualizeImageChartResponse visualizeImageChart | ( | const std::string & | tableName, |
| const std::vector< std::string > & | xColumnNames, | ||
| const std::vector< std::string > & | yColumnNames, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const int32_t | width, | ||
| const int32_t | height, | ||
| const std::string & | bgColor, | ||
| const std::map< std::string, std::vector< std::string > > & | styleOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
- Parameters
-
[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. - visualize_image_chart_pointcolor: The color of points in the plot represented as a hexadecimal number. The default value is '0000FF'.
- visualize_image_chart_pointsize: The size of points in the plot represented as number of pixels. The default value is '3'.
-
visualize_image_chart_pointshape: The shape of points in the plot. Supported values:
- visualize_image_chart_none
- visualize_image_chart_circle
- visualize_image_chart_square
- visualize_image_chart_diamond
- visualize_image_chart_hollowcircle
- visualize_image_chart_hollowsquare
- visualize_image_chart_hollowdiamond
- visualize_image_chart_cb_pointcolors: Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. This option overrides the pointcolor option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point color values are separated by cb_delimiter, e.g. {"price", "20:30;30:40;40:50", "0xFF0000;0x00FF00;0x0000FF"}.
- visualize_image_chart_cb_pointsizes: Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. This option overrides the pointsize option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point size values are separated by cb_delimiter, e.g. {"states", "NY;TX;CA", "3;5;7"}.
- visualize_image_chart_cb_pointshapes: Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. This option overrides the pointshape option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point shape names are separated by cb_delimiter, e.g. {"states", "NY;TX;CA", "circle;square;diamond"}.
- visualize_image_chart_cb_delimiter: A character or string which separates per-class values in a class-break style option string. The default value is ';'.
- visualize_image_chart_x_order_by: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending".
- visualize_image_chart_y_order_by: An expression or aggregate expression by which non-numeric y column values are sorted, e.g. "avg(price)", which defaults to "avg(price) ascending".
-
visualize_image_chart_scale_type_x: Type of x axis scale. Supported values:
- visualize_image_chart_none: No scale is applied to the x axis.
- visualize_image_chart_log: A base-10 log scale is applied to the x axis.
-
visualize_image_chart_scale_type_y: Type of y axis scale. Supported values:
- visualize_image_chart_none: No scale is applied to the y axis.
- visualize_image_chart_log: A base-10 log scale is applied to the y axis.
- visualize_image_chart_min_max_scaled: If this options is set to "false", this endpoint expects request's min/max values are not yet scaled. They will be scaled according to scale_type_x or scale_type_y for response. If this options is set to "true", this endpoint expects request's min/max values are already scaled according to scale_type_x/scale_type_y. Response's min/max values will be equal to request's min/max values. The default value is 'false'.
- visualize_image_chart_jitter_x: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is '0.0'.
- visualize_image_chart_jitter_y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is '0.0'.
- visualize_image_chart_plot_all: If this options is set to "true", all non-numeric column values are plotted ignoring min_x, max_x, min_y and max_y parameters. The default value is 'false'.
[in] options Optional parameters. -
visualize_image_chart_image_encoding: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as base64. Supported values:
- visualize_image_chart_base64: Apply base64 encoding to the output image.
- visualize_image_chart_none: Do not apply any additional encoding to the output image.
- Returns
- Response object containing the result of the operation.
◆ visualizeImageChart() [4/4]
| VisualizeImageChartResponse& visualizeImageChart | ( | const std::string & | tableName, |
| const std::vector< std::string > & | xColumnNames, | ||
| const std::vector< std::string > & | yColumnNames, | ||
| const double | minX, | ||
| const double | maxX, | ||
| const double | minY, | ||
| const double | maxY, | ||
| const int32_t | width, | ||
| const int32_t | height, | ||
| const std::string & | bgColor, | ||
| const std::map< std::string, std::vector< std::string > > & | styleOptions, | ||
| const std::map< std::string, std::string > & | options, | ||
| VisualizeImageChartResponse & | response_ | ||
| ) | const |
Scatter plot is the only plot type currently supported.
A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
- Parameters
-
[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. - visualize_image_chart_pointcolor: The color of points in the plot represented as a hexadecimal number. The default value is '0000FF'.
- visualize_image_chart_pointsize: The size of points in the plot represented as number of pixels. The default value is '3'.
-
visualize_image_chart_pointshape: The shape of points in the plot. Supported values:
- visualize_image_chart_none
- visualize_image_chart_circle
- visualize_image_chart_square
- visualize_image_chart_diamond
- visualize_image_chart_hollowcircle
- visualize_image_chart_hollowsquare
- visualize_image_chart_hollowdiamond
- visualize_image_chart_cb_pointcolors: Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. This option overrides the pointcolor option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point color values are separated by cb_delimiter, e.g. {"price", "20:30;30:40;40:50", "0xFF0000;0x00FF00;0x0000FF"}.
- visualize_image_chart_cb_pointsizes: Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. This option overrides the pointsize option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point size values are separated by cb_delimiter, e.g. {"states", "NY;TX;CA", "3;5;7"}.
- visualize_image_chart_cb_pointshapes: Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. This option overrides the pointshape option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point shape names are separated by cb_delimiter, e.g. {"states", "NY;TX;CA", "circle;square;diamond"}.
- visualize_image_chart_cb_delimiter: A character or string which separates per-class values in a class-break style option string. The default value is ';'.
- visualize_image_chart_x_order_by: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending".
- visualize_image_chart_y_order_by: An expression or aggregate expression by which non-numeric y column values are sorted, e.g. "avg(price)", which defaults to "avg(price) ascending".
-
visualize_image_chart_scale_type_x: Type of x axis scale. Supported values:
- visualize_image_chart_none: No scale is applied to the x axis.
- visualize_image_chart_log: A base-10 log scale is applied to the x axis.
-
visualize_image_chart_scale_type_y: Type of y axis scale. Supported values:
- visualize_image_chart_none: No scale is applied to the y axis.
- visualize_image_chart_log: A base-10 log scale is applied to the y axis.
- visualize_image_chart_min_max_scaled: If this options is set to "false", this endpoint expects request's min/max values are not yet scaled. They will be scaled according to scale_type_x or scale_type_y for response. If this options is set to "true", this endpoint expects request's min/max values are already scaled according to scale_type_x/scale_type_y. Response's min/max values will be equal to request's min/max values. The default value is 'false'.
- visualize_image_chart_jitter_x: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is '0.0'.
- visualize_image_chart_jitter_y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is '0.0'.
- visualize_image_chart_plot_all: If this options is set to "true", all non-numeric column values are plotted ignoring min_x, max_x, min_y and max_y parameters. The default value is 'false'.
[in] options Optional parameters. -
visualize_image_chart_image_encoding: Encoding to be applied to the output image. When using JSON serialization it is recommended to specify this as base64. Supported values:
- visualize_image_chart_base64: Apply base64 encoding to the output image.
- visualize_image_chart_none: Do not apply any additional encoding to the output image.
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ visualizeIsochrone() [1/4]
| VisualizeIsochroneResponse visualizeIsochrone | ( | const VisualizeIsochroneRequest & | request_ | ) | const |
Generate an image containing isolines for travel results using an existing graph.
Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs & Solvers for more information on graphs.
- Parameters
-
[in] request_ Request object containing the parameters for the operation.
- Returns
- Response object containing the result of the operation.
◆ visualizeIsochrone() [2/4]
| VisualizeIsochroneResponse& visualizeIsochrone | ( | const VisualizeIsochroneRequest & | request_, |
| VisualizeIsochroneResponse & | response_ | ||
| ) | const |
Generate an image containing isolines for travel results using an existing graph.
Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs & Solvers for more information on graphs.
- Parameters
-
[in] request_ Request object containing the parameters for the operation. [out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
◆ visualizeIsochrone() [3/4]
| VisualizeIsochroneResponse visualizeIsochrone | ( | const std::string & | graphName, |
| const std::string & | sourceNode, | ||
| const double | maxSolutionRadius, | ||
| const std::vector< std::string > & | weightsOnEdges, | ||
| const std::vector< std::string > & | restrictions, | ||
| const int32_t | numLevels, | ||
| const bool | generateImage, | ||
| const std::string & | levelsTable, | ||
| const std::map< std::string, std::string > & | styleOptions, | ||
| const std::map< std::string, std::string > & | solveOptions, | ||
| const std::map< std::string, std::string > & | contourOptions, | ||
| const std::map< std::string, std::string > & | options | ||
| ) | const |
Generate an image containing isolines for travel results using an existing graph.
Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs & Solvers for more information on graphs.
- Parameters
-
[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: - true
- false
[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. - visualize_isochrone_line_size: The width of the contour lines in pixels. The default value is '3'. The minimum allowed value is '0'. The maximum allowed value is '20'.
- visualize_isochrone_color: Color of generated isolines. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). If alpha is specified and flooded contours are enabled, it will be used for as the transparency of the latter. The default value is 'FF696969'.
- visualize_isochrone_bg_color: When generateImage is set to true, background color of the generated image. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is '00000000'.
- visualize_isochrone_text_color: When add_labels is set to true, color for the labels. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is 'FF000000'.
-
visualize_isochrone_colormap: Colormap for contours or fill-in regions when applicable. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). Supported values:
- visualize_isochrone_jet
- visualize_isochrone_accent
- visualize_isochrone_afmhot
- visualize_isochrone_autumn
- visualize_isochrone_binary
- visualize_isochrone_blues
- visualize_isochrone_bone
- visualize_isochrone_brbg
- visualize_isochrone_brg
- visualize_isochrone_bugn
- visualize_isochrone_bupu
- visualize_isochrone_bwr
- visualize_isochrone_cmrmap
- visualize_isochrone_cool
- visualize_isochrone_coolwarm
- visualize_isochrone_copper
- visualize_isochrone_cubehelix
- visualize_isochrone_dark2
- visualize_isochrone_flag
- visualize_isochrone_gist_earth
- visualize_isochrone_gist_gray
- visualize_isochrone_gist_heat
- visualize_isochrone_gist_ncar
- visualize_isochrone_gist_rainbow
- visualize_isochrone_gist_stern
- visualize_isochrone_gist_yarg
- visualize_isochrone_gnbu
- visualize_isochrone_gnuplot2
- visualize_isochrone_gnuplot
- visualize_isochrone_gray
- visualize_isochrone_greens
- visualize_isochrone_greys
- visualize_isochrone_hot
- visualize_isochrone_hsv
- visualize_isochrone_inferno
- visualize_isochrone_magma
- visualize_isochrone_nipy_spectral
- visualize_isochrone_ocean
- visualize_isochrone_oranges
- visualize_isochrone_orrd
- visualize_isochrone_paired
- visualize_isochrone_pastel1
- visualize_isochrone_pastel2
- visualize_isochrone_pink
- visualize_isochrone_piyg
- visualize_isochrone_plasma
- visualize_isochrone_prgn
- visualize_isochrone_prism
- visualize_isochrone_pubu
- visualize_isochrone_pubugn
- visualize_isochrone_puor
- visualize_isochrone_purd
- visualize_isochrone_purples
- visualize_isochrone_rainbow
- visualize_isochrone_rdbu
- visualize_isochrone_rdgy
- visualize_isochrone_rdpu
- visualize_isochrone_rdylbu
- visualize_isochrone_rdylgn
- visualize_isochrone_reds
- visualize_isochrone_seismic
- visualize_isochrone_set1
- visualize_isochrone_set2
- visualize_isochrone_set3
- visualize_isochrone_spectral
- visualize_isochrone_spring
- visualize_isochrone_summer
- visualize_isochrone_terrain
- visualize_isochrone_viridis
- visualize_isochrone_winter
- visualize_isochrone_wistia
- visualize_isochrone_ylgn
- visualize_isochrone_ylgnbu
- visualize_isochrone_ylorbr
- visualize_isochrone_ylorrd
[in] solveOptions Solver specific parameters. - visualize_isochrone_remove_previous_restrictions: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values: The default value is visualize_isochrone_false.
- visualize_isochrone_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a 'RESTRICTIONS_VALUECOMPARED' value greater than the restriction_threshold_value will not be included in the solution.
- visualize_isochrone_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
[in] contourOptions Solver specific parameters. -
visualize_isochrone_projection: Spatial Reference System (i.e. EPSG Code). Supported values:
- visualize_isochrone_3857
- visualize_isochrone_102100
- visualize_isochrone_900913
- visualize_isochrone_EPSG_4326
- visualize_isochrone_PLATE_CARREE
- visualize_isochrone_EPSG_900913
- visualize_isochrone_EPSG_102100
- visualize_isochrone_EPSG_3857
- visualize_isochrone_WEB_MERCATOR
- visualize_isochrone_width: When generateImage is set to true, width of the generated image. The default value is '512'.
- visualize_isochrone_height: When generateImage is set to true, height of the generated image. If the default value is used, the height is set to the value resulting from multiplying the aspect ratio by the width. The default value is '-1'.
- visualize_isochrone_search_radius: When interpolating the graph solution to generate the isochrone, neighborhood of influence of sample data (in percent of the image/grid). The default value is '20'.
- visualize_isochrone_grid_size: When interpolating the graph solution to generate the isochrone, number of subdivisions along the x axis when building the grid (the y is computed using the aspect ratio of the output image). The default value is '100'.
- visualize_isochrone_color_isolines: Color each isoline according to the colormap; otherwise, use the foreground color. Supported values: The default value is visualize_isochrone_true.
- visualize_isochrone_add_labels: If set to true, add labels to the isolines. Supported values: The default value is visualize_isochrone_false.
- visualize_isochrone_labels_font_size: When add_labels is set to true, size of the font (in pixels) to use for labels. The default value is '12'.
- visualize_isochrone_labels_font_family: When add_labels is set to true, font name to be used when adding labels. The default value is 'arial'.
- visualize_isochrone_labels_search_window: When add_labels is set to true, a search window is used to rate the local quality of each isoline. Smooth, continuous, long stretches with relatively flat angles are favored. The provided value is multiplied by the labels_font_size to calculate the final window size. The default value is '4'.
- visualize_isochrone_labels_intralevel_separation: When add_labels is set to true, this value determines the distance (in multiples of the labels_font_size) to use when separating labels of different values. The default value is '4'.
- visualize_isochrone_labels_interlevel_separation: When add_labels is set to true, this value determines the distance (in percent of the total window size) to use when separating labels of the same value. The default value is '20'.
- visualize_isochrone_labels_max_angle: When add_labels is set to true, maximum angle (in degrees) from the vertical to use when adding labels. The default value is '60'.
[in] options Additional parameters. - visualize_isochrone_solve_table: Name of the table to host intermediate solve results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will contain the position and cost for each vertex in the graph. If the default value is used, a temporary table is created and deleted once the solution is calculated. The default value is ''.
- visualize_isochrone_is_replicated: If set to true, replicate the solve_table. Supported values: The default value is visualize_isochrone_true.
- visualize_isochrone_data_min_x: Lower bound for the x values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_data_max_x: Upper bound for the x values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_data_min_y: Lower bound for the y values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_data_max_y: Upper bound for the y values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_concavity_level: Factor to qualify the concavity of the isochrone curves. The lower the value, the more convex (with '0' being completely convex and '1' being the most concave). The default value is '0.5'. The minimum allowed value is '0'. The maximum allowed value is '1'.
-
visualize_isochrone_use_priority_queue_solvers: sets the solver methods explicitly if true. Supported values:
- visualize_isochrone_true: uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on solve_direction
- visualize_isochrone_false: uses the solvers 'priority_queue' and 'inverse_priority_queue' based on solve_direction
-
visualize_isochrone_solve_direction: Specify whether we are going to the source node, or starting from it. Supported values:
- visualize_isochrone_from_source: Shortest path to get to the source (inverse Dijkstra)
- visualize_isochrone_to_source: Shortest path to source (Dijkstra)
- Returns
- Response object containing the result of the operation.
◆ visualizeIsochrone() [4/4]
| VisualizeIsochroneResponse& visualizeIsochrone | ( | const std::string & | graphName, |
| const std::string & | sourceNode, | ||
| const double | maxSolutionRadius, | ||
| const std::vector< std::string > & | weightsOnEdges, | ||
| const std::vector< std::string > & | restrictions, | ||
| const int32_t | numLevels, | ||
| const bool | generateImage, | ||
| const std::string & | levelsTable, | ||
| const std::map< std::string, std::string > & | styleOptions, | ||
| const std::map< std::string, std::string > & | solveOptions, | ||
| const std::map< std::string, std::string > & | contourOptions, | ||
| const std::map< std::string, std::string > & | options, | ||
| VisualizeIsochroneResponse & | response_ | ||
| ) | const |
Generate an image containing isolines for travel results using an existing graph.
Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs & Solvers for more information on graphs.
- Parameters
-
[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: - true
- false
[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. - visualize_isochrone_line_size: The width of the contour lines in pixels. The default value is '3'. The minimum allowed value is '0'. The maximum allowed value is '20'.
- visualize_isochrone_color: Color of generated isolines. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). If alpha is specified and flooded contours are enabled, it will be used for as the transparency of the latter. The default value is 'FF696969'.
- visualize_isochrone_bg_color: When generateImage is set to true, background color of the generated image. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is '00000000'.
- visualize_isochrone_text_color: When add_labels is set to true, color for the labels. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is 'FF000000'.
-
visualize_isochrone_colormap: Colormap for contours or fill-in regions when applicable. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). Supported values:
- visualize_isochrone_jet
- visualize_isochrone_accent
- visualize_isochrone_afmhot
- visualize_isochrone_autumn
- visualize_isochrone_binary
- visualize_isochrone_blues
- visualize_isochrone_bone
- visualize_isochrone_brbg
- visualize_isochrone_brg
- visualize_isochrone_bugn
- visualize_isochrone_bupu
- visualize_isochrone_bwr
- visualize_isochrone_cmrmap
- visualize_isochrone_cool
- visualize_isochrone_coolwarm
- visualize_isochrone_copper
- visualize_isochrone_cubehelix
- visualize_isochrone_dark2
- visualize_isochrone_flag
- visualize_isochrone_gist_earth
- visualize_isochrone_gist_gray
- visualize_isochrone_gist_heat
- visualize_isochrone_gist_ncar
- visualize_isochrone_gist_rainbow
- visualize_isochrone_gist_stern
- visualize_isochrone_gist_yarg
- visualize_isochrone_gnbu
- visualize_isochrone_gnuplot2
- visualize_isochrone_gnuplot
- visualize_isochrone_gray
- visualize_isochrone_greens
- visualize_isochrone_greys
- visualize_isochrone_hot
- visualize_isochrone_hsv
- visualize_isochrone_inferno
- visualize_isochrone_magma
- visualize_isochrone_nipy_spectral
- visualize_isochrone_ocean
- visualize_isochrone_oranges
- visualize_isochrone_orrd
- visualize_isochrone_paired
- visualize_isochrone_pastel1
- visualize_isochrone_pastel2
- visualize_isochrone_pink
- visualize_isochrone_piyg
- visualize_isochrone_plasma
- visualize_isochrone_prgn
- visualize_isochrone_prism
- visualize_isochrone_pubu
- visualize_isochrone_pubugn
- visualize_isochrone_puor
- visualize_isochrone_purd
- visualize_isochrone_purples
- visualize_isochrone_rainbow
- visualize_isochrone_rdbu
- visualize_isochrone_rdgy
- visualize_isochrone_rdpu
- visualize_isochrone_rdylbu
- visualize_isochrone_rdylgn
- visualize_isochrone_reds
- visualize_isochrone_seismic
- visualize_isochrone_set1
- visualize_isochrone_set2
- visualize_isochrone_set3
- visualize_isochrone_spectral
- visualize_isochrone_spring
- visualize_isochrone_summer
- visualize_isochrone_terrain
- visualize_isochrone_viridis
- visualize_isochrone_winter
- visualize_isochrone_wistia
- visualize_isochrone_ylgn
- visualize_isochrone_ylgnbu
- visualize_isochrone_ylorbr
- visualize_isochrone_ylorrd
[in] solveOptions Solver specific parameters. - visualize_isochrone_remove_previous_restrictions: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values: The default value is visualize_isochrone_false.
- visualize_isochrone_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a 'RESTRICTIONS_VALUECOMPARED' value greater than the restriction_threshold_value will not be included in the solution.
- visualize_isochrone_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.
[in] contourOptions Solver specific parameters. -
visualize_isochrone_projection: Spatial Reference System (i.e. EPSG Code). Supported values:
- visualize_isochrone_3857
- visualize_isochrone_102100
- visualize_isochrone_900913
- visualize_isochrone_EPSG_4326
- visualize_isochrone_PLATE_CARREE
- visualize_isochrone_EPSG_900913
- visualize_isochrone_EPSG_102100
- visualize_isochrone_EPSG_3857
- visualize_isochrone_WEB_MERCATOR
- visualize_isochrone_width: When generateImage is set to true, width of the generated image. The default value is '512'.
- visualize_isochrone_height: When generateImage is set to true, height of the generated image. If the default value is used, the height is set to the value resulting from multiplying the aspect ratio by the width. The default value is '-1'.
- visualize_isochrone_search_radius: When interpolating the graph solution to generate the isochrone, neighborhood of influence of sample data (in percent of the image/grid). The default value is '20'.
- visualize_isochrone_grid_size: When interpolating the graph solution to generate the isochrone, number of subdivisions along the x axis when building the grid (the y is computed using the aspect ratio of the output image). The default value is '100'.
- visualize_isochrone_color_isolines: Color each isoline according to the colormap; otherwise, use the foreground color. Supported values: The default value is visualize_isochrone_true.
- visualize_isochrone_add_labels: If set to true, add labels to the isolines. Supported values: The default value is visualize_isochrone_false.
- visualize_isochrone_labels_font_size: When add_labels is set to true, size of the font (in pixels) to use for labels. The default value is '12'.
- visualize_isochrone_labels_font_family: When add_labels is set to true, font name to be used when adding labels. The default value is 'arial'.
- visualize_isochrone_labels_search_window: When add_labels is set to true, a search window is used to rate the local quality of each isoline. Smooth, continuous, long stretches with relatively flat angles are favored. The provided value is multiplied by the labels_font_size to calculate the final window size. The default value is '4'.
- visualize_isochrone_labels_intralevel_separation: When add_labels is set to true, this value determines the distance (in multiples of the labels_font_size) to use when separating labels of different values. The default value is '4'.
- visualize_isochrone_labels_interlevel_separation: When add_labels is set to true, this value determines the distance (in percent of the total window size) to use when separating labels of the same value. The default value is '20'.
- visualize_isochrone_labels_max_angle: When add_labels is set to true, maximum angle (in degrees) from the vertical to use when adding labels. The default value is '60'.
[in] options Additional parameters. - visualize_isochrone_solve_table: Name of the table to host intermediate solve results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will contain the position and cost for each vertex in the graph. If the default value is used, a temporary table is created and deleted once the solution is calculated. The default value is ''.
- visualize_isochrone_is_replicated: If set to true, replicate the solve_table. Supported values: The default value is visualize_isochrone_true.
- visualize_isochrone_data_min_x: Lower bound for the x values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_data_max_x: Upper bound for the x values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_data_min_y: Lower bound for the y values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_data_max_y: Upper bound for the y values. If not provided, it will be computed from the bounds of the input data.
- visualize_isochrone_concavity_level: Factor to qualify the concavity of the isochrone curves. The lower the value, the more convex (with '0' being completely convex and '1' being the most concave). The default value is '0.5'. The minimum allowed value is '0'. The maximum allowed value is '1'.
-
visualize_isochrone_use_priority_queue_solvers: sets the solver methods explicitly if true. Supported values:
- visualize_isochrone_true: uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on solve_direction
- visualize_isochrone_false: uses the solvers 'priority_queue' and 'inverse_priority_queue' based on solve_direction
-
visualize_isochrone_solve_direction: Specify whether we are going to the source node, or starting from it. Supported values:
- visualize_isochrone_from_source: Shortest path to get to the source (inverse Dijkstra)
- visualize_isochrone_to_source: Shortest path to source (Dijkstra)
[out] response_ Response object containing the results of the operation.
- Returns
- Response object containing the result of the operation (initially passed in by reference).
