This graph shows which files directly or indirectly include this file:

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

AdminShutdownResponse	adminShutdown (const AdminShutdownRequest &request_) const
	Exits the GPUdb server application. More...

AdminShutdownResponse &	adminShutdown (const AdminShutdownRequest &request_, AdminShutdownResponse &response_) const
	Exits the GPUdb server application. More...

AdminShutdownResponse	adminShutdown (const std::string &exitType, const std::string &authorization, const std::map< std::string, std::string > &options) const
	Exits the GPUdb 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 GPUdb server application. More...

AdminVerifyDbResponse	adminVerifyDb (const AdminVerifyDbRequest &request_) const
	Verify database is in a consistent state. More...

AdminVerifyDbResponse &	adminVerifyDb (const AdminVerifyDbRequest &request_, AdminVerifyDbResponse &response_) const
	Verify database is in a consistent state. More...

AdminVerifyDbResponse	adminVerifyDb (const std::map< std::string, std::string > &options) const
	Verify database is in a consistent state. More...

AdminVerifyDbResponse &	adminVerifyDb (const std::map< std::string, std::string > &options, AdminVerifyDbResponse &response_) const
	Verify database is in a consistent state. More...

AggregateConvexHullResponse	aggregateConvexHull (const AggregateConvexHullRequest &request_) const
	Calculates and returns the convex hull for the values in a table specified by tableName. More...

AggregateConvexHullResponse &	aggregateConvexHull (const AggregateConvexHullRequest &request_, AggregateConvexHullResponse &response_) const
	Calculates and returns the convex hull for the values in a table specified by tableName. More...

AggregateConvexHullResponse	aggregateConvexHull (const std::string &tableName, const std::string &xColumnName, const std::string &yColumnName, const std::map< std::string, std::string > &options) const
	Calculates and returns the convex hull for the values in a table specified by tableName. More...

AggregateConvexHullResponse &	aggregateConvexHull (const std::string &tableName, const std::string &xColumnName, const std::string &yColumnName, const std::map< std::string, std::string > &options, AggregateConvexHullResponse &response_) const
	Calculates and returns the convex hull for the values in a table specified by tableName. More...

RawAggregateGroupByResponse	aggregateGroupByRaw (const AggregateGroupByRequest &request_) const
	Calculates unique combinations (groups) of values for the given columns in a given table/view/collection 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/view/collection and computes aggregates on each unique combination. More...

AggregateGroupByResponse	aggregateGroupBy (const AggregateGroupByRequest &request_) const
	Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...

AggregateGroupByResponse &	aggregateGroupBy (const AggregateGroupByRequest &request_, AggregateGroupByResponse &response_) const
	Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...

AggregateGroupByResponse	aggregateGroupBy (const std::string &tableName, const std::vector< std::string > &columnNames, const int64_t offset, const int64_t limit, const std::map< std::string, std::string > &options) const
	Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. More...

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/view/collection and computes aggregates on each unique combination. More...

AggregateHistogramResponse	aggregateHistogram (const AggregateHistogramRequest &request_) const
	Performs a histogram calculation given a table, a column, and an interval function. More...

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

AggregateStatisticsResponse	aggregateStatistics (const AggregateStatisticsRequest &request_) const
	Calculates the requested statistics of a given column in a given table. More...

AggregateStatisticsResponse &	aggregateStatistics (const AggregateStatisticsRequest &request_, AggregateStatisticsResponse &response_) const
	Calculates the requested statistics of a given column 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 a given column 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 a given column 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 (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 (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 (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 (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 (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 (specified by tableName). More...

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

AlterSystemPropertiesResponse &	alterSystemProperties (const AlterSystemPropertiesRequest &request_, AlterSystemPropertiesResponse &response_) const
	The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb 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 alter_system_properties endpoint is primarily used to simplify the testing of GPUdb 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 alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution. More...

AlterTableResponse	alterTable (const AlterTableRequest &request_) const
	Apply various modifications to a table or collection. More...

AlterTableResponse &	alterTable (const AlterTableRequest &request_, AlterTableResponse &response_) const
	Apply various modifications to a table or collection. More...

AlterTableResponse	alterTable (const std::string &tableName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options) const
	Apply various modifications to a table or collection. More...

AlterTableResponse &	alterTable (const std::string &tableName, const std::string &action, const std::string &value, const std::map< std::string, std::string > &options, AlterTableResponse &response_) const
	Apply various modifications to a table or collection. 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...

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

ClearTableResponse	clearTable (const ClearTableRequest &request_) const
	Clears (drops) one or all tables in the GPUdb cluster. More...

ClearTableResponse &	clearTable (const ClearTableRequest &request_, ClearTableResponse &response_) const
	Clears (drops) one or all tables in the GPUdb 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 GPUdb 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 GPUdb cluster. More...

ClearTableMonitorResponse	clearTableMonitor (const ClearTableMonitorRequest &request_) const
	Deactivates a table monitor previously created with createTableMonitor(const CreateTableMonitorRequest&) const. More...

ClearTableMonitorResponse &	clearTableMonitor (const ClearTableMonitorRequest &request_, ClearTableMonitorResponse &response_) const
	Deactivates a table monitor previously created with createTableMonitor(const CreateTableMonitorRequest&,CreateTableMonitorResponse&) const. More...

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

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

ClearTriggerResponse	clearTrigger (const ClearTriggerRequest &request_) const
	Clears or cancels the trigger identified by the specified handle. More...

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

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 > &aliases, const std::string &expression, 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 > &aliases, const std::string &expression, 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...

CreateRoleResponse	createRole (const CreateRoleRequest &request_) const
	Creates a new role. More...

CreateRoleResponse &	createRole (const CreateRoleRequest &request_, CreateRoleResponse &response_) const
	Creates a new role. More...

CreateRoleResponse	createRole (const std::string &name, const std::map< std::string, std::string > &options) const
	Creates a new role. More...

CreateRoleResponse &	createRole (const std::string &name, const std::map< std::string, std::string > &options, CreateRoleResponse &response_) const
	Creates a new role. More...

CreateTableResponse	createTable (const CreateTableRequest &request_) const
	Creates a new table or collection in GPUdb. More...

CreateTableResponse &	createTable (const CreateTableRequest &request_, CreateTableResponse &response_) const
	Creates a new table or collection in GPUdb. More...

CreateTableResponse	createTable (const std::string &tableName, const std::string &typeId, const std::map< std::string, std::string > &options) const
	Creates a new table or collection in GPUdb. More...

CreateTableResponse &	createTable (const std::string &tableName, const std::string &typeId, const std::map< std::string, std::string > &options, CreateTableResponse &response_) const
	Creates a new table or collection in GPUdb. More...

CreateTableMonitorResponse	createTableMonitor (const CreateTableMonitorRequest &request_) const
	Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...

CreateTableMonitorResponse &	createTableMonitor (const CreateTableMonitorRequest &request_, CreateTableMonitorResponse &response_) const
	Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...

CreateTableMonitorResponse	createTableMonitor (const std::string &tableName, const std::map< std::string, std::string > &options) const
	Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. More...

CreateTableMonitorResponse &	createTableMonitor (const std::string &tableName, const std::map< std::string, std::string > &options, CreateTableMonitorResponse &response_) const
	Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. 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 in GPUdb describing the layout or schema of a table. More...

CreateTypeResponse &	createType (const CreateTypeRequest &request_, CreateTypeResponse &response_) const
	Creates a new type in GPUdb describing the layout or schema of a table. More...

CreateTypeResponse	createType (const std::string &typeDefinition, const std::string &label, const std::map< std::string, std::vector< std::string > > &properties, const std::map< std::string, std::string > &options) const
	Creates a new type in GPUdb describing the layout or schema of a table. More...

CreateTypeResponse &	createType (const std::string &typeDefinition, const std::string &label, const std::map< std::string, std::vector< std::string > > &properties, const std::map< std::string, std::string > &options, CreateTypeResponse &response_) const
	Creates a new type in GPUdb describing the layout or schema of a table. More...

CreateUnionResponse	createUnion (const CreateUnionRequest &request_) const
	Creates a table that is the concatenation of one or more existing tables. More...

CreateUnionResponse &	createUnion (const CreateUnionRequest &request_, CreateUnionResponse &response_) const
	Creates a table that is the concatenation of one or more existing tables. 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
	Creates a table that is the concatenation of one or more existing tables. 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
	Creates a table that is the concatenation of one or more existing tables. 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 GPUdb). More...

CreateUserInternalResponse &	createUserInternal (const CreateUserInternalRequest &request_, CreateUserInternalResponse &response_) const
	Creates a new internal user (a user whose credentials are managed by GPUdb). 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 GPUdb). 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 GPUdb). 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...

DeleteRoleResponse	deleteRole (const DeleteRoleRequest &request_) const
	Deletes an existing role. More...

DeleteRoleResponse &	deleteRole (const DeleteRoleRequest &request_, DeleteRoleResponse &response_) const
	Deletes an existing role. More...

DeleteRoleResponse	deleteRole (const std::string &name, const std::map< std::string, std::string > &options) const
	Deletes an existing role. More...

DeleteRoleResponse &	deleteRole (const std::string &name, const std::map< std::string, std::string > &options, DeleteRoleResponse &response_) const
	Deletes an existing role. More...

DeleteUserResponse	deleteUser (const DeleteUserRequest &request_) const
	Deletes an existing user. More...

DeleteUserResponse &	deleteUser (const DeleteUserRequest &request_, DeleteUserResponse &response_) const
	Deletes an existing user. More...

DeleteUserResponse	deleteUser (const std::string &name, const std::map< std::string, std::string > &options) const
	Deletes an existing user. More...

DeleteUserResponse &	deleteUser (const std::string &name, const std::map< std::string, std::string > &options, DeleteUserResponse &response_) const
	Deletes an existing user. More...

ExecuteProcResponse	executeProc (const ExecuteProcRequest &request_) const
	Executes a proc in the GPUdb Node.js proc server. More...

ExecuteProcResponse &	executeProc (const ExecuteProcRequest &request_, ExecuteProcResponse &response_) const
	Executes a proc in the GPUdb Node.js proc server. More...

ExecuteProcResponse	executeProc (const std::string &name, const std::map< std::string, std::string > &params, const std::map< std::string, std::vector< uint8_t > > &binParams, const std::map< std::string, std::string > &options) const
	Executes a proc in the GPUdb Node.js proc server. More...

ExecuteProcResponse &	executeProc (const std::string &name, const std::map< std::string, std::string > &params, const std::map< std::string, std::vector< uint8_t > > &binParams, const std::map< std::string, std::string > &options, ExecuteProcResponse &response_) const
	Executes a proc in the GPUdb Node.js proc server. 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...

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

FilterByGeometryResponse	filterByGeometry (const FilterByGeometryRequest &request_) const
	Applies a geometry filter against a spatial column named WKT in a given table, collection or view. More...

FilterByGeometryResponse &	filterByGeometry (const FilterByGeometryRequest &request_, FilterByGeometryResponse &response_) const
	Applies a geometry filter against a spatial column named WKT in a given table, collection or view. More...

FilterByGeometryResponse	filterByGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &inputWkt, const std::string &operation, const std::map< std::string, std::string > &options) const
	Applies a geometry filter against a spatial column named WKT in a given table, collection or view. More...

FilterByGeometryResponse &	filterByGeometry (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &inputWkt, const std::string &operation, const std::map< std::string, std::string > &options, FilterByGeometryResponse &response_) const
	Applies a geometry filter against a spatial column named WKT in a given table, collection or view. More...

FilterByListResponse	filterByList (const FilterByListRequest &request_) const
	Calculates which records from a table have values in the given list for the corresponding column. More...

FilterByListResponse &	filterByList (const FilterByListRequest &request_, FilterByListResponse &response_) const
	Calculates which records from a table have values in the given list for the corresponding column. More...

FilterByListResponse	filterByList (const std::string &tableName, const std::string &viewName, const std::map< std::string, std::vector< std::string > > &columnValuesMap, const std::map< std::string, std::string > &options) const
	Calculates which records from a table have values in the given list for the corresponding column. More...

FilterByListResponse &	filterByList (const std::string &tableName, const std::string &viewName, const std::map< std::string, std::vector< std::string > > &columnValuesMap, const std::map< std::string, std::string > &options, FilterByListResponse &response_) const
	Calculates which records from a table have values in the given list for the corresponding column. More...

FilterByRadiusResponse	filterByRadius (const FilterByRadiusRequest &request_) const
	Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...

FilterByRadiusResponse &	filterByRadius (const FilterByRadiusRequest &request_, FilterByRadiusResponse &response_) const
	Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...

FilterByRadiusResponse	filterByRadius (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double xCenter, const std::string &yColumnName, const double yCenter, const double radius, const std::map< std::string, std::string > &options) const
	Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...

FilterByRadiusResponse &	filterByRadius (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double xCenter, const std::string &yColumnName, const double yCenter, const double radius, const std::map< std::string, std::string > &options, FilterByRadiusResponse &response_) const
	Calculates which objects from a table lie within a circle with the given radius and center point (i.e. More...

FilterByRangeResponse	filterByRange (const FilterByRangeRequest &request_) const
	Calculates which objects from a table have a column that is within the given bounds. More...

FilterByRangeResponse &	filterByRange (const FilterByRangeRequest &request_, FilterByRangeResponse &response_) const
	Calculates which objects from a table have a column that is within the given bounds. More...

FilterByRangeResponse	filterByRange (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double lowerBound, const double upperBound, const std::map< std::string, std::string > &options) const
	Calculates which objects from a table have a column that is within the given bounds. More...

FilterByRangeResponse &	filterByRange (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double lowerBound, const double upperBound, const std::map< std::string, std::string > &options, FilterByRangeResponse &response_) const
	Calculates which objects from a table have a column that is within the given bounds. More...

FilterBySeriesResponse	filterBySeries (const FilterBySeriesRequest &request_) const
	Filters objects matching all points of the given track (works only on track type data). More...

FilterBySeriesResponse &	filterBySeries (const FilterBySeriesRequest &request_, FilterBySeriesResponse &response_) const
	Filters objects matching all points of the given track (works only on track type data). More...

FilterBySeriesResponse	filterBySeries (const std::string &tableName, const std::string &viewName, const std::string &trackId, const std::vector< std::string > &targetTrackIds, const std::map< std::string, std::string > &options) const
	Filters objects matching all points of the given track (works only on track type data). More...

FilterBySeriesResponse &	filterBySeries (const std::string &tableName, const std::string &viewName, const std::string &trackId, const std::vector< std::string > &targetTrackIds, const std::map< std::string, std::string > &options, FilterBySeriesResponse &response_) const
	Filters objects matching all points of the given track (works only on track type data). More...

FilterByStringResponse	filterByString (const FilterByStringRequest &request_) const
	Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...

FilterByStringResponse &	filterByString (const FilterByStringRequest &request_, FilterByStringResponse &response_) const
	Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...

FilterByStringResponse	filterByString (const std::string &tableName, const std::string &viewName, const std::string &expression, const std::string &mode, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options) const
	Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...

FilterByStringResponse &	filterByString (const std::string &tableName, const std::string &viewName, const std::string &expression, const std::string &mode, const std::vector< std::string > &columnNames, const std::map< std::string, std::string > &options, FilterByStringResponse &response_) const
	Calculates which objects from a table, collection, or view match a string expression for the given string columns. More...

FilterByTableResponse	filterByTable (const FilterByTableRequest &request_) const
	Filters objects in one table based on objects in another table. More...

FilterByTableResponse &	filterByTable (const FilterByTableRequest &request_, FilterByTableResponse &response_) const
	Filters objects in one table based on objects in another table. More...

FilterByTableResponse	filterByTable (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &sourceTableName, const std::string &sourceTableColumnName, const std::map< std::string, std::string > &options) const
	Filters objects in one table based on objects in another table. More...

FilterByTableResponse &	filterByTable (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &sourceTableName, const std::string &sourceTableColumnName, const std::map< std::string, std::string > &options, FilterByTableResponse &response_) const
	Filters objects in one table based on objects in another table. More...

FilterByValueResponse	filterByValue (const FilterByValueRequest &request_) const
	Calculates which objects from a table has a particular value for a particular column. More...

FilterByValueResponse &	filterByValue (const FilterByValueRequest &request_, FilterByValueResponse &response_) const
	Calculates which objects from a table has a particular value for a particular column. More...

FilterByValueResponse	filterByValue (const std::string &tableName, const std::string &viewName, const bool isString, const double value, const std::string &valueStr, const std::string &columnName, const std::map< std::string, std::string > &options) const
	Calculates which objects from a table has a particular value for a particular column. More...

FilterByValueResponse &	filterByValue (const std::string &tableName, const std::string &viewName, const bool isString, const double value, const std::string &valueStr, const std::string &columnName, const std::map< std::string, std::string > &options, FilterByValueResponse &response_) const
	Calculates which objects from a table has a particular value for a particular column. More...

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 of the given columns within a given range. More...

RawGetRecordsByColumnResponse &	getRecordsByColumnRaw (const GetRecordsByColumnRequest &request_, RawGetRecordsByColumnResponse &response_) const
	For a given table, retrieves the values of the given columns within a given range. More...

GetRecordsByColumnResponse	getRecordsByColumn (const GetRecordsByColumnRequest &request_) const
	For a given table, retrieves the values of the given columns within a given range. More...

GetRecordsByColumnResponse &	getRecordsByColumn (const GetRecordsByColumnRequest &request_, GetRecordsByColumnResponse &response_) const
	For a given table, retrieves the values of the given columns within a given range. 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 of the given columns within a given range. 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 of the given columns within a given range. 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...

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

HasTableResponse	hasTable (const HasTableRequest &request_) const
	Checks the existence of a table with the given name in GPUdb. More...

HasTableResponse &	hasTable (const HasTableRequest &request_, HasTableResponse &response_) const
	Checks the existence of a table with the given name in GPUdb. More...

HasTableResponse	hasTable (const std::string &tableName, const std::map< std::string, std::string > &options) const
	Checks the existence of a table with the given name in GPUdb. More...

HasTableResponse &	hasTable (const std::string &tableName, const std::map< std::string, std::string > &options, HasTableResponse &response_) const
	Checks the existence of a table with the given name in GPUdb. More...

HasTypeResponse	hasType (const HasTypeRequest &request_) const
	Check the existence of a type in GPUdb. More...

HasTypeResponse &	hasType (const HasTypeRequest &request_, HasTypeResponse &response_) const
	Check the existence of a type in GPUdb. More...

HasTypeResponse	hasType (const std::string &typeId, const std::map< std::string, std::string > &options) const
	Check the existence of a type in GPUdb. More...

HasTypeResponse &	hasType (const std::string &typeId, const std::map< std::string, std::string > &options, HasTypeResponse &response_) const
	Check the existence of a type in GPUdb. 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...

InsertRecordsRandomResponse	insertRecordsRandom (const InsertRecordsRandomRequest &request_) const
	Generates a specified number of random records and adds them to the given table. More...

InsertRecordsRandomResponse &	insertRecordsRandom (const InsertRecordsRandomRequest &request_, InsertRecordsRandomResponse &response_) const
	Generates a specified number of random records and adds them to the given table. More...

InsertRecordsRandomResponse	insertRecordsRandom (const std::string &tableName, const int64_t count, const std::map< std::string, std::map< std::string, double > > &options) const
	Generates a specified number of random records and adds them to the given table. More...

InsertRecordsRandomResponse &	insertRecordsRandom (const std::string &tableName, const int64_t count, const std::map< std::string, std::map< std::string, double > > &options, InsertRecordsRandomResponse &response_) const
	Generates a specified number of random records and adds them to the given table. More...

InsertSymbolResponse	insertSymbol (const InsertSymbolRequest &request_) const
	Adds a symbol or icon (i.e. More...

InsertSymbolResponse &	insertSymbol (const InsertSymbolRequest &request_, InsertSymbolResponse &response_) const
	Adds a symbol or icon (i.e. More...

InsertSymbolResponse	insertSymbol (const std::string &symbolId, const std::string &symbolFormat, const std::vector< uint8_t > &symbolData, const std::map< std::string, std::string > &options) const
	Adds a symbol or icon (i.e. More...

InsertSymbolResponse &	insertSymbol (const std::string &symbolId, const std::string &symbolFormat, const std::vector< uint8_t > &symbolData, const std::map< std::string, std::string > &options, InsertSymbolResponse &response_) const
	Adds a symbol or icon (i.e. More...

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

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

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

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 requests made to GPUdb along with the request timing and internal job id. More...

ShowSystemTimingResponse &	showSystemTiming (const ShowSystemTimingRequest &request_, ShowSystemTimingResponse &response_) const
	Returns the last 100 requests made to GPUdb 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 requests made to GPUdb 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 requests made to GPUdb along with the request timing and internal job id. More...

ShowTableResponse	showTable (const ShowTableRequest &request_) const
	Retrieves detailed information about a particular GPUdb table, specified in tableName. More...

ShowTableResponse &	showTable (const ShowTableRequest &request_, ShowTableResponse &response_) const
	Retrieves detailed information about a particular GPUdb table, specified in tableName. More...

ShowTableResponse	showTable (const std::string &tableName, const std::map< std::string, std::string > &options) const
	Retrieves detailed information about a particular GPUdb table, 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 particular GPUdb table, specified in tableName. More...

ShowTableMetadataResponse	showTableMetadata (const ShowTableMetadataRequest &request_) const
	Retrieves the user provided metadata for the specified tables. More...

ShowTableMetadataResponse &	showTableMetadata (const ShowTableMetadataRequest &request_, ShowTableMetadataResponse &response_) const
	Retrieves the user provided metadata for the specified tables. More...

ShowTableMetadataResponse	showTableMetadata (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options) const
	Retrieves the user provided metadata for the specified tables. More...

ShowTableMetadataResponse &	showTableMetadata (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &options, ShowTableMetadataResponse &response_) const
	Retrieves the user provided metadata for the specified tables. More...

ShowTablesByTypeResponse	showTablesByType (const ShowTablesByTypeRequest &request_) const
	Gets names of the tables from GPUdb based on the type information. More...

ShowTablesByTypeResponse &	showTablesByType (const ShowTablesByTypeRequest &request_, ShowTablesByTypeResponse &response_) const
	Gets names of the tables from GPUdb based on the type information. 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 from GPUdb based on the type information. 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 from GPUdb based on the type information. More...

ShowTriggersResponse	showTriggers (const ShowTriggersRequest &request_) const
	Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb. More...

ShowTriggersResponse &	showTriggers (const ShowTriggersRequest &request_, ShowTriggersResponse &response_) const
	Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb. 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 within GPUdb. 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 within GPUdb. More...

ShowTypesResponse	showTypes (const ShowTypesRequest &request_) const
	Retrieves information for the specified data type. More...

ShowTypesResponse &	showTypes (const ShowTypesRequest &request_, ShowTypesResponse &response_) const
	Retrieves information for the specified data type. 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. 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. 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, 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, 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...

VisualizeVideoResponse	visualizeVideo (const VisualizeVideoRequest &request_) const
	Creates raster images of data in the given table based on provided input parameters. More...

VisualizeVideoResponse &	visualizeVideo (const VisualizeVideoRequest &request_, VisualizeVideoResponse &response_) const
	Creates raster images of data in the given table based on provided input parameters. More...

VisualizeVideoResponse	visualizeVideo (const std::vector< std::string > &tableNames, const std::vector< std::string > &worldTableNames, const std::vector< std::vector< std::string > > &trackIds, const std::string &xColumnName, const std::string &yColumnName, const double minX, const double maxX, const double minY, const double maxY, const int32_t width, const int32_t height, const std::string &projection, const int64_t bgColor, const std::vector< std::vector< double > > &timeIntervals, const std::string &videoStyle, const std::string &sessionKey, const std::map< std::string, std::vector< std::string > > &styleOptions, const std::map< std::string, std::string > &options) const
	Creates raster images of data in the given table based on provided input parameters. More...

VisualizeVideoResponse &	visualizeVideo (const std::vector< std::string > &tableNames, const std::vector< std::string > &worldTableNames, const std::vector< std::vector< std::string > > &trackIds, const std::string &xColumnName, const std::string &yColumnName, const double minX, const double maxX, const double minY, const double maxY, const int32_t width, const int32_t height, const std::string &projection, const int64_t bgColor, const std::vector< std::vector< double > > &timeIntervals, const std::string &videoStyle, const std::string &sessionKey, const std::map< std::string, std::vector< std::string > > &styleOptions, const std::map< std::string, std::string > &options, VisualizeVideoResponse &response_) const
	Creates raster images of data in the given table based on provided input parameters. More...

Function Documentation

AdminOfflineResponse adminOffline ( const AdminOfflineRequest & request_ ) const

Take the system offline.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AdminOfflineResponse& adminOffline	(	const AdminOfflineRequest &	request_,
		AdminOfflineResponse &	response_
	)		const

Take the system offline.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Take the system offline.

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

Parameters

offline	Set to true if desired state is offline. Values: 'true', 'false'.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Take the system offline.

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

Parameters

	offline	Set to true if desired state is offline. Values: 'true', 'false'.
	options	Optional parameters. Default value is an empty std::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).

AdminShutdownResponse adminShutdown ( const AdminShutdownRequest & request_ ) const

Exits the GPUdb server application.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AdminShutdownResponse& adminShutdown	(	const AdminShutdownRequest &	request_,
		AdminShutdownResponse &	response_
	)		const

Exits the GPUdb server application.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Exits the GPUdb server application.

Parameters

exitType	Reserved for future use. User can pass an empty string.
authorization	No longer used. User can pass an empty string.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Exits the GPUdb server application.

Parameters

	exitType	Reserved for future use. User can pass an empty string.
	authorization	No longer used. User can pass an empty string.
	options	Optional parameters. Default value is an empty std::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).

AdminVerifyDbResponse adminVerifyDb ( const AdminVerifyDbRequest & request_ ) const

Verify database is in a consistent state.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AdminVerifyDbResponse& adminVerifyDb	(	const AdminVerifyDbRequest &	request_,
		AdminVerifyDbResponse &	response_
	)		const

Verify database is in a consistent state.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Verify database is in a consistent state.

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

Parameters

options Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Verify database is in a consistent state.

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

Parameters

	options	Optional parameters. Default value is an empty std::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).

AggregateConvexHullResponse aggregateConvexHull ( const AggregateConvexHullRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateConvexHullResponse& aggregateConvexHull	(	const AggregateConvexHullRequest &	request_,
		AggregateConvexHullResponse &	response_
	)		const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

Parameters

tableName	Name of Table on which the operation will be performed. Must be a valid table in GPUdb. It can not be a collection.
xColumnName	Name of the column containing the x coordinates of the points for the operation being performed.
yColumnName	Name of the column containing the y coordinates of the points for the operation being performed.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

Parameters

	tableName	Name of Table on which the operation will be performed. Must be a valid table in GPUdb. It can not be a collection.
	xColumnName	Name of the column containing the x coordinates of the points for the operation being performed.
	yColumnName	Name of the column containing the y coordinates of the points for the operation being performed.
	options	Optional parameters. Default value is an empty std::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).

AggregateGroupByResponse aggregateGroupBy ( const AggregateGroupByRequest & request_ ) const

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

This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. 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 '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'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateGroupByResponse& aggregateGroupBy	(	const AggregateGroupByRequest &	request_,
		AggregateGroupByResponse &	response_
	)		const

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

This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. 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 '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'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not 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).

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

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

This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. 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 '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'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

tableName	Name of the table on which the operation will be performed. Must be a valid table/view/collection in GPUdb.
columnNames	List of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 1000.
options	Optional parameters. expression: Filter expression to apply to the table prior to computing the aggregate group by. having: Filter expression to apply to the aggregated results. sort_order: String indicating how the returned values should be sorted - ascending or descending. Values: 'ascending', 'descending'. sort_by: String determining how the results are sorted. Values: 'key', 'value'. result_table: The name of the table used to store the results. If present no results are returned in the response. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. 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 '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'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

	tableName	Name of the table on which the operation will be performed. Must be a valid table/view/collection in GPUdb.
	columnNames	List of one or more column names, expressions, and aggregate expressions. Must include at least one 'grouping' column or expression. If no aggregate is included, count(*) will be computed as a default.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 1000.
	options	Optional parameters. expression: Filter expression to apply to the table prior to computing the aggregate group by. having: Filter expression to apply to the aggregated results. sort_order: String indicating how the returned values should be sorted - ascending or descending. Values: 'ascending', 'descending'. sort_by: String determining how the results are sorted. Values: 'key', 'value'. result_table: The name of the table used to store the results. If present no results are returned in the response. Default value is an empty std::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).

RawAggregateGroupByResponse aggregateGroupByRaw ( const AggregateGroupByRequest & request_ ) const

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

This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. 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 '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'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

RawAggregateGroupByResponse& aggregateGroupByRaw	(	const AggregateGroupByRequest &	request_,
		RawAggregateGroupByResponse &	response_
	)		const

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

This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. 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 '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'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not 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).

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 options. In this latter case the sum of the values corresponding to the value_column is used as the result instead.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateHistogramResponse& aggregateHistogram	(	const AggregateHistogramRequest &	request_,
		AggregateHistogramResponse &	response_
	)		const

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

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

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

Parameters

tableName	Name of the table on which the operation will be performed. Must be a valid table or collection in GPUdb.
columnName	Name of a column or an expression of one or more column names over which the histogram will be calculated.
start	Lower end value of the histogram interval, inclusive.
end	Upper end value of the histogram interval, inclusive.
interval	The size of each bin within the start and end parameters.
options	Optional parameters. value_column: The name of the column GPUdb will use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float). Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

Parameters

	tableName	Name of the table on which the operation will be performed. Must be a valid table or collection in GPUdb.
	columnName	Name of a column or an expression of one or more column names over which the histogram will be calculated.
	start	Lower end value of the histogram interval, inclusive.
	end	Upper end value of the histogram interval, inclusive.
	interval	The size of each bin within the start and end parameters.
	options	Optional parameters. value_column: The name of the column GPUdb will use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float). Default value is an empty std::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).

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.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateKMeansResponse& aggregateKMeans	(	const AggregateKMeansRequest &	request_,
		AggregateKMeansResponse &	response_
	)		const

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

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

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

Parameters

tableName	Name of the table on which the operation will be performed. Must be a valid table or collection in GPUdb.
columnNames	List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
k	The number of mean points to be determined by the algorithm.
tolerance	Stop iterating when the distances between successive points is less than the given tolerance.
options	Optional parameters. whiten: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten. max_iters: Number of times to try to hit the tolerance limit before giving up - default is 10. 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. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

Parameters

	tableName	Name of the table on which the operation will be performed. Must be a valid table or collection in GPUdb.
	columnNames	List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
	k	The number of mean points to be determined by the algorithm.
	tolerance	Stop iterating when the distances between successive points is less than the given tolerance.
	options	Optional parameters. whiten: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten. max_iters: Number of times to try to hit the tolerance limit before giving up - default is 10. 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. Default value is an empty std::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).

AggregateMinMaxResponse aggregateMinMax ( const AggregateMinMaxRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateMinMaxResponse& aggregateMinMax	(	const AggregateMinMaxRequest &	request_,
		AggregateMinMaxResponse &	response_
	)		const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

Parameters

tableName	Name of the table on which the operation will be performed. Must be a valid table in GPUdb.
columnName	Name of a column or an expression of one or more column on which the min-max will be calculated.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

Parameters

	tableName	Name of the table on which the operation will be performed. Must be a valid table in GPUdb.
	columnName	Name of a column or an expression of one or more column on which the min-max will be calculated.
	options	Optional parameters. Default value is an empty std::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).

AggregateStatisticsResponse aggregateStatistics ( const AggregateStatisticsRequest & request_ ) const

Calculates the requested statistics of a given column 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)').

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

The response includes a list of the statistics requested along with the count of the number of items in the given set.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateStatisticsResponse& aggregateStatistics	(	const AggregateStatisticsRequest &	request_,
		AggregateStatisticsResponse &	response_
	)		const

Calculates the requested statistics of a given column 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)').

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

The response includes a list of the statistics requested along with the count of the number of items in the given set.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Calculates the requested statistics of a given column 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)').

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

The response includes a list of the statistics requested along with the count of the number of items in the given set.

Parameters

tableName	Name of the table on which the statistics operation will be performed.
columnName	Name of the column for which the statistics are to be calculated.
stats	Comma separated list of the statistics to calculate, e.g. "sum,mean". Values: 'count', 'mean', 'stdv', 'variance', 'skew', 'kurtosis', 'sum', 'min', 'max', 'weighted_average', 'cardinality', 'estimated_cardinality', 'percentile', 'percentile_rank'.
options	Optional parameters. additional_column_names: A list of comma separated column names over which statistics can be accumulated along with the primary column. weight_column_name: Name of column used as weighting attribute for the weighted average statistic. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Calculates the requested statistics of a given column 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)').

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

The response includes a list of the statistics requested along with the count of the number of items in the given set.

Parameters

	tableName	Name of the table on which the statistics operation will be performed.
	columnName	Name of the column for which the statistics are to be calculated.
	stats	Comma separated list of the statistics to calculate, e.g. "sum,mean". Values: 'count', 'mean', 'stdv', 'variance', 'skew', 'kurtosis', 'sum', 'min', 'max', 'weighted_average', 'cardinality', 'estimated_cardinality', 'percentile', 'percentile_rank'.
	options	Optional parameters. additional_column_names: A list of comma separated column names over which statistics can be accumulated along with the primary column. weight_column_name: Name of column used as weighting attribute for the weighted average statistic. Default value is an empty std::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).

AggregateStatisticsByRangeResponse aggregateStatisticsByRange ( const AggregateStatisticsByRangeRequest & request_ ) const

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

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

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateStatisticsByRangeResponse& aggregateStatisticsByRange	(	const AggregateStatisticsByRangeRequest &	request_,
		AggregateStatisticsByRangeResponse &	response_
	)		const

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

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

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

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

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

Parameters

tableName	Name of the table on which the ranged-statistics operation will be performed.
selectExpression	For a non-empty expression statistics are calculated for those records for which the expression is true. Default value is an empty string.
columnName	Name of the binning-column used to divide the set samples into bins.
valueColumnName	Name of the value-column for which statistics are to be computed.
stats	A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
start	The lower bound of the binning-column.
end	The upper bound of the binning-column.
interval	The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval``i, start+interval``(i+1)).
options	Map of optional parameters: additional_column_names: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column. bin_values: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin. weight_column_name: Name of the column used as weighting column for the weighted_average statistic. order_column_name: Name of the column used for candlestick charting techniques. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

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

Parameters

	tableName	Name of the table on which the ranged-statistics operation will be performed.
	selectExpression	For a non-empty expression statistics are calculated for those records for which the expression is true. Default value is an empty string.
	columnName	Name of the binning-column used to divide the set samples into bins.
	valueColumnName	Name of the value-column for which statistics are to be computed.
	stats	A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
	start	The lower bound of the binning-column.
	end	The upper bound of the binning-column.
	interval	The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+interval``i, start+interval``(i+1)).
	options	Map of optional parameters: additional_column_names: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column. bin_values: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin. weight_column_name: Name of the column used as weighting column for the weighted_average statistic. order_column_name: Name of the column used for candlestick charting techniques. Default value is an empty std::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).

AggregateUniqueResponse aggregateUnique ( const AggregateUniqueRequest & request_ ) const

Returns all the unique values from a particular column (specified by columnName) of a particular table (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. offset and limit are used to page through the results if there are large numbers of unique values. 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 the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AggregateUniqueResponse& aggregateUnique	(	const AggregateUniqueRequest &	request_,
		AggregateUniqueResponse &	response_
	)		const

Returns all the unique values from a particular column (specified by columnName) of a particular table (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. offset and limit are used to page through the results if there are large numbers of unique values. 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 the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not 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).

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 (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. offset and limit are used to page through the results if there are large numbers of unique values. 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 the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

tableName	Name of the table on which the operation will be performed. Must be a valid table in GPUdb.
columnName	Name of the column or an expression containing one or more column names on which the unique function would be applied.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
options	Optional parameters. expression: Optional filter expression to apply to the table. sort_order: String indicating how the returned values should be sorted. Values: 'ascending', 'descending'. result_table: The name of the table used to store the results. If present no results are returned in the response. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Returns all the unique values from a particular column (specified by columnName) of a particular table (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. offset and limit are used to page through the results if there are large numbers of unique values. 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 the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

	tableName	Name of the table on which the operation will be performed. Must be a valid table in GPUdb.
	columnName	Name of the column or an expression containing one or more column names on which the unique function would be applied.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	Optional parameters. expression: Optional filter expression to apply to the table. sort_order: String indicating how the returned values should be sorted. Values: 'ascending', 'descending'. result_table: The name of the table used to store the results. If present no results are returned in the response. Default value is an empty std::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).

RawAggregateUniqueResponse aggregateUniqueRaw ( const AggregateUniqueRequest & request_ ) const

Returns all the unique values from a particular column (specified by columnName) of a particular table (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. offset and limit are used to page through the results if there are large numbers of unique values. 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 the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

RawAggregateUniqueResponse& aggregateUniqueRaw	(	const AggregateUniqueRequest &	request_,
		RawAggregateUniqueResponse &	response_
	)		const

Returns all the unique values from a particular column (specified by columnName) of a particular table (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. offset and limit are used to page through the results if there are large numbers of unique values. 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 the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not 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).

AlterSystemPropertiesResponse alterSystemProperties ( const AlterSystemPropertiesRequest & request_ ) const

The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AlterSystemPropertiesResponse& alterSystemProperties	(	const AlterSystemPropertiesRequest &	request_,
		AlterSystemPropertiesResponse &	response_
	)		const

The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution.

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

Parameters

propertyUpdatesMap

Map containing the properties of the system to be updated. Error if empty.

sm_omp_threads: Set the number of sm_omp_threads to the specified integer value.
kernel_omp_threads: Set the number of kernel_omp_threads to the specified integer value.
concurrent_kernel_execution: Enables concurrent kernel execution if the value is 'true' and disables it if the value is 'false'.
chunk_size: Sets the chunk size of all new sets to the specified integer value.
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 is ignored
clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored
communicator_test: Invoke the communicator test and report timing results. Value string is is a comma separated list of <key>=

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 of the messages to send in bytes; check_values = <enabled> where if enabled is true the value of the messages received are verified.
set_message_timers_enabled: Enables the communicator test to collect additional timing statistics when the value string is 'true'. Disables the collection when the value string is 'false'
bulk_add_test: Invoke the bulk_add test and report timing results. Value string is ignored.
network_speed: Invoke the network speed test and report timing results. Value string is a comma separated list of <key>=

expressions. Expressions are: seconds = <time> where time is the time in seconds to run the test; data_size = <size> where <size> is the size in bytes of the block to be transferred; threads = <number of="" threads>="">; to_ranks = <comma 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.
request_timeout: Number of minutes after which /filter/* and /aggregate/* queries will timeout.
max_get_records_size: set max_get_records_size. default 20000

options Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution.

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

Parameters

	propertyUpdatesMap	Map containing the properties of the system to be updated. Error if empty. sm_omp_threads: Set the number of sm_omp_threads to the specified integer value. kernel_omp_threads: Set the number of kernel_omp_threads to the specified integer value. concurrent_kernel_execution: Enables concurrent kernel execution if the value is 'true' and disables it if the value is 'false'. chunk_size: Sets the chunk size of all new sets to the specified integer value. 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 is ignored clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored communicator_test: Invoke the communicator test and report timing results. Value string is is a comma separated list of <key>= 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 of the messages to send in bytes; check_values = <enabled> where if enabled is true the value of the messages received are verified. set_message_timers_enabled: Enables the communicator test to collect additional timing statistics when the value string is 'true'. Disables the collection when the value string is 'false' bulk_add_test: Invoke the bulk_add test and report timing results. Value string is ignored. network_speed: Invoke the network speed test and report timing results. Value string is a comma separated list of <key>= expressions. Expressions are: seconds = <time> where time is the time in seconds to run the test; data_size = <size> where <size> is the size in bytes of the block to be transferred; threads = <number of="" threads>="">; to_ranks = <comma 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. request_timeout: Number of minutes after which /filter/* and /aggregate/* queries will timeout. max_get_records_size: set max_get_records_size. default 20000
	options	Optional parameters. Default value is an empty std::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).

AlterTableResponse alterTable ( const AlterTableRequest & request_ ) const

Apply various modifications to a table or collection.

Available modifications include:

Creating or deleting an index on a particular column. This can speed up certain search queries (such as getRecordsRaw(const GetRecordsRequest&) const, deleteRecords(const DeleteRecordsRequest&) const, updateRecordsRaw(const RawUpdateRecordsRequest&) const) when using expressions containing equality or relational operators on indexed columns. This only applies to child tables.

Making a table protected or not. Protected tables need the admin password to be sent in a clearTable(const ClearTableRequest&) const to delete the table. This can be applied to child tables or collections or views.

Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.

Allowing homogeneous child tables. This only applies to collections.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AlterTableResponse& alterTable	(	const AlterTableRequest &	request_,
		AlterTableResponse &	response_
	)		const

Apply various modifications to a table or collection.

Available modifications include:

Creating or deleting an index on a particular column. This can speed up certain search queries (such as getRecordsRaw(const GetRecordsRequest&,RawGetRecordsResponse&) const, deleteRecords(const DeleteRecordsRequest&,DeleteRecordsResponse&) const, updateRecordsRaw(const RawUpdateRecordsRequest&,UpdateRecordsResponse&) const) when using expressions containing equality or relational operators on indexed columns. This only applies to child tables.

Making a table protected or not. Protected tables need the admin password to be sent in a clearTable(const ClearTableRequest&,ClearTableResponse&) const to delete the table. This can be applied to child tables or collections or views.

Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.

Allowing homogeneous child tables. This only applies to collections.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Apply various modifications to a table or collection.

Available modifications include:

Creating or deleting an index on a particular column. This can speed up certain search queries (such as getRecordsRaw(const GetRecordsRequest&) const, deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const, updateRecordsRaw(const RawUpdateRecordsRequest&) const) when using expressions containing equality or relational operators on indexed columns. This only applies to child tables.

Making a table protected or not. Protected tables need the admin password to be sent in a clearTable(const std::string&,const std::string&,const std::map<std::string, std::string>&) const to delete the table. This can be applied to child tables or collections or views.

Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.

Allowing homogeneous child tables. This only applies to collections.

Parameters

tableName	Table on which the operation will be performed. Must be a valid table or collection in GPUdb.
action	Modification operation to be applied to the table or collection Values: 'create_index', 'delete_index', 'allow_homogeneous_tables', 'protected', 'ttl'.
value	The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Apply various modifications to a table or collection.

Available modifications include:

Creating or deleting an index on a particular column. This can speed up certain search queries (such as getRecordsRaw(const GetRecordsRequest&) const, deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&,DeleteRecordsResponse&) const, updateRecordsRaw(const RawUpdateRecordsRequest&) const) when using expressions containing equality or relational operators on indexed columns. This only applies to child tables.

Making a table protected or not. Protected tables need the admin password to be sent in a clearTable(const std::string&,const std::string&,const std::map<std::string, std::string>&,ClearTableResponse&) const to delete the table. This can be applied to child tables or collections or views.

Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.

Allowing homogeneous child tables. This only applies to collections.

Parameters

	tableName	Table on which the operation will be performed. Must be a valid table or collection in GPUdb.
	action	Modification operation to be applied to the table or collection Values: 'create_index', 'delete_index', 'allow_homogeneous_tables', 'protected', 'ttl'.
	value	The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action.
	options	Optional parameters. Default value is an empty std::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).

AlterTableMetadataResponse alterTableMetadata ( const AlterTableMetadataRequest & request_ ) const

Updates (adds or changes) metadata for tables.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AlterTableMetadataResponse& alterTableMetadata	(	const AlterTableMetadataRequest &	request_,
		AlterTableMetadataResponse &	response_
	)		const

Updates (adds or changes) metadata for tables.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Updates (adds or changes) metadata for tables.

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

Parameters

tableNames	Names of the tables whose metadata will be updated. All specified tables must exist in GPUdb, or GPUdb will return an error.
metadataMap	A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Updates (adds or changes) metadata for tables.

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

Parameters

	tableNames	Names of the tables whose metadata will be updated. All specified tables must exist in GPUdb, or GPUdb will return an error.
	metadataMap	A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
	options	Optional parameters. Default value is an empty std::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).

AlterUserResponse alterUser ( const AlterUserRequest & request_ ) const

Alters a user.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

AlterUserResponse& alterUser	(	const AlterUserRequest &	request_,
		AlterUserResponse &	response_
	)		const

Alters a user.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Alters a user.

Parameters

name	Name of the user to be altered. Must be an existing user.
action	Modification operation to be applied to the user. Values: 'set_password'.
value	The value of the modification, depending on action.
options	Optional parameters.

Returns: Response object containing the result of the operation.

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

Alters a user.

Parameters

	name	Name of the user to be altered. Must be an existing user.
	action	Modification operation to be applied to the user. Values: 'set_password'.
	value	The value of the modification, depending on action.
	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).

ClearTableResponse clearTable ( const ClearTableRequest & request_ ) const

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

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ClearTableResponse& clearTable	(	const ClearTableRequest &	request_,
		ClearTableResponse &	response_
	)		const

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

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Clears (drops) one or all tables in the GPUdb 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

tableName	Name of the table to be cleared. Must be an existing GPUdb table. Empty string clears all available tables in GPUdb. Default value is an empty string.
authorization	No longer used. User can pass an empty string. Default value is an empty string.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Clears (drops) one or all tables in the GPUdb 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

	tableName	Name of the table to be cleared. Must be an existing GPUdb table. Empty string clears all available tables in GPUdb. Default value is an empty string.
	authorization	No longer used. User can pass an empty string. Default value is an empty string.
	options	Optional parameters. Default value is an empty std::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).

ClearTableMonitorResponse clearTableMonitor ( const ClearTableMonitorRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ClearTableMonitorResponse& clearTableMonitor	(	const ClearTableMonitorRequest &	request_,
		ClearTableMonitorResponse &	response_
	)		const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

Parameters

topicId	The topic ID returned by /create/tablemonitor.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

Parameters

	topicId	The topic ID returned by /create/tablemonitor.
	options	Optional parameters. Default value is an empty std::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).

ClearTriggerResponse clearTrigger ( const ClearTriggerRequest & request_ ) const

Clears or cancels the trigger identified by the specified handle.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ClearTriggerResponse& clearTrigger	(	const ClearTriggerRequest &	request_,
		ClearTriggerResponse &	response_
	)		const

Clears or cancels the trigger identified by the specified handle.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Clears or cancels the trigger identified by the specified handle.

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

Parameters

triggerId	ID for the trigger to be deactivated.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Clears or cancels the trigger identified by the specified handle.

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

Parameters

	triggerId	ID for the trigger to be deactivated.
	options	Optional parameters. Default value is an empty std::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).

CreateJoinTableResponse createJoinTable ( const CreateJoinTableRequest & request_ ) const

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

For details see: join concept documentation.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateJoinTableResponse& createJoinTable	(	const CreateJoinTableRequest &	request_,
		CreateJoinTableResponse &	response_
	)		const

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

For details see: join concept 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).

CreateJoinTableResponse createJoinTable	(	const std::string &	joinTableName,
		const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	aliases,
		const std::string &	expression,
		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 details see: join concept documentation.

Parameters

joinTableName	Name of the join table to be created. Must not be the name of a currently existing GPUdb table or join table. Cannot be an empty string.
tableNames	The list of table names making up the joined set. Corresponds to a SQL statement FROM clause
aliases	The list of aliases for each of the corresponding tables.
expression	An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions. Default value is an empty string.
expressions	An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions. Default value is an empty std::vector.
options	Optional parameters. collection_name: Name of a collection in GPUdb to which the join table is to be assigned as a child table. If empty, then the join table will be a top level table. max_query_dimensions: The maximum number of tables in a joined table that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate optimize_lookups: Use the applied filters to precalculate the lookup table to get data from the primary key sets refresh_method: Method by which the join table can be refreshed when underlying member tables have changed. Values: 'manual', 'on_query', 'on_insert'. refresh: Do a manual refresh of the join table if it exists - throws an error otherwise Values: 'no_refresh', 'refresh', 'full_refresh'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

CreateJoinTableResponse& createJoinTable	(	const std::string &	joinTableName,
		const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	aliases,
		const std::string &	expression,
		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 details see: join concept documentation.

Parameters

	joinTableName	Name of the join table to be created. Must not be the name of a currently existing GPUdb table or join table. Cannot be an empty string.
	tableNames	The list of table names making up the joined set. Corresponds to a SQL statement FROM clause
	aliases	The list of aliases for each of the corresponding tables.
	expression	An optional expression GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions. Default value is an empty string.
	expressions	An optional list of expressions GPUdb uses to combine and filter the joined set. Corresponds to a SQL statement WHERE clause. For details see: expressions. Default value is an empty std::vector.
	options	Optional parameters. collection_name: Name of a collection in GPUdb to which the join table is to be assigned as a child table. If empty, then the join table will be a top level table. max_query_dimensions: The maximum number of tables in a joined table that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate optimize_lookups: Use the applied filters to precalculate the lookup table to get data from the primary key sets refresh_method: Method by which the join table can be refreshed when underlying member tables have changed. Values: 'manual', 'on_query', 'on_insert'. refresh: Do a manual refresh of the join table if it exists - throws an error otherwise Values: 'no_refresh', 'refresh', 'full_refresh'. Default value is an empty std::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).

CreateRoleResponse createRole ( const CreateRoleRequest & request_ ) const

Creates a new role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateRoleResponse& createRole	(	const CreateRoleRequest &	request_,
		CreateRoleResponse &	response_
	)		const

Creates a new role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Creates a new role.

Parameters

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 GPUdb.
options	Optional parameters.

Returns: Response object containing the result of the operation.

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

Creates a new role.

Parameters

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

CreateTableResponse createTable ( const CreateTableRequest & request_ ) const

Creates a new table or collection in GPUdb.

If a new table is being created then type of the table is given by typeId which must the be the type id of a currently registered type (i.e. one created via createType(const CreateTypeRequest&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist then it will be created. To create a new, empty collection specify the collection name in tableName, leave typeId blank, and set the is_collection option to 'true'.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateTableResponse& createTable	(	const CreateTableRequest &	request_,
		CreateTableResponse &	response_
	)		const

Creates a new table or collection in GPUdb.

If a new table is being created then type of the table is given by typeId which must the be the type id of a currently registered type (i.e. one created via createType(const CreateTypeRequest&,CreateTypeResponse&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist then it will be created. To create a new, empty collection specify the collection name in tableName, leave typeId blank, and set the is_collection option to 'true'.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Creates a new table or collection in GPUdb.

If a new table is being created then type of the table is given by typeId which must the be the type id of a currently registered type (i.e. one created via createType(const std::string&,const std::string&,const std::map<std::string, std::vector<std::string> >&,const std::map<std::string, std::string>&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist then it will be created. To create a new, empty collection specify the collection name in tableName, leave typeId blank, and set the is_collection option to 'true'.

Parameters

tableName	Name of the table to be created. Must not be the name of a currently existing GPUdb table of a different type. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. Cannot be an empty string. Valid characters are 'A-Za-z0-9_-(){}[] .:' (excluding the single quote), with the first character being one of 'A-Za-z0-9_'. The maximum length is 256 characters.
typeId	ID of a currently registered type in GPUdb. All objects added to the newly created table will be of this type. Must be an empty string if the is_collection is 'true'.
options	Optional parameters. 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. Values: 'true', 'false'. collection_name: Name of a collection in GPUdb to which the newly created table is to be assigned as a child table. If empty, then the newly created table will be a top level table. If the collection does not allow duplicate children, then this table creation request will fail if there is an existing child table with the same type id specified in this request. is_collection: Indicates whether the new table to be created will be a collection. If false, the created table will be a top level table. Values: 'true', 'false'. disallow_homogeneous_tables: For a collection, indicates whether multiple children of exactly the same data type will be allowed. Values: 'true', 'false'. is_replicated: For a Table, this is an indication to GPUdb to replicate the table to all the ranks. This is only required when the table will be used to join with other tables in a query. Values: 'true', 'false'. foreign_keys: Semicolon-separated list of foreign key constraints, of the format 'my_field references primary_table(primary_key_field)'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Creates a new table or collection in GPUdb.

If a new table is being created then type of the table is given by typeId which must the be the type id of a currently registered type (i.e. one created via createType(const std::string&,const std::string&,const std::map<std::string, std::vector<std::string> >&,const std::map<std::string, std::string>&,CreateTypeResponse&) const). The table will be created inside a collection if the option collection_name is specified. If that collection does not already exist then it will be created. To create a new, empty collection specify the collection name in tableName, leave typeId blank, and set the is_collection option to 'true'.

Parameters

	tableName	Name of the table to be created. Must not be the name of a currently existing GPUdb table of a different type. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. Cannot be an empty string. Valid characters are 'A-Za-z0-9_-(){}[] .:' (excluding the single quote), with the first character being one of 'A-Za-z0-9_'. The maximum length is 256 characters.
	typeId	ID of a currently registered type in GPUdb. All objects added to the newly created table will be of this type. Must be an empty string if the is_collection is 'true'.
	options	Optional parameters. 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. Values: 'true', 'false'. collection_name: Name of a collection in GPUdb to which the newly created table is to be assigned as a child table. If empty, then the newly created table will be a top level table. If the collection does not allow duplicate children, then this table creation request will fail if there is an existing child table with the same type id specified in this request. is_collection: Indicates whether the new table to be created will be a collection. If false, the created table will be a top level table. Values: 'true', 'false'. disallow_homogeneous_tables: For a collection, indicates whether multiple children of exactly the same data type will be allowed. Values: 'true', 'false'. is_replicated: For a Table, this is an indication to GPUdb to replicate the table to all the ranks. This is only required when the table will be used to join with other tables in a query. Values: 'true', 'false'. foreign_keys: Semicolon-separated list of foreign key constraints, of the format 'my_field references primary_table(primary_key_field)'. Default value is an empty std::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).

CreateTableMonitorResponse createTableMonitor ( const CreateTableMonitorRequest & request_ ) const

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

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateTableMonitorResponse& createTableMonitor	(	const CreateTableMonitorRequest &	request_,
		CreateTableMonitorResponse &	response_
	)		const

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

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

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

Parameters

tableName	Name of the table to monitor. Must not refer to a collection.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

Parameters

	tableName	Name of the table to monitor. Must not refer to a collection.
	options	Optional parameters. Default value is an empty std::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).

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(const CreateTriggerByRangeRequest&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(const ShowSystemStatusRequest&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&) const endpoint or by clearing all relevant tables.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

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(const CreateTriggerByRangeRequest&,CreateTriggerByRangeResponse&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&,InsertRecordsResponse&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(const ShowSystemStatusRequest&,ShowSystemStatusResponse&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&,ClearTriggerResponse&) const endpoint or by clearing all relevant tables.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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(const std::string&,const std::vector<std::string>&,const std::string&,const double,const double,const std::map<std::string, std::string>&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(const std::map<std::string, std::string>&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const std::string&,const std::map<std::string, std::string>&) const endpoint or by clearing all relevant tables.

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

Parameters

requestId	ID for the trigger to be activated.
tableNames	Names of the tables on which the trigger will be activated and maintained.
xColumnName	Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
xVector	The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
yColumnName	Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
yVector	The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

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

Parameters

	requestId	ID for the trigger to be activated.
	tableNames	Names of the tables on which the trigger will be activated and maintained.
	xColumnName	Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
	xVector	The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
	yColumnName	Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
	yVector	The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
	options	Optional parameters. Default value is an empty std::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).

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 insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(const ShowSystemStatusRequest&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&) const endpoint or by clearing all relevant tables.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

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 insertRecordsRaw(const RawInsertRecordsRequest&,InsertRecordsResponse&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(const ShowSystemStatusRequest&,ShowSystemStatusResponse&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&,ClearTriggerResponse&) const endpoint or by clearing all relevant tables.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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 insertRecordsRaw(const RawInsertRecordsRequest&) const with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained via showSystemStatus(const std::map<std::string, std::string>&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const std::string&,const std::map<std::string, std::string>&) const endpoint or by clearing all relevant tables.

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

Parameters

requestId	ID for the trigger request.
tableNames	Tables on which the trigger will be active.
columnName	Name of a numeric column_name on which the trigger is activated.
min	The lower bound (inclusive) for the trigger range.
max	The upper bound (inclusive) for the trigger range.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

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

Parameters

	requestId	ID for the trigger request.
	tableNames	Tables on which the trigger will be active.
	columnName	Name of a numeric column_name on which the trigger is activated.
	min	The lower bound (inclusive) for the trigger range.
	max	The upper bound (inclusive) for the trigger range.
	options	Optional parameters. Default value is an empty std::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).

CreateTypeResponse createType ( const CreateTypeRequest & request_ ) const

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

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

To set a primary key on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified then GPUdb enforces a uniqueness constraint in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

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

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

Properties::

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateTypeResponse& createType	(	const CreateTypeRequest &	request_,
		CreateTypeResponse &	response_
	)		const

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

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

To set a primary key on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified then GPUdb enforces a uniqueness constraint in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.

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

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

Properties::

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

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

To set a primary key on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified then GPUdb enforces a uniqueness constraint in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys 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

typeDefinition	a JSON string describing the columns of the type to be registered.
label	A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
properties	Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type). Default value is an empty std::map.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

To set a primary key on one or more columns include the property 'primary_key' on the desired column_names. If a primary key is specified then GPUdb enforces a uniqueness constraint in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary keys 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

	typeDefinition	a JSON string describing the columns of the type to be registered.
	label	A user-defined description string which can be used to differentiate between tables and types with otherwise identical schemas.
	properties	Each key-value pair specifies the properties to use for a given column where the key is the column name. All keys used must be relevant column names for the given table. Specifying any property overrides the default properties for that column (which is based on the column's data type). Default value is an empty std::map.
	options	Optional parameters. Default value is an empty std::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).

CreateUnionResponse createUnion ( const CreateUnionRequest & request_ ) const

Creates a table that is the concatenation of one or more existing tables.

It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateUnionResponse& createUnion	(	const CreateUnionRequest &	request_,
		CreateUnionResponse &	response_
	)		const

Creates a table that is the concatenation of one or more existing tables.

It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Creates a table that is the concatenation of one or more existing tables.

It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'.

Parameters

tableName	Name of the table to be created. Must not be the name of a currently existing GPUdb table. Cannot be an empty string.
tableNames	The list of table names making up the union. Must contain the names of one or more existing tables.
inputColumnNames	The list of columns from each of the corresponding input tables.
outputColumnNames	The list of names of the columns to be stored in the union.
options	Optional parameters. collection_name: Name of a collection in GPUdb to which the union is to be assigned as a child table. If empty, then the union will be a top level table. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

Creates a table that is the concatenation of one or more existing tables.

It is equivalent to the SQL UNION ALL operator. Non-charN 'string' and 'bytes' column types cannot be included in a union, neither can columns with the property 'store_only'.

Parameters

	tableName	Name of the table to be created. Must not be the name of a currently existing GPUdb table. Cannot be an empty string.
	tableNames	The list of table names making up the union. Must contain the names of one or more existing tables.
	inputColumnNames	The list of columns from each of the corresponding input tables.
	outputColumnNames	The list of names of the columns to be stored in the union.
	options	Optional parameters. collection_name: Name of a collection in GPUdb to which the union is to be assigned as a child table. If empty, then the union will be a top level table. Default value is an empty std::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).

CreateUserExternalResponse createUserExternal ( const CreateUserExternalRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateUserExternalResponse& createUserExternal	(	const CreateUserExternalRequest &	request_,
		CreateUserExternalResponse &	response_
	)		const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

Parameters

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 GPUdb.
options	Optional parameters.

Returns: Response object containing the result of the operation.

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

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

Parameters

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

CreateUserInternalResponse createUserInternal ( const CreateUserInternalRequest & request_ ) const

Creates a new internal user (a user whose credentials are managed by GPUdb).

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

CreateUserInternalResponse& createUserInternal	(	const CreateUserInternalRequest &	request_,
		CreateUserInternalResponse &	response_
	)		const

Creates a new internal user (a user whose credentials are managed by GPUdb).

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Parameters

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 GPUdb.
password	Initial password of the user to be created. May be an empty string for no password.
options	Optional parameters.

Returns: Response object containing the result of the operation.

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

Creates a new internal user (a user whose credentials are managed by GPUdb).

Parameters

	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 GPUdb.
	password	Initial password of the user to be created. May be an empty string for no password.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

DeleteRecordsResponse deleteRecords ( const DeleteRecordsRequest & request_ ) const

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

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

DeleteRecordsResponse& deleteRecords	(	const DeleteRecordsRequest &	request_,
		DeleteRecordsResponse &	response_
	)		const

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

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

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

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

Parameters

tableName	Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
expressions	A list of the actual predicates, one for each select; format should follow the guidelines provided /filter. Specifying one or more expressions is mutually exclusive to specifying record_id in the options.
options	Optional parameters. global_expression: An optional global expression to reduce the search space of the expressions. record_id: A record id identifying a single record, obtained at the time of /insert/records or by calling /get/records/fromcollection with the return_record_ids option. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

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

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

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

Parameters

	tableName	Name of the table from which to delete records. The set must be a currently existing table and not a collection or a view.
	expressions	A list of the actual predicates, one for each select; format should follow the guidelines provided /filter. Specifying one or more expressions is mutually exclusive to specifying record_id in the options.
	options	Optional parameters. global_expression: An optional global expression to reduce the search space of the expressions. record_id: A record id identifying a single record, obtained at the time of /insert/records or by calling /get/records/fromcollection with the return_record_ids option. Default value is an empty std::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).

DeleteRoleResponse deleteRole ( const DeleteRoleRequest & request_ ) const

Deletes an existing role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

DeleteRoleResponse& deleteRole	(	const DeleteRoleRequest &	request_,
		DeleteRoleResponse &	response_
	)		const

Deletes an existing role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

DeleteRoleResponse deleteRole	(	const std::string &	name,
		const std::map< std::string, std::string > &	options
	)		const

Deletes an existing role.

Parameters

name	Name of the role to be deleted. Must be an existing role.
options	Optional parameters.

Returns: Response object containing the result of the operation.

DeleteRoleResponse& deleteRole	(	const std::string &	name,
		const std::map< std::string, std::string > &	options,
		DeleteRoleResponse &	response_
	)		const

Deletes an existing role.

Parameters

	name	Name of the role to be deleted. Must be an existing role.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

DeleteUserResponse deleteUser ( const DeleteUserRequest & request_ ) const

Deletes an existing user.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

DeleteUserResponse& deleteUser	(	const DeleteUserRequest &	request_,
		DeleteUserResponse &	response_
	)		const

Deletes an existing user.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

DeleteUserResponse deleteUser	(	const std::string &	name,
		const std::map< std::string, std::string > &	options
	)		const

Deletes an existing user.

Parameters

name	Name of the user to be deleted. Must be an existing user.
options	Optional parameters.

Returns: Response object containing the result of the operation.

DeleteUserResponse& deleteUser	(	const std::string &	name,
		const std::map< std::string, std::string > &	options,
		DeleteUserResponse &	response_
	)		const

Deletes an existing user.

Parameters

	name	Name of the user to be deleted. Must be an existing user.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ExecuteProcResponse executeProc ( const ExecuteProcRequest & request_ ) const

Executes a proc in the GPUdb Node.js proc server.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ExecuteProcResponse& executeProc	(	const ExecuteProcRequest &	request_,
		ExecuteProcResponse &	response_
	)		const

Executes a proc in the GPUdb Node.js proc 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).

ExecuteProcResponse executeProc	(	const std::string &	name,
		const std::map< std::string, std::string > &	params,
		const std::map< std::string, std::vector< uint8_t > > &	binParams,
		const std::map< std::string, std::string > &	options
	)		const

Executes a proc in the GPUdb Node.js proc server.

Parameters

name	Name of the proc to execute.
params	A map containing string parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
binParams	A map containing binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ExecuteProcResponse& executeProc	(	const std::string &	name,
		const std::map< std::string, std::string > &	params,
		const std::map< std::string, std::vector< uint8_t > > &	binParams,
		const std::map< std::string, std::string > &	options,
		ExecuteProcResponse &	response_
	)		const

Executes a proc in the GPUdb Node.js proc server.

Parameters

	name	Name of the proc to execute.
	params	A map containing string parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
	binParams	A map containing binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value.
	options	Optional parameters. Default value is an empty std::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).

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

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterResponse& filter	(	const FilterRequest &	request_,
		FilterResponse &	response_
	)		const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see concepts.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterResponse filter	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	expression,
		const std::map< std::string, std::string > &	options
	)		const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see concepts.

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

tableName	Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view . Default value is an empty string.
expression	The select expression GPUdb uses to filter the specified table. For details see concepts.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterResponse& filter	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	expression,
		const std::map< std::string, std::string > &	options,
		FilterResponse &	response_
	)		const

Filters data based on the specified expression.

The results are stored in a result set with the given viewName.

For details see concepts.

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

	tableName	Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view . Default value is an empty string.
	expression	The select expression GPUdb uses to filter the specified table. For details see concepts.
	options	Optional parameters. Default value is an empty std::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).

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 GPUdb will not return the request until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByAreaResponse& filterByArea	(	const FilterByAreaRequest &	request_,
		FilterByAreaResponse &	response_
	)		const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous meaning that GPUdb will not return the request until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByAreaResponse filterByArea	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const std::vector< double > &	xVector,
		const std::string &	yColumnName,
		const std::vector< double > &	yVector,
		const std::map< std::string, std::string > &	options
	)		const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous meaning that GPUdb will not return the request 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

tableName	Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
xColumnName	Name of the column containing the x values to be filtered.
xVector	List of x coordinates of the vertices of the polygon representing the area to be filtered.
yColumnName	Name of the column containing the y values to be filtered.
yVector	List of y coordinates of the vertices of the polygon representing the area to be filtered.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByAreaResponse& filterByArea	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const std::vector< double > &	xVector,
		const std::string &	yColumnName,
		const std::vector< double > &	yVector,
		const std::map< std::string, std::string > &	options,
		FilterByAreaResponse &	response_
	)		const

Calculates which objects from a table are within a named area of interest (NAI/polygon).

The operation is synchronous meaning that GPUdb will not return the request 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

	tableName	Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	xColumnName	Name of the column containing the x values to be filtered.
	xVector	List of x coordinates of the vertices of the polygon representing the area to be filtered.
	yColumnName	Name of the column containing the y values to be filtered.
	yVector	List of y coordinates of the vertices of the polygon representing the area to be filtered.
	options	Optional parameters. Default value is an empty std::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).

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 GPUdb will not return the request until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByBoxResponse& filterByBox	(	const FilterByBoxRequest &	request_,
		FilterByBoxResponse &	response_
	)		const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous meaning that GPUdb will not return the request until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByBoxResponse filterByBox	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const double	minX,
		const double	maxX,
		const std::string &	yColumnName,
		const double	minY,
		const double	maxY,
		const std::map< std::string, std::string > &	options
	)		const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous meaning that GPUdb will not return the request 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

tableName	Name of the table on which the bounding box operation will be performed. Must be a valid table in GPUdb.
viewName	Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view in GPUdb. Default value is an empty string.
xColumnName	Name of the column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
minX	Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
maxX	Upper bound for xColumnName. Must be greater than or equal to minX.
yColumnName	Name of a column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
minY	Lower bound for yColumnName. Must be less than or equal to maxY.
maxY	Upper bound for yColumnName. Must be greater than or equal to minY.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByBoxResponse& filterByBox	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const double	minX,
		const double	maxX,
		const std::string &	yColumnName,
		const double	minY,
		const double	maxY,
		const std::map< std::string, std::string > &	options,
		FilterByBoxResponse &	response_
	)		const

Calculates how many objects within the given table lie in a rectangular box.

The operation is synchronous meaning that GPUdb will not return the request 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

	tableName	Name of the table on which the bounding box operation will be performed. Must be a valid table in GPUdb.
	viewName	Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view in GPUdb. Default value is an empty string.
	xColumnName	Name of the column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
	minX	Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
	maxX	Upper bound for xColumnName. Must be greater than or equal to minX.
	yColumnName	Name of a column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
	minY	Lower bound for yColumnName. Must be less than or equal to maxY.
	maxY	Upper bound for yColumnName. Must be greater than or equal to minY.
	options	Optional parameters. Default value is an empty std::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).

FilterByGeometryResponse filterByGeometry ( const FilterByGeometryRequest & request_ ) const

Applies a geometry filter against a spatial column named WKT in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByGeometryResponse& filterByGeometry	(	const FilterByGeometryRequest &	request_,
		FilterByGeometryResponse &	response_
	)		const

Applies a geometry filter against a spatial column named WKT in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByGeometryResponse filterByGeometry	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const std::string &	inputWkt,
		const std::string &	operation,
		const std::map< std::string, std::string > &	options
	)		const

Applies a geometry filter against a spatial column named WKT in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters

tableName	Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a column named WKT.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
columnName	Name of the column to be used in the filter. Must be 'WKT'
inputWkt	A geometry in WKT format that will be used to filter the objects in tableName. Default value is an empty string.
operation	The geometric filtering operation to perform Values: 'contains', 'crosses', 'disjoint', 'equals', 'intersects', 'overlaps', 'touches', 'within'.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByGeometryResponse& filterByGeometry	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const std::string &	inputWkt,
		const std::string &	operation,
		const std::map< std::string, std::string > &	options,
		FilterByGeometryResponse &	response_
	)		const

Applies a geometry filter against a spatial column named WKT in a given table, collection or view.

The filtering geometry is provided by inputWkt.

Parameters

	tableName	Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a column named WKT.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	columnName	Name of the column to be used in the filter. Must be 'WKT'
	inputWkt	A geometry in WKT format that will be used to filter the objects in tableName. Default value is an empty string.
	operation	The geometric filtering operation to perform Values: 'contains', 'crosses', 'disjoint', 'equals', 'intersects', 'overlaps', 'touches', 'within'.
	options	Optional parameters. Default value is an empty std::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).

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 GPUdb will not return a response 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 one of the values in the respective x- and y-lists. If the filter_mode option is set to 'not_in_list' then the filter will match all items that are not in the provided list(s).

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByListResponse& filterByList	(	const FilterByListRequest &	request_,
		FilterByListResponse &	response_
	)		const

Calculates which records from a table have values in the given list for the corresponding column.

The operation is synchronous meaning that GPUdb will not return a response 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 one of the values in the respective x- and y-lists. If the filter_mode option is set to 'not_in_list' then the filter will match all items that are not in the provided list(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).

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 GPUdb will not return a response 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 one of the values in the respective x- and y-lists. If the filter_mode option is set to 'not_in_list' then the filter will match all items that are not in the provided list(s).

Parameters

tableName	Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
columnValuesMap	List of values for the corresponding column in the table
options	Optional parameters. filter_mode: String indicating the filter mode, either 'in_list' or 'not_in_list'. Values: 'in_list', 'not_in_list'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByListResponse& filterByList	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::map< std::string, std::vector< std::string > > &	columnValuesMap,
		const std::map< std::string, std::string > &	options,
		FilterByListResponse &	response_
	)		const

Calculates which records from a table have values in the given list for the corresponding column.

The operation is synchronous meaning that GPUdb will not return a response 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 one of the values in the respective x- and y-lists. If the filter_mode option is set to 'not_in_list' then the filter will match all items that are not in the provided list(s).

Parameters

	tableName	Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	columnValuesMap	List of values for the corresponding column in the table
	options	Optional parameters. filter_mode: String indicating the filter mode, either 'in_list' or 'not_in_list'. Values: 'in_list', 'not_in_list'. Default value is an empty std::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).

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 GPUdb will not return a response 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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByRadiusResponse& filterByRadius	(	const FilterByRadiusRequest &	request_,
		FilterByRadiusResponse &	response_
	)		const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous meaning that GPUdb will not return a response 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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByRadiusResponse filterByRadius	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const double	xCenter,
		const std::string &	yColumnName,
		const double	yCenter,
		const double	radius,
		const std::map< std::string, std::string > &	options
	)		const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous meaning that GPUdb will not return a response 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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Parameters

tableName	Name of the table on which the filter by radius operation will be performed. Must be an existing table in GPUdb.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
xColumnName	Name of the column to be used for the x-coordinate (the longitude) of the center.
xCenter	Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
yColumnName	Name of the column to be used for the y-coordinate-the latitude-of the center.
yCenter	Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radius	The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByRadiusResponse& filterByRadius	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const double	xCenter,
		const std::string &	yColumnName,
		const double	yCenter,
		const double	radius,
		const std::map< std::string, std::string > &	options,
		FilterByRadiusResponse &	response_
	)		const

Calculates which objects from a table lie within a circle with the given radius and center point (i.e.

circular NAI). The operation is synchronous meaning that GPUdb will not return a response 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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Parameters

	tableName	Name of the table on which the filter by radius operation will be performed. Must be an existing table in GPUdb.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	xColumnName	Name of the column to be used for the x-coordinate (the longitude) of the center.
	xCenter	Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
	yColumnName	Name of the column to be used for the y-coordinate-the latitude-of the center.
	yCenter	Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
	radius	The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	options	Optional parameters. Default value is an empty std::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).

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.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByRangeResponse& filterByRange	(	const FilterByRangeRequest &	request_,
		FilterByRangeResponse &	response_
	)		const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByRangeResponse filterByRange	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const double	lowerBound,
		const double	upperBound,
		const std::map< std::string, std::string > &	options
	)		const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter.

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

tableName	Name of the table on which the filter by range operation will be performed. Must be a valid GPUdb table.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
columnName	Name of a column or an expression of one or more columns on which the operation would be applied.
lowerBound	Value of the lower bound (inclusive).
upperBound	Value of the upper bound (inclusive).
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByRangeResponse& filterByRange	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const double	lowerBound,
		const double	upperBound,
		const std::map< std::string, std::string > &	options,
		FilterByRangeResponse &	response_
	)		const

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter.

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

	tableName	Name of the table on which the filter by range operation will be performed. Must be a valid GPUdb table.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	columnName	Name of a column or an expression of one or more columns on which the operation would be applied.
	lowerBound	Value of the lower bound (inclusive).
	upperBound	Value of the upper bound (inclusive).
	options	Optional parameters. Default value is an empty std::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).

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 GPUdb will not return a response until all the objects are fully available.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterBySeriesResponse& filterBySeries	(	const FilterBySeriesRequest &	request_,
		FilterBySeriesResponse &	response_
	)		const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous meaning that GPUdb will not return a response until all the objects are fully available.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterBySeriesResponse filterBySeries	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	trackId,
		const std::vector< std::string > &	targetTrackIds,
		const std::map< std::string, std::string > &	options
	)		const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous meaning that GPUdb will not return a response until all the objects are fully available.

Parameters

tableName	Name of the table on which the filter by track operation will be performed. Must be a currently existing table with track semantic type.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
trackId	The ID of the track which will act as the filtering points. Must be an existing track within the given table.
targetTrackIds	Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
options	Optional parameters. 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. 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. 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'. Values: 'euclidean', 'great_circle'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterBySeriesResponse& filterBySeries	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	trackId,
		const std::vector< std::string > &	targetTrackIds,
		const std::map< std::string, std::string > &	options,
		FilterBySeriesResponse &	response_
	)		const

Filters objects matching all points of the given track (works only on track type data).

It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous meaning that GPUdb will not return a response until all the objects are fully available.

Parameters

	tableName	Name of the table on which the filter by track operation will be performed. Must be a currently existing table with track semantic type.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	trackId	The ID of the track which will act as the filtering points. Must be an existing track within the given table.
	targetTrackIds	Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
	options	Optional parameters. 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. 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. 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'. Values: 'euclidean', 'great_circle'. Default value is an empty std::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).

FilterByStringResponse filterByString ( const FilterByStringRequest & request_ ) const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The 'mode' may be:

search : full text search query with wildcards and boolean operators, e.g. '(bob* OR sue) AND NOT jane'. Note that for this mode, no column can be specified in columnNames; GPUdb will search through all string columns of the table that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with". Search query types:
- Multiple search terms ex. perfect union - will match any record containing "perfect", "union", or both.
- Exact phrases ex. "Perfect Union" - will only match the exact phrase "Perfect Union"
- Boolean (NOT, AND, OR, parentheses. OR assumed if no operator specified) ex. justice AND tranquility - will match only those records containing both justice and tranquility
- XOR (specified with -) ex. justice - peace - will match records containing "justice" or "peace", but not both
- Zero or more char wildcard - (specified with *) ex, est*is* - will match any records containing a word that starts with "est" and ends with "sh", such as "establish", "establishable", and "establishment"
- Exactly one char wildcard - (specified with ?) ex. est???is* - will only match strings that start with "est", followed by exactly three letters, followed by "is", followed by one more letter. This would only match "establish"
- Fuzzy search (term~) ex. rear~ will match rear,fear,bear,read,etc.
- Proximity - match two words within a specified distance of eachother ex. "Union Tranquility"~10 will match any record that has the words Union and Tranquility within 10 words of eachother
- Range - inclusive [<term1> TO <term2>] and exclusive {<term1> TO <term2>}. Note: This is a string search, so numbers will be seen as a string of numeric characters, not as a number. Ex. 2 > 123 ex. [100 TO 200] will find all strings between 100 and 200 inclusive. ex. {alpha to beta} will find all strings between alpha and beta, but not the words alpha or beta
- escaping special characters - Special characters are escaped with a backslash(), special characters are: + - && || ! ( ) { } [ ] ^ " ~ * ? : \
equals: exact whole-string match (accelerated)
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.
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.
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.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByStringResponse& filterByString	(	const FilterByStringRequest &	request_,
		FilterByStringResponse &	response_
	)		const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The 'mode' may be:

search : full text search query with wildcards and boolean operators, e.g. '(bob* OR sue) AND NOT jane'. Note that for this mode, no column can be specified in columnNames; GPUdb will search through all string columns of the table that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with". Search query types:
- Multiple search terms ex. perfect union - will match any record containing "perfect", "union", or both.
- Exact phrases ex. "Perfect Union" - will only match the exact phrase "Perfect Union"
- Boolean (NOT, AND, OR, parentheses. OR assumed if no operator specified) ex. justice AND tranquility - will match only those records containing both justice and tranquility
- XOR (specified with -) ex. justice - peace - will match records containing "justice" or "peace", but not both
- Zero or more char wildcard - (specified with *) ex, est*is* - will match any records containing a word that starts with "est" and ends with "sh", such as "establish", "establishable", and "establishment"
- Exactly one char wildcard - (specified with ?) ex. est???is* - will only match strings that start with "est", followed by exactly three letters, followed by "is", followed by one more letter. This would only match "establish"
- Fuzzy search (term~) ex. rear~ will match rear,fear,bear,read,etc.
- Proximity - match two words within a specified distance of eachother ex. "Union Tranquility"~10 will match any record that has the words Union and Tranquility within 10 words of eachother
- Range - inclusive [<term1> TO <term2>] and exclusive {<term1> TO <term2>}. Note: This is a string search, so numbers will be seen as a string of numeric characters, not as a number. Ex. 2 > 123 ex. [100 TO 200] will find all strings between 100 and 200 inclusive. ex. {alpha to beta} will find all strings between alpha and beta, but not the words alpha or beta
- escaping special characters - Special characters are escaped with a backslash(), special characters are: + - && || ! ( ) { } [ ] ^ " ~ * ? : \
equals: exact whole-string match (accelerated)
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.
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.
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.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByStringResponse filterByString	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	expression,
		const std::string &	mode,
		const std::vector< std::string > &	columnNames,
		const std::map< std::string, std::string > &	options
	)		const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The 'mode' may be:

search : full text search query with wildcards and boolean operators, e.g. '(bob* OR sue) AND NOT jane'. Note that for this mode, no column can be specified in columnNames; GPUdb will search through all string columns of the table that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with". Search query types:
- Multiple search terms ex. perfect union - will match any record containing "perfect", "union", or both.
- Exact phrases ex. "Perfect Union" - will only match the exact phrase "Perfect Union"
- Boolean (NOT, AND, OR, parentheses. OR assumed if no operator specified) ex. justice AND tranquility - will match only those records containing both justice and tranquility
- XOR (specified with -) ex. justice - peace - will match records containing "justice" or "peace", but not both
- Zero or more char wildcard - (specified with *) ex, est*is* - will match any records containing a word that starts with "est" and ends with "sh", such as "establish", "establishable", and "establishment"
- Exactly one char wildcard - (specified with ?) ex. est???is* - will only match strings that start with "est", followed by exactly three letters, followed by "is", followed by one more letter. This would only match "establish"
- Fuzzy search (term~) ex. rear~ will match rear,fear,bear,read,etc.
- Proximity - match two words within a specified distance of eachother ex. "Union Tranquility"~10 will match any record that has the words Union and Tranquility within 10 words of eachother
- Range - inclusive [<term1> TO <term2>] and exclusive {<term1> TO <term2>}. Note: This is a string search, so numbers will be seen as a string of numeric characters, not as a number. Ex. 2 > 123 ex. [100 TO 200] will find all strings between 100 and 200 inclusive. ex. {alpha to beta} will find all strings between alpha and beta, but not the words alpha or beta
- escaping special characters - Special characters are escaped with a backslash(), special characters are: + - && || ! ( ) { } [ ] ^ " ~ * ? : \
equals: exact whole-string match (accelerated)
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.
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.
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.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'

Parameters

tableName	Name of the table on which the filter operation will be performed. Must be a valid GPUdb table, collection or view.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
expression	The expression with which to filter the table.
mode	The string filtering mode to apply. See above for details. Values: 'search', 'equals', 'contains', 'starts_with', 'regex'.
columnNames	List of columns on which to apply the filter. Ignored for 'search' mode.
options	Optional parameters. case_sensitive: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Values: 'true', 'false'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByStringResponse& filterByString	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	expression,
		const std::string &	mode,
		const std::vector< std::string > &	columnNames,
		const std::map< std::string, std::string > &	options,
		FilterByStringResponse &	response_
	)		const

Calculates which objects from a table, collection, or view match a string expression for the given string columns.

The 'mode' may be:

search : full text search query with wildcards and boolean operators, e.g. '(bob* OR sue) AND NOT jane'. Note that for this mode, no column can be specified in columnNames; GPUdb will search through all string columns of the table that have text search enabled. Also, the first character of a search term cannot be a wildcard (* or ?), and search terms cannot be any of the following: "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with". Search query types:
- Multiple search terms ex. perfect union - will match any record containing "perfect", "union", or both.
- Exact phrases ex. "Perfect Union" - will only match the exact phrase "Perfect Union"
- Boolean (NOT, AND, OR, parentheses. OR assumed if no operator specified) ex. justice AND tranquility - will match only those records containing both justice and tranquility
- XOR (specified with -) ex. justice - peace - will match records containing "justice" or "peace", but not both
- Zero or more char wildcard - (specified with *) ex, est*is* - will match any records containing a word that starts with "est" and ends with "sh", such as "establish", "establishable", and "establishment"
- Exactly one char wildcard - (specified with ?) ex. est???is* - will only match strings that start with "est", followed by exactly three letters, followed by "is", followed by one more letter. This would only match "establish"
- Fuzzy search (term~) ex. rear~ will match rear,fear,bear,read,etc.
- Proximity - match two words within a specified distance of eachother ex. "Union Tranquility"~10 will match any record that has the words Union and Tranquility within 10 words of eachother
- Range - inclusive [<term1> TO <term2>] and exclusive {<term1> TO <term2>}. Note: This is a string search, so numbers will be seen as a string of numeric characters, not as a number. Ex. 2 > 123 ex. [100 TO 200] will find all strings between 100 and 200 inclusive. ex. {alpha to beta} will find all strings between alpha and beta, but not the words alpha or beta
- escaping special characters - Special characters are escaped with a backslash(), special characters are: + - && || ! ( ) { } [ ] ^ " ~ * ? : \
equals: exact whole-string match (accelerated)
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.
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.
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.

The options 'case_sensitive' can be used to modify the behavior for all modes except 'search'

Parameters

	tableName	Name of the table on which the filter operation will be performed. Must be a valid GPUdb table, collection or view.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	expression	The expression with which to filter the table.
	mode	The string filtering mode to apply. See above for details. Values: 'search', 'equals', 'contains', 'starts_with', 'regex'.
	columnNames	List of columns on which to apply the filter. Ignored for 'search' mode.
	options	Optional parameters. case_sensitive: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Values: 'true', 'false'. Default value is an empty std::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).

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 GPUdb will not return until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByTableResponse& filterByTable	(	const FilterByTableRequest &	request_,
		FilterByTableResponse &	response_
	)		const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that GPUdb will not return until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByTableResponse filterByTable	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const std::string &	sourceTableName,
		const std::string &	sourceTableColumnName,
		const std::map< std::string, std::string > &	options
	)		const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that GPUdb will not return 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

tableName	Name of the table whose data will be filtered. Must be an existing table in GPUdb.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
columnName	Name of the column by whose value the data will be filtered from the table designated by tableName.
sourceTableName	Name of the table whose data will be compared against in the table called tableName. Must be an existing table in GPUdb.
sourceTableColumnName	Name of the column in the sourceTableName whose values will be used as the filter for table tableName. Must match the type of the columnName.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByTableResponse& filterByTable	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	columnName,
		const std::string &	sourceTableName,
		const std::string &	sourceTableColumnName,
		const std::map< std::string, std::string > &	options,
		FilterByTableResponse &	response_
	)		const

Filters objects in one table based on objects in another table.

The user must specify matching column types from the two tables (i.e. the target table from which objects will be filtered and the source table based on which the filter will be created); the column names need not be the same. If a viewName is specified, then the filtered objects will then be put in a newly created view. The operation is synchronous, meaning that GPUdb will not return 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

	tableName	Name of the table whose data will be filtered. Must be an existing table in GPUdb.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	columnName	Name of the column by whose value the data will be filtered from the table designated by tableName.
	sourceTableName	Name of the table whose data will be compared against in the table called tableName. Must be an existing table in GPUdb.
	sourceTableColumnName	Name of the column in the sourceTableName whose values will be used as the filter for table tableName. Must match the type of the columnName.
	options	Optional parameters. Default value is an empty std::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).

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 GPUdb will not return a response 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.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

FilterByValueResponse& filterByValue	(	const FilterByValueRequest &	request_,
		FilterByValueResponse &	response_
	)		const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous meaning that GPUdb will not return a response 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.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

FilterByValueResponse filterByValue	(	const std::string &	tableName,
		const std::string &	viewName,
		const bool	isString,
		const double	value,
		const std::string &	valueStr,
		const std::string &	columnName,
		const std::map< std::string, std::string > &	options
	)		const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous meaning that GPUdb will not return a response 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.

Parameters

tableName	Name of an existing GPUdb table on which to perform the calculation.
viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
isString	Indicates whether the value being searched for is string or numeric.
value	The value to search for. Default value is 0.
valueStr	The string value to search for. Default value is an empty string.
columnName	Name of a column or an expression of one or more columns on which the filter by value would be applied.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

FilterByValueResponse& filterByValue	(	const std::string &	tableName,
		const std::string &	viewName,
		const bool	isString,
		const double	value,
		const std::string &	valueStr,
		const std::string &	columnName,
		const std::map< std::string, std::string > &	options,
		FilterByValueResponse &	response_
	)		const

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous meaning that GPUdb will not return a response 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.

Parameters

	tableName	Name of an existing GPUdb table on which to perform the calculation.
	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
	isString	Indicates whether the value being searched for is string or numeric.
	value	The value to search for. Default value is 0.
	valueStr	The string value to search for. Default value is an empty string.
	columnName	Name of a column or an expression of one or more columns on which the filter by value would be applied.
	options	Optional parameters. Default value is an empty std::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).

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 only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 5674 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse>& getRecords	(	const GetRecordsRequest &	request_,
		GetRecordsResponse< TResponse > &	response_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 5717 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse> getRecords	(	const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

tableName	Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 5776 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse>& getRecords	(	const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsResponse< TResponse > &	response_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

	tableName	Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::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 5846 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse> getRecords	(	const ::avro::ValidSchema &	schema_,
		const GetRecordsRequest &	request_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 5895 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse> getRecords	(	const Type &	type_,
		const GetRecordsRequest &	request_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 5937 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse>& getRecords	(	const ::avro::ValidSchema &	schema_,
		const GetRecordsRequest &	request_,
		GetRecordsResponse< TResponse > &	response_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 5982 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse>& getRecords	(	const Type &	type_,
		const GetRecordsRequest &	request_,
		GetRecordsResponse< TResponse > &	response_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 6027 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse> getRecords	(	const ::avro::ValidSchema &	schema_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
	tableName	Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 6088 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse> getRecords	(	const Type &	type_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
	tableName	Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 6157 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse>& getRecords	(	const ::avro::ValidSchema &	schema_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsResponse< TResponse > &	response_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
	tableName	Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::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 6229 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsResponse<TResponse>& getRecords	(	const Type &	type_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsResponse< TResponse > &	response_
	)		const

Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.

This operation can only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
	tableName	Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::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 6301 of file GPUdbFunctions.hpp.

GetRecordsByColumnResponse getRecordsByColumn ( const GetRecordsByColumnRequest & request_ ) const

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset

limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

GetRecordsByColumnResponse& getRecordsByColumn	(	const GetRecordsByColumnRequest &	request_,
		GetRecordsByColumnResponse &	response_
	)		const

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset

limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

GetRecordsByColumnResponse getRecordsByColumn	(	const std::string &	tableName,
		const std::vector< std::string > &	columnNames,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset

limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

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

Parameters

tableName	Name of the table on which this operation will be performed. The table cannot be a parent set.
columnNames	The list of column values to retrieve. Columns annotated as store only cannot be retrieved.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned (if not provided the default is 10000). Or END_OF_column (-9999) to indicate that the max number of results should be returned.
options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Default is 'ascending'. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

GetRecordsByColumnResponse& getRecordsByColumn	(	const std::string &	tableName,
		const std::vector< std::string > &	columnNames,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsByColumnResponse &	response_
	)		const

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset

limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

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

Parameters

	tableName	Name of the table on which this operation will be performed. The table cannot be a parent set.
	columnNames	The list of column values to retrieve. Columns annotated as store only cannot be retrieved.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned (if not provided the default is 10000). Or END_OF_column (-9999) to indicate that the max number of results should be returned.
	options	expression: Optional filter expression to apply to the table. sort_by: Optional column that the data should be sorted by. Empty by default (i.e. no sorting is applied). sort_order: String indicating how the returned values should be sorted - ascending or descending. Default is 'ascending'. Ignored if 'sort_by' option is not specified. Values: 'ascending', 'descending'. Default value is an empty std::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).

RawGetRecordsByColumnResponse getRecordsByColumnRaw ( const GetRecordsByColumnRequest & request_ ) const

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset

limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

RawGetRecordsByColumnResponse& getRecordsByColumnRaw	(	const GetRecordsByColumnRequest &	request_,
		RawGetRecordsByColumnResponse &	response_
	)		const

For a given table, retrieves the values of the given columns within a given range.

It returns maps of column name to the vector of values for each supported data type (double, float, long, int and string). This operation supports pagination feature, i.e. values that are retrieved are those associated with the indices between the start (offset) and end value (offset

limit) parameters (inclusive). If there are num_points values in the table then each of the indices between 0 and num_points-1 retrieves a unique value.

Note that when using the pagination feature, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records or values retrieved may differ between calls (discontiguous or overlap) based on the type of the update.

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse> getRecordsBySeries ( const GetRecordsBySeriesRequest & request_ ) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 6628 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries	(	const GetRecordsBySeriesRequest &	request_,
		GetRecordsBySeriesResponse< TResponse > &	response_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const GetRecordsRequest&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 6674 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse> getRecordsBySeries	(	const std::string &	tableName,
		const std::string &	worldTableName,
		const int32_t	offset,
		const int32_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

tableName	Name of the collection/table/view for which series/tracks will be fetched.
worldTableName	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
offset	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 6733 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries	(	const std::string &	tableName,
		const std::string &	worldTableName,
		const int32_t	offset,
		const int32_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsBySeriesResponse< TResponse > &	response_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

	tableName	Name of the collection/table/view for which series/tracks will be fetched.
	worldTableName	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
	offset	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	Optional parameters. Default value is an empty std::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 6805 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse> getRecordsBySeries	(	const ::avro::ValidSchema &	schema_,
		const GetRecordsBySeriesRequest &	request_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const ::avro::ValidSchema&,const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 6859 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse> getRecordsBySeries	(	const Type &	type_,
		const GetRecordsBySeriesRequest &	request_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const Type&,const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 6903 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries	(	const ::avro::ValidSchema &	schema_,
		const GetRecordsBySeriesRequest &	request_,
		GetRecordsBySeriesResponse< TResponse > &	response_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const ::avro::ValidSchema&,const GetRecordsRequest&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 6951 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries	(	const Type &	type_,
		const GetRecordsBySeriesRequest &	request_,
		GetRecordsBySeriesResponse< TResponse > &	response_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const Type&,const GetRecordsRequest&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 6999 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse> getRecordsBySeries	(	const ::avro::ValidSchema &	schema_,
		const std::string &	tableName,
		const std::string &	worldTableName,
		const int32_t	offset,
		const int32_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const ::avro::ValidSchema&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
	tableName	Name of the collection/table/view for which series/tracks will be fetched.
	worldTableName	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
	offset	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 7060 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse> getRecordsBySeries	(	const Type &	type_,
		const std::string &	tableName,
		const std::string &	worldTableName,
		const int32_t	offset,
		const int32_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const Type&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
	tableName	Name of the collection/table/view for which series/tracks will be fetched.
	worldTableName	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
	offset	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 7131 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries	(	const ::avro::ValidSchema &	schema_,
		const std::string &	tableName,
		const std::string &	worldTableName,
		const int32_t	offset,
		const int32_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsBySeriesResponse< TResponse > &	response_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const ::avro::ValidSchema&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
	tableName	Name of the collection/table/view for which series/tracks will be fetched.
	worldTableName	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
	offset	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	Optional parameters. Default value is an empty std::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 7205 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsBySeriesResponse<TResponse>& getRecordsBySeries	(	const Type &	type_,
		const std::string &	tableName,
		const std::string &	worldTableName,
		const int32_t	offset,
		const int32_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsBySeriesResponse< TResponse > &	response_
	)		const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecords(const Type&,const std::string&,const int64_t,const int64_t,const std::map<std::string, std::string>&,GetRecordsResponse<TResponse>&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
	tableName	Name of the collection/table/view for which series/tracks will be fetched.
	worldTableName	Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
	offset	A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	Optional parameters. Default value is an empty std::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 7279 of file GPUdbFunctions.hpp.

RawGetRecordsBySeriesResponse getRecordsBySeriesRaw ( const GetRecordsBySeriesRequest & request_ ) const

Retrieves the complete series/track records from the given worldTableName based on the partial track information contained in the tableName.

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

In contrast to getRecordsRaw(const GetRecordsRequest&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

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(const GetRecordsRequest&,RawGetRecordsResponse&) const this returns records grouped by series/track. So if offset is 0 and limit is 5 this operation would return the first 5 series/tracks in tableName. Each series/track will be returned sorted by their TIMESTAMP column.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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(const DeleteRecordsRequest&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 7374 of file GPUdbFunctions.hpp.

template<typename TResponse >

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

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&,DeleteRecordsResponse&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 7411 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection	(	const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

tableName	Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 7460 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection	(	const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsFromCollectionResponse< TResponse > &	response_
	)		const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&,DeleteRecordsResponse&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

	tableName	Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::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 7520 of file GPUdbFunctions.hpp.

template<typename TResponse >

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

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 7563 of file GPUdbFunctions.hpp.

template<typename TResponse >

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

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

Definition at line 7599 of file GPUdbFunctions.hpp.

template<typename TResponse >

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

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 7638 of file GPUdbFunctions.hpp.

template<typename TResponse >

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

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

Definition at line 7677 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection	(	const ::avro::ValidSchema &	schema_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
	tableName	Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 7728 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection	(	const Type &	type_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
	tableName	Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 7787 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection	(	const ::avro::ValidSchema &	schema_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsFromCollectionResponse< TResponse > &	response_
	)		const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	schema_	Avro schema object used for decoding returned objects.
	tableName	Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::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 7849 of file GPUdbFunctions.hpp.

template<typename TResponse >

GetRecordsFromCollectionResponse<TResponse>& getRecordsFromCollection	(	const Type &	type_,
		const std::string &	tableName,
		const int64_t	offset,
		const int64_t	limit,
		const std::map< std::string, std::string > &	options,
		GetRecordsFromCollectionResponse< TResponse > &	response_
	)		const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const std::string&,const std::vector<std::string>&,const std::map<std::string, std::string>&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Template Parameters

<TResponse> The type of object being retrieved.

Parameters

[in]	type_	Type object used for decoding returned objects.
	tableName	Name of the collection or table from which records are to be retrieved. Must be an existing GPUdb collection or table.
	offset	A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). Default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
	limit	A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. Default value is 10000.
	options	return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: 'true', 'false'. Default value is an empty std::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 7911 of file GPUdbFunctions.hpp.

RawGetRecordsFromCollectionResponse getRecordsFromCollectionRaw ( const GetRecordsFromCollectionRequest & request_ ) const

Retrieves records from a collection.

The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(const DeleteRecordsRequest&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

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(const DeleteRecordsRequest&,DeleteRecordsResponse&) const.

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

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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 only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

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 only be performed on tables or on homogeneous collection (collections whose children all have the same type). Records can be returned encoded as binary or json.

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.

Note that when using the Java API, it is not possible to retrieve records from join tables using this operation.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

GrantPermissionSystemResponse grantPermissionSystem ( const GrantPermissionSystemRequest & request_ ) const

Grants a system-level permission to a user or role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

GrantPermissionSystemResponse& grantPermissionSystem	(	const GrantPermissionSystemRequest &	request_,
		GrantPermissionSystemResponse &	response_
	)		const

Grants a system-level permission to a user or role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

GrantPermissionSystemResponse grantPermissionSystem	(	const std::string &	name,
		const std::string &	permission,
		const std::map< std::string, std::string > &	options
	)		const

Grants a system-level permission to a user or role.

Parameters

name	Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission	Permission to grant to the user or role. Values: 'system_admin', 'system_write', 'system_read'.
options	Optional parameters.

Returns: Response object containing the result of the operation.

GrantPermissionSystemResponse& grantPermissionSystem	(	const std::string &	name,
		const std::string &	permission,
		const std::map< std::string, std::string > &	options,
		GrantPermissionSystemResponse &	response_
	)		const

Grants a system-level permission to a user or role.

Parameters

	name	Name of the user or role to which the permission will be granted. Must be an existing user or role.
	permission	Permission to grant to the user or role. Values: 'system_admin', 'system_write', 'system_read'.
	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).

GrantPermissionTableResponse grantPermissionTable ( const GrantPermissionTableRequest & request_ ) const

Grants a table-level permission to a user or role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

GrantPermissionTableResponse& grantPermissionTable	(	const GrantPermissionTableRequest &	request_,
		GrantPermissionTableResponse &	response_
	)		const

Grants a table-level permission to a user or role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

GrantPermissionTableResponse grantPermissionTable	(	const std::string &	name,
		const std::string &	permission,
		const std::string &	tableName,
		const std::string &	filterExpression,
		const std::map< std::string, std::string > &	options
	)		const

Grants a table-level permission to a user or role.

Parameters

name	Name of the user or role to which the permission will be granted. Must be an existing user or role.
permission	Permission to grant to the user or role. Values: 'table_admin', 'table_insert', 'table_update', 'table_delete', 'table_read'.
tableName	Name of the table to which the permission grants access. Must be an existing table, collection, or view. If a collection, the permission also applies to tables and views in the collection.
filterExpression	Reserved for future use. Default value is an empty string.
options	Optional parameters.

Returns: Response object containing the result of the operation.

GrantPermissionTableResponse& grantPermissionTable	(	const std::string &	name,
		const std::string &	permission,
		const std::string &	tableName,
		const std::string &	filterExpression,
		const std::map< std::string, std::string > &	options,
		GrantPermissionTableResponse &	response_
	)		const

Grants a table-level permission to a user or role.

Parameters

	name	Name of the user or role to which the permission will be granted. Must be an existing user or role.
	permission	Permission to grant to the user or role. Values: 'table_admin', 'table_insert', 'table_update', 'table_delete', 'table_read'.
	tableName	Name of the table to which the permission grants access. Must be an existing table, collection, or view. If a collection, the permission also applies to tables and views in the collection.
	filterExpression	Reserved for future use. Default value is an empty string.
	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).

GrantRoleResponse grantRole ( const GrantRoleRequest & request_ ) const

Grants membership in a role to a user or role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

GrantRoleResponse& grantRole	(	const GrantRoleRequest &	request_,
		GrantRoleResponse &	response_
	)		const

Grants membership in a role to a user or role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

GrantRoleResponse grantRole	(	const std::string &	role,
		const std::string &	member,
		const std::map< std::string, std::string > &	options
	)		const

Grants membership in a role to a user or role.

Parameters

role	Name of the role in which membership will be granted. Must be an existing role.
member	Name of the user or role that will be granted membership in role. Must be an existing user or role.
options	Optional parameters.

Returns: Response object containing the result of the operation.

GrantRoleResponse& grantRole	(	const std::string &	role,
		const std::string &	member,
		const std::map< std::string, std::string > &	options,
		GrantRoleResponse &	response_
	)		const

Grants membership in a role to a user or role.

Parameters

	role	Name of the role in which membership will be granted. Must be an existing role.
	member	Name of the user or role that will be granted membership in role. Must be an existing user or role.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

HasTableResponse hasTable ( const HasTableRequest & request_ ) const

Checks the existence of a table with the given name in GPUdb.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

HasTableResponse& hasTable	(	const HasTableRequest &	request_,
		HasTableResponse &	response_
	)		const

Checks the existence of a table with the given name in GPUdb.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

HasTableResponse hasTable	(	const std::string &	tableName,
		const std::map< std::string, std::string > &	options
	)		const

Checks the existence of a table with the given name in GPUdb.

Parameters

tableName	Name of the table to check for existence.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

HasTableResponse& hasTable	(	const std::string &	tableName,
		const std::map< std::string, std::string > &	options,
		HasTableResponse &	response_
	)		const

Checks the existence of a table with the given name in GPUdb.

Parameters

	tableName	Name of the table to check for existence.
	options	Optional parameters. Default value is an empty std::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).

HasTypeResponse hasType ( const HasTypeRequest & request_ ) const

Check the existence of a type in GPUdb.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

HasTypeResponse& hasType	(	const HasTypeRequest &	request_,
		HasTypeResponse &	response_
	)		const

Check the existence of a type in GPUdb.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

HasTypeResponse hasType	(	const std::string &	typeId,
		const std::map< std::string, std::string > &	options
	)		const

Check the existence of a type in GPUdb.

Parameters

typeId	Id of the type returned by GPUdb in response to /create/type request.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

HasTypeResponse& hasType	(	const std::string &	typeId,
		const std::map< std::string, std::string > &	options,
		HasTypeResponse &	response_
	)		const

Check the existence of a type in GPUdb.

Parameters

	typeId	Id of the type returned by GPUdb in response to /create/type request.
	options	Optional parameters. Default value is an empty std::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).

template<typename TRequest >

InsertRecordsResponse insertRecords ( const InsertRecordsRequest< TRequest > & request_ ) const

Adds multiple records to the specified table.

The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored.

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

template<typename TRequest >

InsertRecordsResponse& insertRecords	(	const InsertRecordsRequest< TRequest > &	request_,
		InsertRecordsResponse &	response_
	)		const

Adds multiple records to the specified table.

The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored.

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

template<typename TRequest >

InsertRecordsResponse insertRecords	(	const std::string &	tableName,
		const std::vector< TRequest > &	data,
		const std::map< std::string, std::string > &	options
	)		const

Adds multiple records to the specified table.

The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored.

Template Parameters

<TRequest> The type of object being added.

Parameters

tableName	Table to which the records are to be added. Must be an existing table.
data	An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.
options	Optional parameters. update_on_existing_pk: If the table has a /create/type, then if the value is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If 'false' and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then this optional parameter is ignored. Values: 'true', 'false'. return_record_ids: If 'true' then return GPUdb's internal record id along for each inserted record. Default is 'false'. Values: 'true', 'false'. route_to_address: Route to a specific rank/tom. Option not suitable for tables using primary/shard keys Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 8479 of file GPUdbFunctions.hpp.

template<typename TRequest >

InsertRecordsResponse& insertRecords	(	const std::string &	tableName,
		const std::vector< TRequest > &	data,
		const std::map< std::string, std::string > &	options,
		InsertRecordsResponse &	response_
	)		const

Adds multiple records to the specified table.

The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored.

Template Parameters

<TRequest> The type of object being added.

Parameters

	tableName	Table to which the records are to be added. Must be an existing table.
	data	An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if listEncoding is json.
	options	Optional parameters. update_on_existing_pk: If the table has a /create/type, then if the value is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If 'false' and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then this optional parameter is ignored. Values: 'true', 'false'. return_record_ids: If 'true' then return GPUdb's internal record id along for each inserted record. Default is 'false'. Values: 'true', 'false'. route_to_address: Route to a specific rank/tom. Option not suitable for tables using primary/shard keys Default value is an empty std::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 8552 of file GPUdbFunctions.hpp.

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 GPUdb will not return until all random records are fully available.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

InsertRecordsRandomResponse& insertRecordsRandom	(	const InsertRecordsRandomRequest &	request_,
		InsertRecordsRandomResponse &	response_
	)		const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that GPUdb will not return until all random records are fully available.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

InsertRecordsRandomResponse insertRecordsRandom	(	const std::string &	tableName,
		const int64_t	count,
		const std::map< std::string, std::map< std::string, double > > &	options
	)		const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that GPUdb will not return until all random records are fully available.

Parameters

tableName	Table to which random records will be added. Must be an existing table. Also, must be an individual table, not a collection of tables, nor a view of a table.
count	Number of records to generate.
options	Optional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. The parameters that can be specified are: min, max, and interval. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map: all: This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records. min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track semantic types, 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 1). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [1, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track semantic types, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [1, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. interval: If specified, then generate values for all columns linearly and evenly spaced with the given interval value starting at the minimum value (instead of generating random data). Any provided max value is disregarded. For string-type columns, the interval value is ignored but the string values would be generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). attr_name: Set the following parameters for the column specified by the key. This overrides any parameter set by all. min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track semantic types, 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 1). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [1, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track semantic types, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [1, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. interval: If specified, then generate values for all columns linearly and evenly spaced with the given interval value starting at the minimum value (instead of generating random data). Any provided max value is disregarded. For string-type columns, the interval value is ignored but the string values would be generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). track_length: This key-map pair is only valid for track type data sets (GPUdb throws an error otherwise). 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. 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. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

InsertRecordsRandomResponse& insertRecordsRandom	(	const std::string &	tableName,
		const int64_t	count,
		const std::map< std::string, std::map< std::string, double > > &	options,
		InsertRecordsRandomResponse &	response_
	)		const

Generates a specified number of random records and adds them to the given table.

There is an optional parameter that allows the user to customize the ranges of the column values. It also allows the user to specify linear profiles for some or all columns in which case linear values are generated rather than random ones. Only individual tables are supported for this operation.

This operation is synchronous, meaning that GPUdb will not return until all random records are fully available.

Parameters

	tableName	Table to which random records will be added. Must be an existing table. Also, must be an individual table, not a collection of tables, nor a view of a table.
	count	Number of records to generate.
	options	Optional parameter to pass in specifications for the randomness of the values. This map is different from the options parameter of most other endpoints in that it is a map of string to map of string to doubles, while most others are maps of string to string. In this map, the top level keys represent which column's parameters are being specified, while the internal keys represents which parameter is being specified. The parameters that can be specified are: min, max, and interval. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map: all: This key indicates that the specifications relayed in the internal map are to be applied to all columns of the records. min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track semantic types, 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 1). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [1, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track semantic types, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [1, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. interval: If specified, then generate values for all columns linearly and evenly spaced with the given interval value starting at the minimum value (instead of generating random data). Any provided max value is disregarded. For string-type columns, the interval value is ignored but the string values would be generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). attr_name: Set the following parameters for the column specified by the key. This overrides any parameter set by all. min: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track semantic types, 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 1). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [1, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. max: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track semantic types, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings is set to this value (default is 200). If both minimum and maximum are provided, max must be greater than or equal to min. Value needs to be within [1, 200]. If the max is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track types, then those parameters will not be set; however, GPUdb will not throw an error in such a case. It is the responsibility of the user to use the all parameter judiciously. interval: If specified, then generate values for all columns linearly and evenly spaced with the given interval value starting at the minimum value (instead of generating random data). Any provided max value is disregarded. For string-type columns, the interval value is ignored but the string values would be generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). track_length: This key-map pair is only valid for track type data sets (GPUdb throws an error otherwise). 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. 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. Default value is an empty std::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).

InsertRecordsResponse insertRecordsRaw ( const RawInsertRecordsRequest & request_ ) const

Adds multiple records to the specified table.

The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is ignored.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

InsertRecordsResponse& insertRecordsRaw	(	const RawInsertRecordsRequest &	request_,
		InsertRecordsResponse &	response_
	)		const

Adds multiple records to the specified table.

The operation is synchronous meaning that GPUdb will not return a response until all the records are fully inserted and available. The response payload provides unique identifier for each added record along with counts of the number of records actually inserted and/or updated.

options can be used to customize this function's behavior. The only parameter available is update_on_existing_pk. The value can be either 'true' or 'false'. If the table has a primary key and if update_on_existing_pk is 'true' then if any of the records being added have the same primary key as existing records, the existing records are replaced (i.e. updated) with the given records. If update_on_existing_pk is false and if the records being added have the same primary key as existing records, the given records with existing primary keys are ignored (the existing records are left unchanged). It is quite possible that in this case some of the given records will be inserted and some (those having existing primary keys) will be ignored (or updated). If the specified table does not have a primary key column then the update_on_existing_pk option is 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).

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 or visualizeImage(const VisualizeImageRequest&) const) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

InsertSymbolResponse& insertSymbol	(	const InsertSymbolRequest &	request_,
		InsertSymbolResponse &	response_
	)		const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS or visualizeImage(const VisualizeImageRequest&,VisualizeImageResponse&) const) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

InsertSymbolResponse insertSymbol	(	const std::string &	symbolId,
		const std::string &	symbolFormat,
		const std::vector< uint8_t > &	symbolData,
		const std::map< std::string, std::string > &	options
	)		const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS or visualizeImage(const std::vector<std::string>&,const std::vector<std::string>&,const std::string&,const std::string&,const std::vector<std::vector<std::string> >&,const double,const double,const double,const double,const int32_t,const int32_t,const std::string&,const int64_t,const std::map<std::string, std::vector<std::string> >&,const std::map<std::string, std::string>&) const) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Parameters

symbolId	The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
symbolFormat	Specifies the symbol format. Must be either 'svg' or 'svg_path'. Values: 'svg', 'svg_path'.
symbolData	The actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'
options	Optional parameters. 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. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

InsertSymbolResponse& insertSymbol	(	const std::string &	symbolId,
		const std::string &	symbolFormat,
		const std::vector< uint8_t > &	symbolData,
		const std::map< std::string, std::string > &	options,
		InsertSymbolResponse &	response_
	)		const

Adds a symbol or icon (i.e.

an image) to represent data points when data is rendered visually. Users must provide the symbol identifier (string), a format (currently supported: 'svg' and 'svg_path'), the data for the symbol, and any additional optional parameter (e.g. color). To have a symbol used for rendering create a table with a string column named 'SYMBOLCODE' (along with 'x' or 'y' for example). Then when the table is rendered (via WMS or visualizeImage(const std::vector<std::string>&,const std::vector<std::string>&,const std::string&,const std::string&,const std::vector<std::vector<std::string> >&,const double,const double,const double,const double,const int32_t,const int32_t,const std::string&,const int64_t,const std::map<std::string, std::vector<std::string> >&,const std::map<std::string, std::string>&,VisualizeImageResponse&) const) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.

Parameters

	symbolId	The id of the symbol being added. This is the same id that should be in the 'SYMBOLCODE' column for objects using this symbol
	symbolFormat	Specifies the symbol format. Must be either 'svg' or 'svg_path'. Values: 'svg', 'svg_path'.
	symbolData	The actual symbol data. If symbolFormat is 'svg' then this should be the raw bytes representing an svg file. If symbolFormat is svg path then this should be an svg path string, for example: 'M25.979,12.896,5.979,12.896,5.979,19.562,25.979,19.562z'
	options	Optional parameters. 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. Default value is an empty std::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).

LockTableResponse lockTable ( const LockTableRequest & request_ ) const

Manages global access to a table's data.

By default a table has a lockType of unlock, 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 disable then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

LockTableResponse& lockTable	(	const LockTableRequest &	request_,
		LockTableResponse &	response_
	)		const

Manages global access to a table's data.

By default a table has a lockType of unlock, 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 disable then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

LockTableResponse lockTable	(	const std::string &	tableName,
		const std::string &	lockType,
		const std::map< std::string, std::string > &	options
	)		const

Manages global access to a table's data.

By default a table has a lockType of unlock, 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 disable then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters

tableName	Name of the table to be locked. It must be a currently existing table, collection, or view.
lockType	The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Values: 'status', 'disable', 'read-only', 'write-only', 'unlock'. Default value is 'status'.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

LockTableResponse& lockTable	(	const std::string &	tableName,
		const std::string &	lockType,
		const std::map< std::string, std::string > &	options,
		LockTableResponse &	response_
	)		const

Manages global access to a table's data.

By default a table has a lockType of unlock, 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 disable then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Parameters

	tableName	Name of the table to be locked. It must be a currently existing table, collection, or view.
	lockType	The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Values: 'status', 'disable', 'read-only', 'write-only', 'unlock'. Default value is 'status'.
	options	Optional parameters. Default value is an empty std::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).

RevokePermissionSystemResponse revokePermissionSystem ( const RevokePermissionSystemRequest & request_ ) const

Revokes a system-level permission from a user or role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

RevokePermissionSystemResponse& revokePermissionSystem	(	const RevokePermissionSystemRequest &	request_,
		RevokePermissionSystemResponse &	response_
	)		const

Revokes a system-level permission from a user or role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

RevokePermissionSystemResponse revokePermissionSystem	(	const std::string &	name,
		const std::string &	permission,
		const std::map< std::string, std::string > &	options
	)		const

Revokes a system-level permission from a user or role.

Parameters

name	Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission	Permission to revoke from the user or role. Values: 'system_admin', 'system_write', 'system_read'.
options	Optional parameters.

Returns: Response object containing the result of the operation.

RevokePermissionSystemResponse& revokePermissionSystem	(	const std::string &	name,
		const std::string &	permission,
		const std::map< std::string, std::string > &	options,
		RevokePermissionSystemResponse &	response_
	)		const

Revokes a system-level permission from a user or role.

Parameters

	name	Name of the user or role from which the permission will be revoked. Must be an existing user or role.
	permission	Permission to revoke from the user or role. Values: 'system_admin', 'system_write', 'system_read'.
	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).

RevokePermissionTableResponse revokePermissionTable ( const RevokePermissionTableRequest & request_ ) const

Revokes a table-level permission from a user or role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

RevokePermissionTableResponse& revokePermissionTable	(	const RevokePermissionTableRequest &	request_,
		RevokePermissionTableResponse &	response_
	)		const

Revokes a table-level permission from a user or role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

RevokePermissionTableResponse revokePermissionTable	(	const std::string &	name,
		const std::string &	permission,
		const std::string &	tableName,
		const std::map< std::string, std::string > &	options
	)		const

Revokes a table-level permission from a user or role.

Parameters

name	Name of the user or role from which the permission will be revoked. Must be an existing user or role.
permission	Permission to revoke from the user or role. Values: 'table_admin', 'table_insert', 'table_update', 'table_delete', 'table_read'.
tableName	Name of the table to which the permission grants access. Must be an existing table, collection, or view.
options	Optional parameters.

Returns: Response object containing the result of the operation.

RevokePermissionTableResponse& revokePermissionTable	(	const std::string &	name,
		const std::string &	permission,
		const std::string &	tableName,
		const std::map< std::string, std::string > &	options,
		RevokePermissionTableResponse &	response_
	)		const

Revokes a table-level permission from a user or role.

Parameters

	name	Name of the user or role from which the permission will be revoked. Must be an existing user or role.
	permission	Permission to revoke from the user or role. Values: 'table_admin', 'table_insert', 'table_update', 'table_delete', 'table_read'.
	tableName	Name of the table to which the permission grants access. Must be an existing table, collection, or view.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

RevokeRoleResponse revokeRole ( const RevokeRoleRequest & request_ ) const

Revokes membership in a role from a user or role.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

RevokeRoleResponse& revokeRole	(	const RevokeRoleRequest &	request_,
		RevokeRoleResponse &	response_
	)		const

Revokes membership in a role from a user or role.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

RevokeRoleResponse revokeRole	(	const std::string &	role,
		const std::string &	member,
		const std::map< std::string, std::string > &	options
	)		const

Revokes membership in a role from a user or role.

Parameters

role	Name of the role in which membership will be revoked. Must be an existing role.
member	Name of the user or role that will be revoked membership in role. Must be an existing user or role.
options	Optional parameters.

Returns: Response object containing the result of the operation.

RevokeRoleResponse& revokeRole	(	const std::string &	role,
		const std::string &	member,
		const std::map< std::string, std::string > &	options,
		RevokeRoleResponse &	response_
	)		const

Revokes membership in a role from a user or role.

Parameters

	role	Name of the role in which membership will be revoked. Must be an existing role.
	member	Name of the user or role that will be revoked membership in role. Must be an existing user or role.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowSecurityResponse showSecurity ( const ShowSecurityRequest & request_ ) const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowSecurityResponse& showSecurity	(	const ShowSecurityRequest &	request_,
		ShowSecurityResponse &	response_
	)		const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowSecurityResponse showSecurity	(	const std::vector< std::string > &	names,
		const std::map< std::string, std::string > &	options
	)		const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters

names	A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
options	Optional parameters.

Returns: Response object containing the result of the operation.

ShowSecurityResponse& showSecurity	(	const std::vector< std::string > &	names,
		const std::map< std::string, std::string > &	options,
		ShowSecurityResponse &	response_
	)		const

Shows security information relating to users and/or roles.

If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Parameters

	names	A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowSystemPropertiesResponse showSystemProperties ( const ShowSystemPropertiesRequest & request_ ) const

Returns server configuration and version related information to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowSystemPropertiesResponse& showSystemProperties	(	const ShowSystemPropertiesRequest &	request_,
		ShowSystemPropertiesResponse &	response_
	)		const

Returns server configuration and version related information to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowSystemPropertiesResponse showSystemProperties ( const std::map< std::string, std::string > & options ) const

Returns server configuration and version related information to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

options

Optional parameters.

properties: A list of comma separated names of properties requested. If not specified, all properties will be returned.

Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowSystemPropertiesResponse& showSystemProperties	(	const std::map< std::string, std::string > &	options,
		ShowSystemPropertiesResponse &	response_
	)		const

Returns server configuration and version related information to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

	options	Optional parameters. properties: A list of comma separated names of properties requested. If not specified, all properties will be returned. Default value is an empty std::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).

ShowSystemStatusResponse showSystemStatus ( const ShowSystemStatusRequest & request_ ) const

Provides server configuration and health related status to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowSystemStatusResponse& showSystemStatus	(	const ShowSystemStatusRequest &	request_,
		ShowSystemStatusResponse &	response_
	)		const

Provides server configuration and health related status to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowSystemStatusResponse showSystemStatus ( const std::map< std::string, std::string > & options ) const

Provides server configuration and health related status to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

options Optional parameters, currently unused. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowSystemStatusResponse& showSystemStatus	(	const std::map< std::string, std::string > &	options,
		ShowSystemStatusResponse &	response_
	)		const

Provides server configuration and health related status to the caller.

The GPUdb Admin tool uses it to present server related information to the user.

Parameters

	options	Optional parameters, currently unused. Default value is an empty std::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).

ShowSystemTimingResponse showSystemTiming ( const ShowSystemTimingRequest & request_ ) const

Returns the last 100 requests made to GPUdb along with the request timing and internal job id.

The GPUdb Admin tool uses it to present request timing information to the user.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowSystemTimingResponse& showSystemTiming	(	const ShowSystemTimingRequest &	request_,
		ShowSystemTimingResponse &	response_
	)		const

Returns the last 100 requests made to GPUdb along with the request timing and internal job id.

The GPUdb Admin tool uses it to present request timing information to the user.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowSystemTimingResponse showSystemTiming ( const std::map< std::string, std::string > & options ) const

Returns the last 100 requests made to GPUdb along with the request timing and internal job id.

The GPUdb Admin tool uses it to present request timing information to the user.

Parameters

options Optional parameters, currently unused. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowSystemTimingResponse& showSystemTiming	(	const std::map< std::string, std::string > &	options,
		ShowSystemTimingResponse &	response_
	)		const

Returns the last 100 requests made to GPUdb along with the request timing and internal job id.

The GPUdb Admin tool uses it to present request timing information to the user.

Parameters

	options	Optional parameters, currently unused. Default value is an empty std::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).

ShowTableResponse showTable ( const ShowTableRequest & request_ ) const

Retrieves detailed information about a particular GPUdb table, specified in tableName.

If the supplied tableName is a collection, the call returns a list of tables contained in the collection, and for each table it returns the description, type id, schema, type label, type properties, and additional information including TTL. If tableName is empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).

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

If the option 'show_children' is set to 'false' then for a collection it only returns information about the collection itself, not about the child tables. If 'show_children' is set to 'true' then it will return information about each of the children, but not the collection.

Running with 'show_children' = 'true' on a child table will return an error.

Running with 'show_children' = 'false' with tableName empty will return an error.

If the requested table is blank, then information is returned about all top-level tables including collections.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowTableResponse& showTable	(	const ShowTableRequest &	request_,
		ShowTableResponse &	response_
	)		const

Retrieves detailed information about a particular GPUdb table, specified in tableName.

If the supplied tableName is a collection, the call returns a list of tables contained in the collection, and for each table it returns the description, type id, schema, type label, type properties, and additional information including TTL. If tableName is empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).

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

If the option 'show_children' is set to 'false' then for a collection it only returns information about the collection itself, not about the child tables. If 'show_children' is set to 'true' then it will return information about each of the children, but not the collection.

Running with 'show_children' = 'true' on a child table will return an error.

Running with 'show_children' = 'false' with tableName empty will return an error.

If the requested table is blank, then information is returned about all top-level tables including collections.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowTableResponse showTable	(	const std::string &	tableName,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves detailed information about a particular GPUdb table, specified in tableName.

If the supplied tableName is a collection, the call returns a list of tables contained in the collection, and for each table it returns the description, type id, schema, type label, type properties, and additional information including TTL. If tableName is empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).

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

If the option 'show_children' is set to 'false' then for a collection it only returns information about the collection itself, not about the child tables. If 'show_children' is set to 'true' then it will return information about each of the children, but not the collection.

Running with 'show_children' = 'true' on a child table will return an error.

Running with 'show_children' = 'false' with tableName empty will return an error.

If the requested table is blank, then information is returned about all top-level tables including collections.

Parameters

tableName Name of the table for which to retrieve the information. If blank then information about all collections and top-level tables is returned.

options

Optional parameters.

get_sizes: If 'true' then the table sizes will be returned; otherwise they will be returned blank. Values: 'true', 'false'.
show_children: If tableName is a collection, then 'true' will return information about the children of the collection, and 'false' will return information about the collection itself. If tableName is a child table, 'show_children' must be 'false'. If tableName is empty then 'show_children' must be 'true'. Values: 'true', 'false'.

Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowTableResponse& showTable	(	const std::string &	tableName,
		const std::map< std::string, std::string > &	options,
		ShowTableResponse &	response_
	)		const

Retrieves detailed information about a particular GPUdb table, specified in tableName.

If the supplied tableName is a collection, the call returns a list of tables contained in the collection, and for each table it returns the description, type id, schema, type label, type properties, and additional information including TTL. If tableName is empty it will return all top-level tables including all collections and top-level child tables (i.e. tables with no parent).

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

If the option 'show_children' is set to 'false' then for a collection it only returns information about the collection itself, not about the child tables. If 'show_children' is set to 'true' then it will return information about each of the children, but not the collection.

Running with 'show_children' = 'true' on a child table will return an error.

Running with 'show_children' = 'false' with tableName empty will return an error.

If the requested table is blank, then information is returned about all top-level tables including collections.

Parameters

	tableName	Name of the table for which to retrieve the information. If blank then information about all collections and top-level tables is returned.
	options	Optional parameters. get_sizes: If 'true' then the table sizes will be returned; otherwise they will be returned blank. Values: 'true', 'false'. show_children: If tableName is a collection, then 'true' will return information about the children of the collection, and 'false' will return information about the collection itself. If tableName is a child table, 'show_children' must be 'false'. If tableName is empty then 'show_children' must be 'true'. Values: 'true', 'false'. Default value is an empty std::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).

ShowTableMetadataResponse showTableMetadata ( const ShowTableMetadataRequest & request_ ) const

Retrieves the user provided metadata for the specified tables.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowTableMetadataResponse& showTableMetadata	(	const ShowTableMetadataRequest &	request_,
		ShowTableMetadataResponse &	response_
	)		const

Retrieves the user provided metadata for the specified tables.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowTableMetadataResponse showTableMetadata	(	const std::vector< std::string > &	tableNames,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves the user provided metadata for the specified tables.

Parameters

tableNames	Tables whose metadata will be fetched. All provided tables must exist in GPUdb, or GPUdb returns an error.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowTableMetadataResponse& showTableMetadata	(	const std::vector< std::string > &	tableNames,
		const std::map< std::string, std::string > &	options,
		ShowTableMetadataResponse &	response_
	)		const

Retrieves the user provided metadata for the specified tables.

Parameters

	tableNames	Tables whose metadata will be fetched. All provided tables must exist in GPUdb, or GPUdb returns an error.
	options	Optional parameters. Default value is an empty std::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).

ShowTablesByTypeResponse showTablesByType ( const ShowTablesByTypeRequest & request_ ) const

Gets names of the tables from GPUdb based on the type information.

Each table in GPUdb has a particular type. This type is made out of the type label, schema of the table and the semantic type of the table. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowTablesByTypeResponse& showTablesByType	(	const ShowTablesByTypeRequest &	request_,
		ShowTablesByTypeResponse &	response_
	)		const

Gets names of the tables from GPUdb based on the type information.

Each table in GPUdb has a particular type. This type is made out of the type label, schema of the table and the semantic type of the table. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowTablesByTypeResponse showTablesByType	(	const std::string &	typeId,
		const std::string &	label,
		const std::map< std::string, std::string > &	options
	)		const

Gets names of the tables from GPUdb based on the type information.

Each table in GPUdb has a particular type. This type is made out of the type label, schema of the table and the semantic type of the table. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters

typeId	Type id returned by a call to /create/type.
label	Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowTablesByTypeResponse& showTablesByType	(	const std::string &	typeId,
		const std::string &	label,
		const std::map< std::string, std::string > &	options,
		ShowTablesByTypeResponse &	response_
	)		const

Gets names of the tables from GPUdb based on the type information.

Each table in GPUdb has a particular type. This type is made out of the type label, schema of the table and the semantic type of the table. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Parameters

	typeId	Type id returned by a call to /create/type.
	label	Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
	options	Optional parameters. Default value is an empty std::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).

ShowTriggersResponse showTriggers ( const ShowTriggersRequest & request_ ) const

Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowTriggersResponse& showTriggers	(	const ShowTriggersRequest &	request_,
		ShowTriggersResponse &	response_
	)		const

Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

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

Parameters

triggerIds	List of IDs of the triggers whose information to be retrieved. Empty list means retrieve information on all active triggers.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowTriggersResponse& showTriggers	(	const std::vector< std::string > &	triggerIds,
		const std::map< std::string, std::string > &	options,
		ShowTriggersResponse &	response_
	)		const

Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.

Parameters

	triggerIds	List of IDs of the triggers whose information to be retrieved. Empty list means retrieve information on all active triggers.
	options	Optional parameters. Default value is an empty std::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).

ShowTypesResponse showTypes ( const ShowTypesRequest & request_ ) const

Retrieves information for the specified data type.

Given a type ID, GPUdb returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then GPUdb returns the pertinent information for all data types that match the input criteria.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

ShowTypesResponse& showTypes	(	const ShowTypesRequest &	request_,
		ShowTypesResponse &	response_
	)		const

Retrieves information for the specified data type.

Given a type ID, GPUdb returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then GPUdb returns the pertinent information for all data types that match the input criteria.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

ShowTypesResponse showTypes	(	const std::string &	typeId,
		const std::string &	label,
		const std::map< std::string, std::string > &	options
	)		const

Retrieves information for the specified data type.

Given a type ID, GPUdb returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then GPUdb returns the pertinent information for all data types that match the input criteria.

Parameters

typeId	Type Id returned in response to a call to /create/type.
label	Option string that was supplied by user in a call to /create/type.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

ShowTypesResponse& showTypes	(	const std::string &	typeId,
		const std::string &	label,
		const std::map< std::string, std::string > &	options,
		ShowTypesResponse &	response_
	)		const

Retrieves information for the specified data type.

Given a type ID, GPUdb returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then GPUdb returns the pertinent information for all data types that match the input criteria.

Parameters

	typeId	Type Id returned in response to a call to /create/type.
	label	Option string that was supplied by user in a call to /create/type.
	options	Optional parameters. Default value is an empty std::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).

template<typename TRequest >

UpdateRecordsResponse updateRecords ( const UpdateRecordsRequest< TRequest > & request_ ) const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

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

template<typename TRequest >

UpdateRecordsResponse& updateRecords	(	const UpdateRecordsRequest< TRequest > &	request_,
		UpdateRecordsResponse &	response_
	)		const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

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

template<typename TRequest >

UpdateRecordsResponse updateRecords	(	const std::string &	tableName,
		const std::vector< std::string > &	expressions,
		const std::vector< std::map< std::string, std::string > > &	newValuesMaps,
		const std::vector< TRequest > &	data,
		const std::map< std::string, std::string > &	options
	)		const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Template Parameters

<TRequest> The type of object being added.

Parameters

tableName	Table to be updated. Must be a currently existing table and not a collection or view.
expressions	A list of the actual predicates, one for each update; format should follow the guidelines /filter.
newValuesMaps	List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
data	An optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. Default value is an empty std::vector.
options	Optional parameters. global_expression: An optional global expression to reduce the search space of the predicates listed in expressions. 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. Values: 'true', 'false'. update_on_existing_pk: Can be used to customize behavior when the updated primary key value already exists, as described in /insert/records. Values: 'true', 'false'. record_id: ID of a single record to be updated (returned in the call to /insert/records or /get/records/fromcollection). Default value is an empty std::map.

Returns: Response object containing the result of the operation.

Definition at line 10297 of file GPUdbFunctions.hpp.

template<typename TRequest >

UpdateRecordsResponse& updateRecords	(	const std::string &	tableName,
		const std::vector< std::string > &	expressions,
		const std::vector< std::map< std::string, std::string > > &	newValuesMaps,
		const std::vector< TRequest > &	data,
		const std::map< std::string, std::string > &	options,
		UpdateRecordsResponse &	response_
	)		const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Template Parameters

<TRequest> The type of object being added.

Parameters

	tableName	Table to be updated. Must be a currently existing table and not a collection or view.
	expressions	A list of the actual predicates, one for each update; format should follow the guidelines /filter.
	newValuesMaps	List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
	data	An optional list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. Default value is an empty std::vector.
	options	Optional parameters. global_expression: An optional global expression to reduce the search space of the predicates listed in expressions. 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. Values: 'true', 'false'. update_on_existing_pk: Can be used to customize behavior when the updated primary key value already exists, as described in /insert/records. Values: 'true', 'false'. record_id: ID of a single record to be updated (returned in the call to /insert/records or /get/records/fromcollection). Default value is an empty std::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 10382 of file GPUdbFunctions.hpp.

UpdateRecordsBySeriesResponse updateRecordsBySeries ( const UpdateRecordsBySeriesRequest & request_ ) const

Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

UpdateRecordsBySeriesResponse& updateRecordsBySeries	(	const UpdateRecordsBySeriesRequest &	request_,
		UpdateRecordsBySeriesResponse &	response_
	)		const

Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

UpdateRecordsBySeriesResponse updateRecordsBySeries	(	const std::string &	tableName,
		const std::string &	worldTableName,
		const std::string &	viewName,
		const std::vector< std::string > &	reserved,
		const std::map< std::string, std::string > &	options
	)		const

Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.

Parameters

tableName	Name of the view on which the update operation will be performed. Must be a valid view in GPUdb.
worldTableName	Name of the table containing the complete series (track) information.
viewName	Optional name of the view containing the series (tracks) which have to be updated. Default value is an empty string.
reserved	Default value is an empty std::vector.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

UpdateRecordsBySeriesResponse& updateRecordsBySeries	(	const std::string &	tableName,
		const std::string &	worldTableName,
		const std::string &	viewName,
		const std::vector< std::string > &	reserved,
		const std::map< std::string, std::string > &	options,
		UpdateRecordsBySeriesResponse &	response_
	)		const

Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.

Parameters

	tableName	Name of the view on which the update operation will be performed. Must be a valid view in GPUdb.
	worldTableName	Name of the table containing the complete series (track) information.
	viewName	Optional name of the view containing the series (tracks) which have to be updated. Default value is an empty string.
	reserved	Default value is an empty std::vector.
	options	Optional parameters. Default value is an empty std::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).

UpdateRecordsResponse updateRecordsRaw ( const RawUpdateRecordsRequest & request_ ) const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

UpdateRecordsResponse& updateRecordsRaw	(	const RawUpdateRecordsRequest &	request_,
		UpdateRecordsResponse &	response_
	)		const

Runs multiple predicate-based updates in a single call.

With the list of given expressions, any matching record's column values will be updated as provided in newValuesMaps. There is also an optional 'upsert' capability where if a particular predicate doesn't match any existing record, then a new record can be inserted.

Note that this operation can only be run on an original table and not on a collection or a result view.

This operation can update primary key values. By default only 'pure primary key' predicates are allowed when updating primary key values. If the primary key for a table is the column 'attr1', then the operation will only accept predicates of the form: "attr1 == 'foo'" if the attr1 column is being updated. For a composite primary key (e.g. columns 'attr1' and 'attr2') then this operation will only accept predicates of the form: "(attr1 == 'foo') and (attr2 == 'bar')". Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each 'pure primary key' predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

VisualizeVideoResponse visualizeVideo ( const VisualizeVideoRequest & request_ ) const

Creates raster images of data in the given table based on provided input parameters.

Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of GPUdb table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL::

http://<gpudb-ip-address>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with::

http://gpudb-ip-address:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19 The response payload provides, among other things, the number of frames which were created by GPUdb.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns: Response object containing the result of the operation.

VisualizeVideoResponse& visualizeVideo	(	const VisualizeVideoRequest &	request_,
		VisualizeVideoResponse &	response_
	)		const

Creates raster images of data in the given table based on provided input parameters.

Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of GPUdb table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL::

http://<gpudb-ip-address>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with::

http://gpudb-ip-address:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19 The response payload provides, among other things, the number of frames which were created by GPUdb.

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns: Response object containing the result of the operation (initially passed in by reference).

VisualizeVideoResponse visualizeVideo	(	const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	worldTableNames,
		const std::vector< std::vector< std::string > > &	trackIds,
		const std::string &	xColumnName,
		const std::string &	yColumnName,
		const double	minX,
		const double	maxX,
		const double	minY,
		const double	maxY,
		const int32_t	width,
		const int32_t	height,
		const std::string &	projection,
		const int64_t	bgColor,
		const std::vector< std::vector< double > > &	timeIntervals,
		const std::string &	videoStyle,
		const std::string &	sessionKey,
		const std::map< std::string, std::vector< std::string > > &	styleOptions,
		const std::map< std::string, std::string > &	options
	)		const

Creates raster images of data in the given table based on provided input parameters.

Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of GPUdb table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL::

http://<gpudb-ip-address>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with::

http://gpudb-ip-address:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19 The response payload provides, among other things, the number of frames which were created by GPUdb.

Parameters

tableNames	Names of the tables containing the data for various layers of the resulting video.
worldTableNames	Optional name of the tables containing the data for the entire track when the tableNames contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the tableNames
trackIds	Tracks from the tableNames to be rendered.
xColumnName	Name of the column containing the x coordinates.
yColumnName	Name of the column containing the y coordinates.
minX	Lower bound for the x values.
maxX	Upper bound for the x values.
minY	Lower bound for the y values.
maxY	Upper bound for the y values.
width	Width of the generated image.
height	Height of the generated image.
projection	Spatial Reference System (i.e. EPSG Code). Values: 'EPSG:4326', 'PLATE_CARREE', '900913', 'EPSG:900913', '102100', 'EPSG:102100', '3857', 'EPSG:3857', 'WEB_MERCATOR'. Default value is 'PLATE_CARREE'.
bgColor	Background color of the generated image.
timeIntervals
videoStyle
sessionKey	User Provided session key that is later used to retrieve the generated video from the WMS.
styleOptions	Styling options for the image. do_points: Rasterize point data toggle. Values: 'true', 'false'. do_shapes: Rasterize shapes toggle. Values: 'true', 'false'. do_tracks: Rasterize tracks toggle. Values: 'true', 'false'. pointcolors: RGB color value in hex for the points. pointsizes: Size of points. pointshapes: Shape of the point. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'. shapelinewidths: Width of the lines. shapelinecolors: RGB color values in hex for the line. shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill. tracklinewidths: Width of the track lines. '0' implies do not draw track lines. tracklinecolors: RGB color values for the track lines. trackmarkersizes: Size of the track point markers. trackmarkercolors: Color of the track point markers. trackmarkershapes: Shape of track point markers. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'. trackheadcolors: Color of track head markers. trackheadsizes: Size of track head markers. trackheadshapes: Shape of track head markers. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'.
options	Optional parameters. Default value is an empty std::map.

Returns: Response object containing the result of the operation.

VisualizeVideoResponse& visualizeVideo	(	const std::vector< std::string > &	tableNames,
		const std::vector< std::string > &	worldTableNames,
		const std::vector< std::vector< std::string > > &	trackIds,
		const std::string &	xColumnName,
		const std::string &	yColumnName,
		const double	minX,
		const double	maxX,
		const double	minY,
		const double	maxY,
		const int32_t	width,
		const int32_t	height,
		const std::string &	projection,
		const int64_t	bgColor,
		const std::vector< std::vector< double > > &	timeIntervals,
		const std::string &	videoStyle,
		const std::string &	sessionKey,
		const std::map< std::string, std::vector< std::string > > &	styleOptions,
		const std::map< std::string, std::string > &	options,
		VisualizeVideoResponse &	response_
	)		const

Creates raster images of data in the given table based on provided input parameters.

Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of GPUdb table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images stored by GPUdb. The operation is synchronous meaning that GPUdb will not return the request until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL::

http://<gpudb-ip-address>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with::

http://gpudb-ip-address:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19 The response payload provides, among other things, the number of frames which were created by GPUdb.

Parameters

	tableNames	Names of the tables containing the data for various layers of the resulting video.
	worldTableNames	Optional name of the tables containing the data for the entire track when the tableNames contains only part of the track data, but the entire track has to be rendered. The number of tables should match the number of tables in the tableNames
	trackIds	Tracks from the tableNames to be rendered.
	xColumnName	Name of the column containing the x coordinates.
	yColumnName	Name of the column containing the y coordinates.
	minX	Lower bound for the x values.
	maxX	Upper bound for the x values.
	minY	Lower bound for the y values.
	maxY	Upper bound for the y values.
	width	Width of the generated image.
	height	Height of the generated image.
	projection	Spatial Reference System (i.e. EPSG Code). Values: 'EPSG:4326', 'PLATE_CARREE', '900913', 'EPSG:900913', '102100', 'EPSG:102100', '3857', 'EPSG:3857', 'WEB_MERCATOR'. Default value is 'PLATE_CARREE'.
	bgColor	Background color of the generated image.
	timeIntervals
	videoStyle
	sessionKey	User Provided session key that is later used to retrieve the generated video from the WMS.
	styleOptions	Styling options for the image. do_points: Rasterize point data toggle. Values: 'true', 'false'. do_shapes: Rasterize shapes toggle. Values: 'true', 'false'. do_tracks: Rasterize tracks toggle. Values: 'true', 'false'. pointcolors: RGB color value in hex for the points. pointsizes: Size of points. pointshapes: Shape of the point. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'. shapelinewidths: Width of the lines. shapelinecolors: RGB color values in hex for the line. shapefillcolors: RGB color values in hex for the fill color of the shapes. Use '-1' for no fill. tracklinewidths: Width of the track lines. '0' implies do not draw track lines. tracklinecolors: RGB color values for the track lines. trackmarkersizes: Size of the track point markers. trackmarkercolors: Color of the track point markers. trackmarkershapes: Shape of track point markers. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'. trackheadcolors: Color of track head markers. trackheadsizes: Size of track head markers. trackheadshapes: Shape of track head markers. Values: 'none', 'circle', 'square', 'diamond', 'hollowcircle', 'hollowsquare', 'hollowdiamond', 'SYMBOLCODE'.
	options	Optional parameters. Default value is an empty std::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).