GPUdb (Kinetica Java API 5.2.0 API)

java.lang.Object
- com.gpudb.GPUdbBase
- - com.gpudb.GPUdb

```
public class GPUdb
extends GPUdbBase
```
Object that provides access to a specific GPUdb server. GPUdb instances are thread safe and may be used from any number of threads simultaneously.

Nested Class Summary
- Nested classes/interfaces inherited from class com.gpudb.GPUdbBase
  GPUdbBase.Options, GPUdbBase.SubmitException

Field Summary
- Fields inherited from class com.gpudb.GPUdbBase
  END_OF_SET

Constructor Summary

Constructors
Constructor and Description
`GPUdb(String url)` Creates a `GPUdb` instance for the GPUdb server at the specified URL using default options.
`GPUdb(String url, GPUdbBase.Options options)` Creates a `GPUdb` instance for the GPUdb server at the specified URL using the specified options.
`GPUdb(URL url)` Creates a `GPUdb` instance for the GPUdb server at the specified URL using default options.
`GPUdb(URL url, GPUdbBase.Options options)` Creates a `GPUdb` instance for the GPUdb server at the specified URL using the specified options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminDeleteNodeResponse`	`adminDeleteNode(AdminDeleteNodeRequest request)`
`AdminDeleteNodeResponse`	`adminDeleteNode(int rank, String authorization, Map<String,String> options)`
`AdminGetShardAssignmentsResponse`	`adminGetShardAssignments(AdminGetShardAssignmentsRequest request)`
`AdminGetShardAssignmentsResponse`	`adminGetShardAssignments(Map<String,String> options)`
`AdminOfflineResponse`	`adminOffline(AdminOfflineRequest request)` Take the system offline.
`AdminOfflineResponse`	`adminOffline(boolean offline, Map<String,String> options)` Take the system offline.
`AdminRebalanceResponse`	`adminRebalance(AdminRebalanceRequest request)`
`AdminRebalanceResponse`	`adminRebalance(List<String> tableNames, Map<String,String> options)`
`AdminSetShardAssignmentsResponse`	`adminSetShardAssignments(AdminSetShardAssignmentsRequest request)`
`AdminSetShardAssignmentsResponse`	`adminSetShardAssignments(long version, boolean partialReassignment, List<Integer> shardAssignmentsRank, List<Integer> shardAssignmentsTom, List<Integer> assignmentIndex, Map<String,String> options)`
`AdminShutdownResponse`	`adminShutdown(AdminShutdownRequest request)` Exits the GPUdb server application.
`AdminShutdownResponse`	`adminShutdown(String exitType, String authorization, Map<String,String> options)` Exits the GPUdb server application.
`AdminVerifyDbResponse`	`adminVerifyDb(AdminVerifyDbRequest request)` Verify database is in a consistent state.
`AdminVerifyDbResponse`	`adminVerifyDb(Map<String,String> options)` Verify database is in a consistent state.
`AggregateConvexHullResponse`	`aggregateConvexHull(AggregateConvexHullRequest request)` Calculates and returns the convex hull for the values in a table specified by `tableName`.
`AggregateConvexHullResponse`	`aggregateConvexHull(String tableName, String xColumnName, String yColumnName, Map<String,String> options)` Calculates and returns the convex hull for the values in a table specified by `tableName`.
`AggregateGroupByResponse`	`aggregateGroupBy(AggregateGroupByRequest request)` Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.
`AggregateGroupByResponse`	`aggregateGroupBy(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options)` Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.
`RawAggregateGroupByResponse`	`aggregateGroupByRaw(AggregateGroupByRequest request)` Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination.
`AggregateHistogramResponse`	`aggregateHistogram(AggregateHistogramRequest request)` Performs a histogram calculation given a table, a column, and an interval function.
`AggregateHistogramResponse`	`aggregateHistogram(String tableName, String columnName, double start, double end, double interval, Map<String,String> options)` Performs a histogram calculation given a table, a column, and an interval function.
`AggregateKMeansResponse`	`aggregateKMeans(AggregateKMeansRequest request)` This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
`AggregateKMeansResponse`	`aggregateKMeans(String tableName, List<String> columnNames, int k, double tolerance, Map<String,String> options)` This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering.
`AggregateMinMaxResponse`	`aggregateMinMax(AggregateMinMaxRequest request)` Calculates and returns the minimum and maximum values of a particular column in a table.
`AggregateMinMaxResponse`	`aggregateMinMax(String tableName, String columnName, Map<String,String> options)` Calculates and returns the minimum and maximum values of a particular column in a table.
`AggregateStatisticsResponse`	`aggregateStatistics(AggregateStatisticsRequest request)` Calculates the requested statistics of a given column in a given table.
`AggregateStatisticsResponse`	`aggregateStatistics(String tableName, String columnName, String stats, Map<String,String> options)` Calculates the requested statistics of a given column in a given table.
`AggregateStatisticsByRangeResponse`	`aggregateStatisticsByRange(AggregateStatisticsByRangeRequest request)` Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
`AggregateStatisticsByRangeResponse`	`aggregateStatisticsByRange(String tableName, String selectExpression, String columnName, String valueColumnName, String stats, double start, double end, double interval, Map<String,String> options)` Divides the given set into bins and calculates statistics of the values of a value-column in each bin.
`AggregateUniqueResponse`	`aggregateUnique(AggregateUniqueRequest request)` Returns all the unique values from a particular column (specified by `columnName`) of a particular table (specified by `tableName`).
`AggregateUniqueResponse`	`aggregateUnique(String tableName, String columnName, long offset, long limit, Map<String,String> options)` Returns all the unique values from a particular column (specified by `columnName`) of a particular table (specified by `tableName`).
`RawAggregateUniqueResponse`	`aggregateUniqueRaw(AggregateUniqueRequest request)` Returns all the unique values from a particular column (specified by `columnName`) of a particular table (specified by `tableName`).
`AlterSystemPropertiesResponse`	`alterSystemProperties(AlterSystemPropertiesRequest request)` The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution.
`AlterSystemPropertiesResponse`	`alterSystemProperties(Map<String,String> propertyUpdatesMap, Map<String,String> options)` The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution.
`AlterTableResponse`	`alterTable(AlterTableRequest request)` Apply various modifications to a table or collection.
`AlterTableResponse`	`alterTable(String tableName, String action, String value, Map<String,String> options)` Apply various modifications to a table or collection.
`AlterTableMetadataResponse`	`alterTableMetadata(AlterTableMetadataRequest request)` Updates (adds or changes) metadata for tables.
`AlterTableMetadataResponse`	`alterTableMetadata(List<String> tableNames, Map<String,String> metadataMap, Map<String,String> options)` Updates (adds or changes) metadata for tables.
`AlterUserResponse`	`alterUser(AlterUserRequest request)` Alters a user.
`AlterUserResponse`	`alterUser(String name, String action, String value, Map<String,String> options)` Alters a user.
`ClearTableResponse`	`clearTable(ClearTableRequest request)` Clears (drops) one or all tables in the GPUdb cluster.
`ClearTableResponse`	`clearTable(String tableName, String authorization, Map<String,String> options)` Clears (drops) one or all tables in the GPUdb cluster.
`ClearTableMonitorResponse`	`clearTableMonitor(ClearTableMonitorRequest request)` Deactivates a table monitor previously created with `createTableMonitor(CreateTableMonitorRequest)`.
`ClearTableMonitorResponse`	`clearTableMonitor(String topicId, Map<String,String> options)` Deactivates a table monitor previously created with `createTableMonitor(String, Map)`.
`ClearTriggerResponse`	`clearTrigger(ClearTriggerRequest request)` Clears or cancels the trigger identified by the specified handle.
`ClearTriggerResponse`	`clearTrigger(String triggerId, Map<String,String> options)` Clears or cancels the trigger identified by the specified handle.
`CreateJoinTableResponse`	`createJoinTable(CreateJoinTableRequest request)` Creates a table that is the result of a SQL JOIN.
`CreateJoinTableResponse`	`createJoinTable(String joinTableName, List<String> tableNames, List<String> aliases, String expression, List<String> expressions, Map<String,String> options)` Creates a table that is the result of a SQL JOIN.
`CreateRoleResponse`	`createRole(CreateRoleRequest request)` Creates a new role.
`CreateRoleResponse`	`createRole(String name, Map<String,String> options)` Creates a new role.
`CreateTableResponse`	`createTable(CreateTableRequest request)` Creates a new table or collection in GPUdb.
`CreateTableResponse`	`createTable(String tableName, String typeId, Map<String,String> options)` Creates a new table or collection in GPUdb.
`CreateTableMonitorResponse`	`createTableMonitor(CreateTableMonitorRequest request)` Creates a monitor that watches for new records inserted into a particular table (identified by `tableName`) and forwards copies to subscribers via ZMQ.
`CreateTableMonitorResponse`	`createTableMonitor(String tableName, Map<String,String> options)` Creates a monitor that watches for new records inserted into a particular table (identified by `tableName`) and forwards copies to subscribers via ZMQ.
`CreateTriggerByAreaResponse`	`createTriggerByArea(CreateTriggerByAreaRequest request)` Sets up an area trigger mechanism for two column_names for one or more tables.
`CreateTriggerByAreaResponse`	`createTriggerByArea(String requestId, List<String> tableNames, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options)` Sets up an area trigger mechanism for two column_names for one or more tables.
`CreateTriggerByRangeResponse`	`createTriggerByRange(CreateTriggerByRangeRequest request)` Sets up a simple range trigger for a column_name for one or more tables.
`CreateTriggerByRangeResponse`	`createTriggerByRange(String requestId, List<String> tableNames, String columnName, double min, double max, Map<String,String> options)` Sets up a simple range trigger for a column_name for one or more tables.
`CreateTypeResponse`	`createType(CreateTypeRequest request)` Creates a new type in GPUdb describing the layout or schema of a table.
`CreateTypeResponse`	`createType(String typeDefinition, String label, Map<String,List<String>> properties, Map<String,String> options)` Creates a new type in GPUdb describing the layout or schema of a table.
`CreateUnionResponse`	`createUnion(CreateUnionRequest request)` Creates a table that is the concatenation of one or more existing tables.
`CreateUnionResponse`	`createUnion(String tableName, List<String> tableNames, List<List<String>> inputColumnNames, List<String> outputColumnNames, Map<String,String> options)` Creates a table that is the concatenation of one or more existing tables.
`CreateUserExternalResponse`	`createUserExternal(CreateUserExternalRequest request)` Creates a new external user (a user whose credentials are managed by an external LDAP).
`CreateUserExternalResponse`	`createUserExternal(String name, Map<String,String> options)` Creates a new external user (a user whose credentials are managed by an external LDAP).
`CreateUserInternalResponse`	`createUserInternal(CreateUserInternalRequest request)` Creates a new internal user (a user whose credentials are managed by GPUdb).
`CreateUserInternalResponse`	`createUserInternal(String name, String password, Map<String,String> options)` Creates a new internal user (a user whose credentials are managed by GPUdb).
`DeleteRecordsResponse`	`deleteRecords(DeleteRecordsRequest request)` Deletes record(s) matching the provided criteria from the given table.
`DeleteRecordsResponse`	`deleteRecords(String tableName, List<String> expressions, Map<String,String> options)` Deletes record(s) matching the provided criteria from the given table.
`DeleteRoleResponse`	`deleteRole(DeleteRoleRequest request)` Deletes an existing role.
`DeleteRoleResponse`	`deleteRole(String name, Map<String,String> options)` Deletes an existing role.
`DeleteUserResponse`	`deleteUser(DeleteUserRequest request)` Deletes an existing user.
`DeleteUserResponse`	`deleteUser(String name, Map<String,String> options)` Deletes an existing user.
`ExecuteProcResponse`	`executeProc(ExecuteProcRequest request)` Executes a proc in the GPUdb Node.js proc server.
`ExecuteProcResponse`	`executeProc(String name, Map<String,String> params, Map<String,ByteBuffer> binParams, Map<String,String> options)` Executes a proc in the GPUdb Node.js proc server.
`FilterResponse`	`filter(FilterRequest request)` Filters data based on the specified expression.
`FilterResponse`	`filter(String tableName, String viewName, String expression, Map<String,String> options)` Filters data based on the specified expression.
`FilterByAreaResponse`	`filterByArea(FilterByAreaRequest request)` Calculates which objects from a table are within a named area of interest (NAI/polygon).
`FilterByAreaResponse`	`filterByArea(String tableName, String viewName, String xColumnName, List<Double> xVector, String yColumnName, List<Double> yVector, Map<String,String> options)` Calculates which objects from a table are within a named area of interest (NAI/polygon).
`FilterByBoxResponse`	`filterByBox(FilterByBoxRequest request)` Calculates how many objects within the given table lie in a rectangular box.
`FilterByBoxResponse`	`filterByBox(String tableName, String viewName, String xColumnName, double minX, double maxX, String yColumnName, double minY, double maxY, Map<String,String> options)` Calculates how many objects within the given table lie in a rectangular box.
`FilterByGeometryResponse`	`filterByGeometry(FilterByGeometryRequest request)` Applies a geometry filter against a spatial column named WKT in a given table, collection or view.
`FilterByGeometryResponse`	`filterByGeometry(String tableName, String viewName, String columnName, String inputWkt, String operation, Map<String,String> options)` Applies a geometry filter against a spatial column named WKT in a given table, collection or view.
`FilterByListResponse`	`filterByList(FilterByListRequest request)` Calculates which records from a table have values in the given list for the corresponding column.
`FilterByListResponse`	`filterByList(String tableName, String viewName, Map<String,List<String>> columnValuesMap, Map<String,String> options)` Calculates which records from a table have values in the given list for the corresponding column.
`FilterByRadiusResponse`	`filterByRadius(FilterByRadiusRequest request)` Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
`FilterByRadiusResponse`	`filterByRadius(String tableName, String viewName, String xColumnName, double xCenter, String yColumnName, double yCenter, double radius, Map<String,String> options)` Calculates which objects from a table lie within a circle with the given radius and center point (i.e.
`FilterByRangeResponse`	`filterByRange(FilterByRangeRequest request)` Calculates which objects from a table have a column that is within the given bounds.
`FilterByRangeResponse`	`filterByRange(String tableName, String viewName, String columnName, double lowerBound, double upperBound, Map<String,String> options)` Calculates which objects from a table have a column that is within the given bounds.
`FilterBySeriesResponse`	`filterBySeries(FilterBySeriesRequest request)` Filters objects matching all points of the given track (works only on track type data).
`FilterBySeriesResponse`	`filterBySeries(String tableName, String viewName, String trackId, List<String> targetTrackIds, Map<String,String> options)` Filters objects matching all points of the given track (works only on track type data).
`FilterByStringResponse`	`filterByString(FilterByStringRequest request)` Calculates which objects from a table, collection, or view match a string expression for the given string columns.
`FilterByStringResponse`	`filterByString(String tableName, String viewName, String expression, String mode, List<String> columnNames, Map<String,String> options)` Calculates which objects from a table, collection, or view match a string expression for the given string columns.
`FilterByTableResponse`	`filterByTable(FilterByTableRequest request)` Filters objects in one table based on objects in another table.
`FilterByTableResponse`	`filterByTable(String tableName, String viewName, String columnName, String sourceTableName, String sourceTableColumnName, Map<String,String> options)` Filters objects in one table based on objects in another table.
`FilterByValueResponse`	`filterByValue(FilterByValueRequest request)` Calculates which objects from a table has a particular value for a particular column.
`FilterByValueResponse`	`filterByValue(String tableName, String viewName, boolean isString, double value, String valueStr, String columnName, Map<String,String> options)` Calculates which objects from a table has a particular value for a particular column.
`<TResponse> GetRecordsResponse<TResponse>`	`getRecords(GetRecordsRequest request)` Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
`<TResponse> GetRecordsResponse<TResponse>`	`getRecords(Object typeDescriptor, GetRecordsRequest request)` Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
`<TResponse> GetRecordsResponse<TResponse>`	`getRecords(Object typeDescriptor, String tableName, long offset, long limit, Map<String,String> options)` Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
`<TResponse> GetRecordsResponse<TResponse>`	`getRecords(String tableName, long offset, long limit, Map<String,String> options)` Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
`GetRecordsByColumnResponse`	`getRecordsByColumn(GetRecordsByColumnRequest request)` For a given table, retrieves the values of the given columns within a given range.
`GetRecordsByColumnResponse`	`getRecordsByColumn(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options)` For a given table, retrieves the values of the given columns within a given range.
`RawGetRecordsByColumnResponse`	`getRecordsByColumnRaw(GetRecordsByColumnRequest request)` For a given table, retrieves the values of the given columns within a given range.
`<TResponse> GetRecordsBySeriesResponse<TResponse>`	`getRecordsBySeries(GetRecordsBySeriesRequest request)` Retrieves the complete series/track records from the given `worldTableName` based on the partial track information contained in the `tableName`.
`<TResponse> GetRecordsBySeriesResponse<TResponse>`	`getRecordsBySeries(Object typeDescriptor, GetRecordsBySeriesRequest request)` Retrieves the complete series/track records from the given `worldTableName` based on the partial track information contained in the `tableName`.
`<TResponse> GetRecordsBySeriesResponse<TResponse>`	`getRecordsBySeries(Object typeDescriptor, String tableName, String worldTableName, int offset, int limit, Map<String,String> options)` Retrieves the complete series/track records from the given `worldTableName` based on the partial track information contained in the `tableName`.
`<TResponse> GetRecordsBySeriesResponse<TResponse>`	`getRecordsBySeries(String tableName, String worldTableName, int offset, int limit, Map<String,String> options)` Retrieves the complete series/track records from the given `worldTableName` based on the partial track information contained in the `tableName`.
`RawGetRecordsBySeriesResponse`	`getRecordsBySeriesRaw(GetRecordsBySeriesRequest request)` Retrieves the complete series/track records from the given `worldTableName` based on the partial track information contained in the `tableName`.
`<TResponse> GetRecordsFromCollectionResponse<TResponse>`	`getRecordsFromCollection(GetRecordsFromCollectionRequest request)` Retrieves records from a collection.
`<TResponse> GetRecordsFromCollectionResponse<TResponse>`	`getRecordsFromCollection(Object typeDescriptor, GetRecordsFromCollectionRequest request)` Retrieves records from a collection.
`<TResponse> GetRecordsFromCollectionResponse<TResponse>`	`getRecordsFromCollection(Object typeDescriptor, String tableName, long offset, long limit, Map<String,String> options)` Retrieves records from a collection.
`<TResponse> GetRecordsFromCollectionResponse<TResponse>`	`getRecordsFromCollection(String tableName, long offset, long limit, Map<String,String> options)` Retrieves records from a collection.
`RawGetRecordsFromCollectionResponse`	`getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest request)` Retrieves records from a collection.
`RawGetRecordsResponse`	`getRecordsRaw(GetRecordsRequest request)` Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column.
`GrantPermissionSystemResponse`	`grantPermissionSystem(GrantPermissionSystemRequest request)` Grants a system-level permission to a user or role.
`GrantPermissionSystemResponse`	`grantPermissionSystem(String name, String permission, Map<String,String> options)` Grants a system-level permission to a user or role.
`GrantPermissionTableResponse`	`grantPermissionTable(GrantPermissionTableRequest request)` Grants a table-level permission to a user or role.
`GrantPermissionTableResponse`	`grantPermissionTable(String name, String permission, String tableName, String filterExpression, Map<String,String> options)` Grants a table-level permission to a user or role.
`GrantRoleResponse`	`grantRole(GrantRoleRequest request)` Grants membership in a role to a user or role.
`GrantRoleResponse`	`grantRole(String role, String member, Map<String,String> options)` Grants membership in a role to a user or role.
`HasTableResponse`	`hasTable(HasTableRequest request)` Checks the existence of a table with the given name in GPUdb.
`HasTableResponse`	`hasTable(String tableName, Map<String,String> options)` Checks the existence of a table with the given name in GPUdb.
`HasTypeResponse`	`hasType(HasTypeRequest request)` Check the existence of a type in GPUdb.
`HasTypeResponse`	`hasType(String typeId, Map<String,String> options)` Check the existence of a type in GPUdb.
`<TRequest> InsertRecordsResponse`	`insertRecords(InsertRecordsRequest<TRequest> request)` Adds multiple records to the specified table.
`<TRequest> InsertRecordsResponse`	`insertRecords(String tableName, List<TRequest> data, Map<String,String> options)` Adds multiple records to the specified table.
`<TRequest> InsertRecordsResponse`	`insertRecords(TypeObjectMap<TRequest> typeObjectMap, InsertRecordsRequest<TRequest> request)` Adds multiple records to the specified table.
`<TRequest> InsertRecordsResponse`	`insertRecords(TypeObjectMap<TRequest> typeObjectMap, String tableName, List<TRequest> data, Map<String,String> options)` Adds multiple records to the specified table.
`InsertRecordsRandomResponse`	`insertRecordsRandom(InsertRecordsRandomRequest request)` Generates a specified number of random records and adds them to the given table.
`InsertRecordsRandomResponse`	`insertRecordsRandom(String tableName, long count, Map<String,Map<String,Double>> options)` Generates a specified number of random records and adds them to the given table.
`InsertRecordsResponse`	`insertRecordsRaw(RawInsertRecordsRequest request)` Adds multiple records to the specified table.
`InsertSymbolResponse`	`insertSymbol(InsertSymbolRequest request)` Adds a symbol or icon (i.e.
`InsertSymbolResponse`	`insertSymbol(String symbolId, String symbolFormat, ByteBuffer symbolData, Map<String,String> options)` Adds a symbol or icon (i.e.
`LockTableResponse`	`lockTable(LockTableRequest request)` Manages global access to a table's data.
`LockTableResponse`	`lockTable(String tableName, String lockType, Map<String,String> options)` Manages global access to a table's data.
`RevokePermissionSystemResponse`	`revokePermissionSystem(RevokePermissionSystemRequest request)` Revokes a system-level permission from a user or role.
`RevokePermissionSystemResponse`	`revokePermissionSystem(String name, String permission, Map<String,String> options)` Revokes a system-level permission from a user or role.
`RevokePermissionTableResponse`	`revokePermissionTable(RevokePermissionTableRequest request)` Revokes a table-level permission from a user or role.
`RevokePermissionTableResponse`	`revokePermissionTable(String name, String permission, String tableName, Map<String,String> options)` Revokes a table-level permission from a user or role.
`RevokeRoleResponse`	`revokeRole(RevokeRoleRequest request)` Revokes membership in a role from a user or role.
`RevokeRoleResponse`	`revokeRole(String role, String member, Map<String,String> options)` Revokes membership in a role from a user or role.
`ShowSecurityResponse`	`showSecurity(List<String> names, Map<String,String> options)` Shows security information relating to users and/or roles.
`ShowSecurityResponse`	`showSecurity(ShowSecurityRequest request)` Shows security information relating to users and/or roles.
`ShowSystemPropertiesResponse`	`showSystemProperties(Map<String,String> options)` Returns server configuration and version related information to the caller.
`ShowSystemPropertiesResponse`	`showSystemProperties(ShowSystemPropertiesRequest request)` Returns server configuration and version related information to the caller.
`ShowSystemStatusResponse`	`showSystemStatus(Map<String,String> options)` Provides server configuration and health related status to the caller.
`ShowSystemStatusResponse`	`showSystemStatus(ShowSystemStatusRequest request)` Provides server configuration and health related status to the caller.
`ShowSystemTimingResponse`	`showSystemTiming(Map<String,String> options)` Returns the last 100 requests made to GPUdb along with the request timing and internal job id.
`ShowSystemTimingResponse`	`showSystemTiming(ShowSystemTimingRequest request)` Returns the last 100 requests made to GPUdb along with the request timing and internal job id.
`ShowTableResponse`	`showTable(ShowTableRequest request)` Retrieves detailed information about a particular GPUdb table, specified in `tableName`.
`ShowTableResponse`	`showTable(String tableName, Map<String,String> options)` Retrieves detailed information about a particular GPUdb table, specified in `tableName`.
`ShowTableMetadataResponse`	`showTableMetadata(List<String> tableNames, Map<String,String> options)` Retrieves the user provided metadata for the specified tables.
`ShowTableMetadataResponse`	`showTableMetadata(ShowTableMetadataRequest request)` Retrieves the user provided metadata for the specified tables.
`ShowTablesByTypeResponse`	`showTablesByType(ShowTablesByTypeRequest request)` Gets names of the tables from GPUdb based on the type information.
`ShowTablesByTypeResponse`	`showTablesByType(String typeId, String label, Map<String,String> options)` Gets names of the tables from GPUdb based on the type information.
`ShowTriggersResponse`	`showTriggers(List<String> triggerIds, Map<String,String> options)` Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.
`ShowTriggersResponse`	`showTriggers(ShowTriggersRequest request)` Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.
`ShowTypesResponse`	`showTypes(ShowTypesRequest request)` Retrieves information for the specified data type.
`ShowTypesResponse`	`showTypes(String typeId, String label, Map<String,String> options)` Retrieves information for the specified data type.
`<TRequest> UpdateRecordsResponse`	`updateRecords(String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<TRequest> data, Map<String,String> options)` Runs multiple predicate-based updates in a single call.
`<TRequest> UpdateRecordsResponse`	`updateRecords(TypeObjectMap<TRequest> typeObjectMap, String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<TRequest> data, Map<String,String> options)` Runs multiple predicate-based updates in a single call.
`<TRequest> UpdateRecordsResponse`	`updateRecords(TypeObjectMap<TRequest> typeObjectMap, UpdateRecordsRequest<TRequest> request)` Runs multiple predicate-based updates in a single call.
`<TRequest> UpdateRecordsResponse`	`updateRecords(UpdateRecordsRequest<TRequest> request)` Runs multiple predicate-based updates in a single call.
`UpdateRecordsBySeriesResponse`	`updateRecordsBySeries(String tableName, String worldTableName, String viewName, List<String> reserved, Map<String,String> options)` Updates the view specified by `tableName` to include full series (track) information from the `worldTableName` for the series (tracks) present in the `viewName`.
`UpdateRecordsBySeriesResponse`	`updateRecordsBySeries(UpdateRecordsBySeriesRequest request)` Updates the view specified by `tableName` to include full series (track) information from the `worldTableName` for the series (tracks) present in the `viewName`.
`UpdateRecordsResponse`	`updateRecordsRaw(RawUpdateRecordsRequest request)` Runs multiple predicate-based updates in a single call.
`VisualizeImageResponse`	`visualizeImage(List<String> tableNames, List<String> worldTableNames, String xColumnName, String yColumnName, List<List<String>> trackIds, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, Map<String,List<String>> styleOptions, Map<String,String> options)`
`VisualizeImageResponse`	`visualizeImage(VisualizeImageRequest request)`
`VisualizeImageClassbreakResponse`	`visualizeImageClassbreak(List<String> tableNames, List<String> worldTableNames, String xColumnName, String yColumnName, List<List<String>> trackIds, String cbColumnName1, List<String> cbVals1, List<String> cbColumnName2, List<List<String>> cbVals2, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, Map<String,List<String>> styleOptions, Map<String,String> options)`
`VisualizeImageClassbreakResponse`	`visualizeImageClassbreak(VisualizeImageClassbreakRequest request)`
`VisualizeImageHeatmapResponse`	`visualizeImageHeatmap(List<String> tableNames, String xColumnName, String yColumnName, String valueColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> styleOptions, Map<String,String> options)`
`VisualizeImageHeatmapResponse`	`visualizeImageHeatmap(VisualizeImageHeatmapRequest request)`
`VisualizeImageLabelsResponse`	`visualizeImageLabels(String tableName, String xColumnName, String yColumnName, String xOffset, String yOffset, String textString, String font, String textColor, String textAngle, String textScale, String drawBox, String drawLeader, String lineWidth, String lineColor, String fillColor, String leaderXColumnName, String leaderYColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, Map<String,String> options)`
`VisualizeImageLabelsResponse`	`visualizeImageLabels(VisualizeImageLabelsRequest request)`
`VisualizeVideoResponse`	`visualizeVideo(List<String> tableNames, List<String> worldTableNames, List<List<String>> trackIds, String xColumnName, String yColumnName, double minX, double maxX, double minY, double maxY, int width, int height, String projection, long bgColor, List<List<Double>> timeIntervals, String videoStyle, String sessionKey, Map<String,List<String>> styleOptions, Map<String,String> options)` Creates raster images of data in the given table based on provided input parameters.
`VisualizeVideoResponse`	`visualizeVideo(VisualizeVideoRequest request)` Creates raster images of data in the given table based on provided input parameters.
`VisualizeVideoHeatmapResponse`	`visualizeVideoHeatmap(List<String> tableNames, String xColumnName, String yColumnName, double minX, double maxX, double minY, double maxY, List<List<Double>> timeIntervals, int width, int height, String projection, String videoStyle, String sessionKey, Map<String,String> styleOptions, Map<String,String> options)`
`VisualizeVideoHeatmapResponse`	`visualizeVideoHeatmap(VisualizeVideoHeatmapRequest request)`

Methods inherited from class com.gpudb.GPUdbBase
addKnownType, addKnownType, addKnownTypeFromTable, addKnownTypeFromTable, addKnownTypeObjectMap, decode, decode, decode, decodeMultiple, decodeMultiple, encode, encode, getApiVersion, getExecutor, getHttpHeaders, getPassword, getThreadCount, getTimeout, getTypeDescriptor, getTypeObjectMap, getURL, getUsername, getUseSnappy, list, options, ping, setTypeDescriptorIfMissing, submitRequest, submitRequest, submitRequest

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GPUdb
```
public GPUdb(String url)
      throws GPUdbException
```
    Creates a GPUdb instance for the GPUdb server at the specified URL using default options. Note that these options cannot be changed subsequently; to use different options, a new GPUdb instance must be created.
    
    Parameters:
    
    url - The URL of the GPUdb server.
    
    Throws:
    
    GPUdbException - if an error occurs during creation.
  - GPUdb
```
public GPUdb(URL url)
      throws GPUdbException
```
    Creates a GPUdb instance for the GPUdb server at the specified URL using default options. Note that these options cannot be changed subsequently; to use different options, a new GPUdb instance must be created.
    
    Parameters:
    
    url - The URL of the GPUdb server.
    
    Throws:
    
    GPUdbException - if an error occurs during creation.
  - GPUdb
```
public GPUdb(String url,
             GPUdbBase.Options options)
      throws GPUdbException
```
    Creates a GPUdb instance for the GPUdb server at the specified URL using the specified options. Note that these options cannot be changed subsequently; to use different options, a new GPUdb instance must be created.
    
    Parameters:
    
    url - The URL of the GPUdb server.
    
    options - The options to use.
    
    Throws:
    
    GPUdbException - if an error occurs during creation.
  - GPUdb
```
public GPUdb(URL url,
             GPUdbBase.Options options)
      throws GPUdbException
```
    Creates a GPUdb instance for the GPUdb server at the specified URL using the specified options. Note that these options cannot be changed subsequently; to use different options, a new GPUdb instance must be created.
    
    Parameters:
    
    url - The URL of the GPUdb server.
    
    options - The options to use.
    
    Throws:
    
    GPUdbException - if an error occurs during creation.
- Method Detail
  - adminDeleteNode
```
public AdminDeleteNodeResponse adminDeleteNode(AdminDeleteNodeRequest request)
                                        throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminDeleteNode
```
public AdminDeleteNodeResponse adminDeleteNode(int rank,
                                               String authorization,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminGetShardAssignments
```
public AdminGetShardAssignmentsResponse adminGetShardAssignments(AdminGetShardAssignmentsRequest request)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminGetShardAssignments
```
public AdminGetShardAssignmentsResponse adminGetShardAssignments(Map<String,String> options)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminOffline
```
public AdminOfflineResponse adminOffline(AdminOfflineRequest request)
                                  throws GPUdbException
```
    Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminOfflineResponse
  - adminOffline
```
public AdminOfflineResponse adminOffline(boolean offline,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminOfflineResponse
  - adminRebalance
```
public AdminRebalanceResponse adminRebalance(AdminRebalanceRequest request)
                                      throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminRebalance
```
public AdminRebalanceResponse adminRebalance(List<String> tableNames,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminSetShardAssignments
```
public AdminSetShardAssignmentsResponse adminSetShardAssignments(AdminSetShardAssignmentsRequest request)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminSetShardAssignments
```
public AdminSetShardAssignmentsResponse adminSetShardAssignments(long version,
                                                                 boolean partialReassignment,
                                                                 List<Integer> shardAssignmentsRank,
                                                                 List<Integer> shardAssignmentsTom,
                                                                 List<Integer> assignmentIndex,
                                                                 Map<String,String> options)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminShutdown
```
public AdminShutdownResponse adminShutdown(AdminShutdownRequest request)
                                    throws GPUdbException
```
    Exits the GPUdb server application.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminShutdownResponse
  - adminShutdown
```
public AdminShutdownResponse adminShutdown(String exitType,
                                           String authorization,
                                           Map<String,String> options)
                                    throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminShutdownResponse
  - adminVerifyDb
```
public AdminVerifyDbResponse adminVerifyDb(AdminVerifyDbRequest request)
                                    throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminVerifyDbResponse
  - adminVerifyDb
```
public AdminVerifyDbResponse adminVerifyDb(Map<String,String> options)
                                    throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminVerifyDbResponse
  - aggregateConvexHull
```
public AggregateConvexHullResponse aggregateConvexHull(AggregateConvexHullRequest request)
                                                throws GPUdbException
```
    Calculates and returns the convex hull for the values in a table specified by tableName.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateConvexHullResponse
  - aggregateConvexHull
```
public AggregateConvexHullResponse aggregateConvexHull(String tableName,
                                                       String xColumnName,
                                                       String yColumnName,
                                                       Map<String,String> options)
                                                throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateConvexHullResponse
  - aggregateGroupByRaw
```
public RawAggregateGroupByResponse aggregateGroupByRaw(AggregateGroupByRequest request)
                                                throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RawAggregateGroupByResponse
  - aggregateGroupBy
```
public AggregateGroupByResponse aggregateGroupBy(AggregateGroupByRequest request)
                                          throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateGroupByResponse
  - aggregateGroupBy
```
public AggregateGroupByResponse aggregateGroupBy(String tableName,
                                                 List<String> columnNames,
                                                 long offset,
                                                 long limit,
                                                 Map<String,String> options)
                                          throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of 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.
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateGroupByResponse
  - aggregateHistogram
```
public AggregateHistogramResponse aggregateHistogram(AggregateHistogramRequest request)
                                              throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateHistogramResponse
  - aggregateHistogram
```
public AggregateHistogramResponse aggregateHistogram(String tableName,
                                                     String columnName,
                                                     double start,
                                                     double end,
                                                     double interval,
                                                     Map<String,String> options)
                                              throws GPUdbException
```
    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).
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateHistogramResponse
  - aggregateKMeans
```
public AggregateKMeansResponse aggregateKMeans(AggregateKMeansRequest request)
                                        throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateKMeansResponse
  - aggregateKMeans
```
public AggregateKMeansResponse aggregateKMeans(String tableName,
                                               List<String> columnNames,
                                               int k,
                                               double tolerance,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateKMeansResponse
  - aggregateMinMax
```
public AggregateMinMaxResponse aggregateMinMax(AggregateMinMaxRequest request)
                                        throws GPUdbException
```
    Calculates and returns the minimum and maximum values of a particular column in a table.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateMinMaxResponse
  - aggregateMinMax
```
public AggregateMinMaxResponse aggregateMinMax(String tableName,
                                               String columnName,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateMinMaxResponse
  - aggregateStatistics
```
public AggregateStatisticsResponse aggregateStatistics(AggregateStatisticsRequest request)
                                                throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateStatisticsResponse
  - aggregateStatistics
```
public AggregateStatisticsResponse aggregateStatistics(String tableName,
                                                       String columnName,
                                                       String stats,
                                                       Map<String,String> options)
                                                throws GPUdbException
```
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateStatisticsResponse
  - aggregateStatisticsByRange
```
public AggregateStatisticsByRangeResponse aggregateStatisticsByRange(AggregateStatisticsByRangeRequest request)
                                                              throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateStatisticsByRangeResponse
  - aggregateStatisticsByRange
```
public AggregateStatisticsByRangeResponse aggregateStatisticsByRange(String tableName,
                                                                     String selectExpression,
                                                                     String columnName,
                                                                     String valueColumnName,
                                                                     String stats,
                                                                     double start,
                                                                     double end,
                                                                     double interval,
                                                                     Map<String,String> options)
                                                              throws GPUdbException
```
    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.
    
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateStatisticsByRangeResponse
  - aggregateUniqueRaw
```
public RawAggregateUniqueResponse aggregateUniqueRaw(AggregateUniqueRequest request)
                                              throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RawAggregateUniqueResponse
  - aggregateUnique
```
public AggregateUniqueResponse aggregateUnique(AggregateUniqueRequest request)
                                        throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateUniqueResponse
  - aggregateUnique
```
public AggregateUniqueResponse aggregateUnique(String tableName,
                                               String columnName,
                                               long offset,
                                               long limit,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of 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.
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateUniqueResponse
  - alterSystemProperties
```
public AlterSystemPropertiesResponse alterSystemProperties(AlterSystemPropertiesRequest request)
                                                    throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterSystemPropertiesResponse
  - alterSystemProperties
```
public AlterSystemPropertiesResponse alterSystemProperties(Map<String,String> propertyUpdatesMap,
                                                           Map<String,String> options)
                                                    throws GPUdbException
```
    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 = expressions. Expressions are: num_transactions = where is the number of request reply transactions to invoke per test; message_size = where bytes is the size of the messages to send in bytes; check_values = 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 = expressions. Expressions are: seconds = where time is the time in seconds to run the test; data_size = where is the size in bytes of the block to be transferred; threads = ; to_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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterSystemPropertiesResponse
  - alterTable
```
public AlterTableResponse alterTable(AlterTableRequest request)
                              throws GPUdbException
```
    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(GetRecordsRequest), deleteRecords(DeleteRecordsRequest), updateRecordsRaw(RawUpdateRecordsRequest)) 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(ClearTableRequest) 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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterTableResponse
  - alterTable
```
public AlterTableResponse alterTable(String tableName,
                                     String action,
                                     String value,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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(GetRecordsRequest), deleteRecords(String, List, Map), updateRecordsRaw(RawUpdateRecordsRequest)) 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(String, String, Map) 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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterTableResponse
  - alterTableMetadata
```
public AlterTableMetadataResponse alterTableMetadata(AlterTableMetadataRequest request)
                                              throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterTableMetadataResponse
  - alterTableMetadata
```
public AlterTableMetadataResponse alterTableMetadata(List<String> tableNames,
                                                     Map<String,String> metadataMap,
                                                     Map<String,String> options)
                                              throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterTableMetadataResponse
  - alterUser
```
public AlterUserResponse alterUser(AlterUserRequest request)
                            throws GPUdbException
```
    Alters a user.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterUserResponse
  - alterUser
```
public AlterUserResponse alterUser(String name,
                                   String action,
                                   String value,
                                   Map<String,String> options)
                            throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterUserResponse
  - clearTable
```
public ClearTableResponse clearTable(ClearTableRequest request)
                              throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTableResponse
  - clearTable
```
public ClearTableResponse clearTable(String tableName,
                                     String authorization,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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.
    
    authorization - No longer used. User can pass an empty string.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTableResponse
  - clearTableMonitor
```
public ClearTableMonitorResponse clearTableMonitor(ClearTableMonitorRequest request)
                                            throws GPUdbException
```
    Deactivates a table monitor previously created with createTableMonitor(CreateTableMonitorRequest).
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTableMonitorResponse
  - clearTableMonitor
```
public ClearTableMonitorResponse clearTableMonitor(String topicId,
                                                   Map<String,String> options)
                                            throws GPUdbException
```
    Deactivates a table monitor previously created with createTableMonitor(String, Map).
    
    Parameters:
    
    topicId - The topic ID returned by createTableMonitor(String, Map).
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTableMonitorResponse
  - clearTrigger
```
public ClearTriggerResponse clearTrigger(ClearTriggerRequest request)
                                  throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTriggerResponse
  - clearTrigger
```
public ClearTriggerResponse clearTrigger(String triggerId,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTriggerResponse
  - createJoinTable
```
public CreateJoinTableResponse createJoinTable(CreateJoinTableRequest request)
                                        throws GPUdbException
```
    Creates a table that is the result of a SQL JOIN. For details see: join concept documentation.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateJoinTableResponse
  - createJoinTable
```
public CreateJoinTableResponse createJoinTable(String joinTableName,
                                               List<String> tableNames,
                                               List<String> aliases,
                                               String expression,
                                               List<String> expressions,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    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.
    
    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.
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateJoinTableResponse
  - createRole
```
public CreateRoleResponse createRole(CreateRoleRequest request)
                              throws GPUdbException
```
    Creates a new role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateRoleResponse
  - createRole
```
public CreateRoleResponse createRole(String name,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateRoleResponse
  - createTable
```
public CreateTableResponse createTable(CreateTableRequest request)
                                throws GPUdbException
```
    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(CreateTypeRequest)). 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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTableResponse
  - createTable
```
public CreateTableResponse createTable(String tableName,
                                       String typeId,
                                       Map<String,String> options)
                                throws GPUdbException
```
    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(String, String, Map, Map)). 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)'.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTableResponse
  - createTableMonitor
```
public CreateTableMonitorResponse createTableMonitor(CreateTableMonitorRequest request)
                                              throws GPUdbException
```
    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(ClearTableMonitorRequest).
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTableMonitorResponse
  - createTableMonitor
```
public CreateTableMonitorResponse createTableMonitor(String tableName,
                                                     Map<String,String> options)
                                              throws GPUdbException
```
    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(String, Map).
    
    Parameters:
    
    tableName - Name of the table to monitor. Must not refer to a collection.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTableMonitorResponse
  - createTriggerByArea
```
public CreateTriggerByAreaResponse createTriggerByArea(CreateTriggerByAreaRequest request)
                                                throws GPUdbException
```
    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(CreateTriggerByRangeRequest).) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(RawInsertRecordsRequest) 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(ShowSystemStatusRequest)-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(ClearTriggerRequest) 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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTriggerByAreaResponse
  - createTriggerByArea
```
public CreateTriggerByAreaResponse createTriggerByArea(String requestId,
                                                       List<String> tableNames,
                                                       String xColumnName,
                                                       List<Double> xVector,
                                                       String yColumnName,
                                                       List<Double> yVector,
                                                       Map<String,String> options)
                                                throws GPUdbException
```
    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(String, List, String, double, double, Map).) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(RawInsertRecordsRequest) 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(Map)-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(String, Map) 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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTriggerByAreaResponse
  - createTriggerByRange
```
public CreateTriggerByRangeResponse createTriggerByRange(CreateTriggerByRangeRequest request)
                                                  throws GPUdbException
```
    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(RawInsertRecordsRequest) 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(ShowSystemStatusRequest)-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(ClearTriggerRequest) 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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTriggerByRangeResponse
  - createTriggerByRange
```
public CreateTriggerByRangeResponse createTriggerByRange(String requestId,
                                                         List<String> tableNames,
                                                         String columnName,
                                                         double min,
                                                         double max,
                                                         Map<String,String> options)
                                                  throws GPUdbException
```
    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(RawInsertRecordsRequest) 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(Map)-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(String, Map) 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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTriggerByRangeResponse
  - createType
```
public CreateTypeResponse createType(CreateTypeRequest request)
                              throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTypeResponse
  - createType
```
public CreateTypeResponse createType(String typeDefinition,
                                     String label,
                                     Map<String,List<String>> properties,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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).
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateTypeResponse
  - createUnion
```
public CreateUnionResponse createUnion(CreateUnionRequest request)
                                throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUnionResponse
  - createUnion
```
public CreateUnionResponse createUnion(String tableName,
                                       List<String> tableNames,
                                       List<List<String>> inputColumnNames,
                                       List<String> outputColumnNames,
                                       Map<String,String> options)
                                throws GPUdbException
```
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUnionResponse
  - createUserExternal
```
public CreateUserExternalResponse createUserExternal(CreateUserExternalRequest request)
                                              throws GPUdbException
```
    Creates a new external user (a user whose credentials are managed by an external LDAP).
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUserExternalResponse
  - createUserExternal
```
public CreateUserExternalResponse createUserExternal(String name,
                                                     Map<String,String> options)
                                              throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUserExternalResponse
  - createUserInternal
```
public CreateUserInternalResponse createUserInternal(CreateUserInternalRequest request)
                                              throws GPUdbException
```
    Creates a new internal user (a user whose credentials are managed by GPUdb).
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUserInternalResponse
  - createUserInternal
```
public CreateUserInternalResponse createUserInternal(String name,
                                                     String password,
                                                     Map<String,String> options)
                                              throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUserInternalResponse
  - deleteRecords
```
public DeleteRecordsResponse deleteRecords(DeleteRecordsRequest request)
                                    throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteRecordsResponse
  - deleteRecords
```
public DeleteRecordsResponse deleteRecords(String tableName,
                                           List<String> expressions,
                                           Map<String,String> options)
                                    throws GPUdbException
```
    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 here. 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 insertion of the record or by calling getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest) with the *return_record_ids* option.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteRecordsResponse
  - deleteRole
```
public DeleteRoleResponse deleteRole(DeleteRoleRequest request)
                              throws GPUdbException
```
    Deletes an existing role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteRoleResponse
  - deleteRole
```
public DeleteRoleResponse deleteRole(String name,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteRoleResponse
  - deleteUser
```
public DeleteUserResponse deleteUser(DeleteUserRequest request)
                              throws GPUdbException
```
    Deletes an existing user.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteUserResponse
  - deleteUser
```
public DeleteUserResponse deleteUser(String name,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteUserResponse
  - executeProc
```
public ExecuteProcResponse executeProc(ExecuteProcRequest request)
                                throws GPUdbException
```
    Executes a proc in the GPUdb Node.js proc server.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ExecuteProcResponse
  - executeProc
```
public ExecuteProcResponse executeProc(String name,
                                       Map<String,String> params,
                                       Map<String,ByteBuffer> binParams,
                                       Map<String,String> options)
                                throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ExecuteProcResponse
  - filter
```
public FilterResponse filter(FilterRequest request)
                      throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterResponse
  - filter
```
public FilterResponse filter(String tableName,
                             String viewName,
                             String expression,
                             Map<String,String> options)
                      throws GPUdbException
```
    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 .
    
    expression - The select expression GPUdb uses to filter the specified table. For details see concepts.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterResponse
  - filterByArea
```
public FilterByAreaResponse filterByArea(FilterByAreaRequest request)
                                  throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByAreaResponse
  - filterByArea
```
public FilterByAreaResponse filterByArea(String tableName,
                                         String viewName,
                                         String xColumnName,
                                         List<Double> xVector,
                                         String yColumnName,
                                         List<Double> yVector,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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.
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByAreaResponse
  - filterByBox
```
public FilterByBoxResponse filterByBox(FilterByBoxRequest request)
                                throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByBoxResponse
  - filterByBox
```
public FilterByBoxResponse filterByBox(String tableName,
                                       String viewName,
                                       String xColumnName,
                                       double minX,
                                       double maxX,
                                       String yColumnName,
                                       double minY,
                                       double maxY,
                                       Map<String,String> options)
                                throws GPUdbException
```
    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.
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByBoxResponse
  - filterByGeometry
```
public FilterByGeometryResponse filterByGeometry(FilterByGeometryRequest request)
                                          throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByGeometryResponse
  - filterByGeometry
```
public FilterByGeometryResponse filterByGeometry(String tableName,
                                                 String viewName,
                                                 String columnName,
                                                 String inputWkt,
                                                 String operation,
                                                 Map<String,String> options)
                                          throws GPUdbException
```
    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.
    
    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.
    
    operation - The geometric filtering operation to perform Values: contains, crosses, disjoint, equals, intersects, overlaps, touches, within.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByGeometryResponse
  - filterByList
```
public FilterByListResponse filterByList(FilterByListRequest request)
                                  throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByListResponse
  - filterByList
```
public FilterByListResponse filterByList(String tableName,
                                         String viewName,
                                         Map<String,List<String>> columnValuesMap,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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.
    
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByListResponse
  - filterByRadius
```
public FilterByRadiusResponse filterByRadius(FilterByRadiusRequest request)
                                      throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByRadiusResponse
  - filterByRadius
```
public FilterByRadiusResponse filterByRadius(String tableName,
                                             String viewName,
                                             String xColumnName,
                                             double xCenter,
                                             String yColumnName,
                                             double yCenter,
                                             double radius,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    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.
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByRadiusResponse
  - filterByRange
```
public FilterByRangeResponse filterByRange(FilterByRangeRequest request)
                                    throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByRangeResponse
  - filterByRange
```
public FilterByRangeResponse filterByRange(String tableName,
                                           String viewName,
                                           String columnName,
                                           double lowerBound,
                                           double upperBound,
                                           Map<String,String> options)
                                    throws GPUdbException
```
    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.
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByRangeResponse
  - filterBySeries
```
public FilterBySeriesResponse filterBySeries(FilterBySeriesRequest request)
                                      throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterBySeriesResponse
  - filterBySeries
```
public FilterBySeriesResponse filterBySeries(String tableName,
                                             String viewName,
                                             String trackId,
                                             List<String> targetTrackIds,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    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.
    
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterBySeriesResponse
  - filterByString
```
public FilterByStringResponse filterByString(FilterByStringRequest request)
                                      throws GPUdbException
```
    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 [ TO ] and exclusive { TO }. 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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByStringResponse
  - filterByString
```
public FilterByStringResponse filterByString(String tableName,
                                             String viewName,
                                             String expression,
                                             String mode,
                                             List<String> columnNames,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    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 [ TO ] and exclusive { TO }. 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.
    
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByStringResponse
  - filterByTable
```
public FilterByTableResponse filterByTable(FilterByTableRequest request)
                                    throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByTableResponse
  - filterByTable
```
public FilterByTableResponse filterByTable(String tableName,
                                           String viewName,
                                           String columnName,
                                           String sourceTableName,
                                           String sourceTableColumnName,
                                           Map<String,String> options)
                                    throws GPUdbException
```
    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.
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByTableResponse
  - filterByValue
```
public FilterByValueResponse filterByValue(FilterByValueRequest request)
                                    throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByValueResponse
  - filterByValue
```
public FilterByValueResponse filterByValue(String tableName,
                                           String viewName,
                                           boolean isString,
                                           double value,
                                           String valueStr,
                                           String columnName,
                                           Map<String,String> options)
                                    throws GPUdbException
```
    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.
    
    isString - Indicates whether the value being searched for is string or numeric.
    
    value - The value to search for.
    
    valueStr - The string value to search for.
    
    columnName - Name of a column or an expression of one or more columns on which the filter by value would be applied.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByValueResponse
  - getRecordsRaw
```
public RawGetRecordsResponse getRecordsRaw(GetRecordsRequest request)
                                    throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RawGetRecordsResponse
  - getRecords
```
public <TResponse> GetRecordsResponse<TResponse> getRecords(Object typeDescriptor,
                                                            GetRecordsRequest request)
                                                     throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    typeDescriptor - Type descriptor used for decoding returned objects.
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsResponse
  - getRecords
```
public <TResponse> GetRecordsResponse<TResponse> getRecords(Object typeDescriptor,
                                                            String tableName,
                                                            long offset,
                                                            long limit,
                                                            Map<String,String> options)
                                                     throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    typeDescriptor - Type descriptor used for decoding returned objects.
    
    tableName - Name of the table from which the records will be fetched. Must be a table, view or homogeneous collection.
    
    offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsResponse
  - getRecords
```
public <TResponse> GetRecordsResponse<TResponse> getRecords(GetRecordsRequest request)
                                                     throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsResponse
  - getRecords
```
public <TResponse> GetRecordsResponse<TResponse> getRecords(String tableName,
                                                            long offset,
                                                            long limit,
                                                            Map<String,String> options)
                                                     throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    Type 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). 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.
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsResponse
  - getRecordsByColumnRaw
```
public RawGetRecordsByColumnResponse getRecordsByColumnRaw(GetRecordsByColumnRequest request)
                                                    throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RawGetRecordsByColumnResponse
  - getRecordsByColumn
```
public GetRecordsByColumnResponse getRecordsByColumn(GetRecordsByColumnRequest request)
                                              throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsByColumnResponse
  - getRecordsByColumn
```
public GetRecordsByColumnResponse getRecordsByColumn(String tableName,
                                                     List<String> columnNames,
                                                     long offset,
                                                     long limit,
                                                     Map<String,String> options)
                                              throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsByColumnResponse
  - getRecordsBySeriesRaw
```
public RawGetRecordsBySeriesResponse getRecordsBySeriesRaw(GetRecordsBySeriesRequest request)
                                                    throws GPUdbException
```
    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(GetRecordsRequest) 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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RawGetRecordsBySeriesResponse
  - getRecordsBySeries
```
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(Object typeDescriptor,
                                                                            GetRecordsBySeriesRequest request)
                                                                     throws GPUdbException
```
    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(Object, GetRecordsRequest) 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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    typeDescriptor - Type descriptor used for decoding returned objects.
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsBySeriesResponse
  - getRecordsBySeries
```
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(Object typeDescriptor,
                                                                            String tableName,
                                                                            String worldTableName,
                                                                            int offset,
                                                                            int limit,
                                                                            Map<String,String> options)
                                                                     throws GPUdbException
```
    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(Object, String, long, long, Map) 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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    typeDescriptor - Type descriptor used for decoding returned objects.
    
    tableName - Name of the collection/table/view for which series/tracks will be fetched.
    
    worldTableName - Name of the table containing the complete series/track information to be returned for the tracks present in the tableName. Typically this is used when retrieving series/tracks from a view (which contains partial series/tracks) but the user wants to retrieve the entire original series/tracks. Can be blank.
    
    offset - A positive integer indicating the number of initial series/tracks to skip (useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsBySeriesResponse
  - getRecordsBySeries
```
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(GetRecordsBySeriesRequest request)
                                                                     throws GPUdbException
```
    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(GetRecordsRequest) 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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsBySeriesResponse
  - getRecordsBySeries
```
public <TResponse> GetRecordsBySeriesResponse<TResponse> getRecordsBySeries(String tableName,
                                                                            String worldTableName,
                                                                            int offset,
                                                                            int limit,
                                                                            Map<String,String> options)
                                                                     throws GPUdbException
```
    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(String, long, long, Map) 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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type 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). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsBySeriesResponse
  - getRecordsFromCollectionRaw
```
public RawGetRecordsFromCollectionResponse getRecordsFromCollectionRaw(GetRecordsFromCollectionRequest request)
                                                                throws GPUdbException
```
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(DeleteRecordsRequest).
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RawGetRecordsFromCollectionResponse
  - getRecordsFromCollection
```
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(Object typeDescriptor,
                                                                                        GetRecordsFromCollectionRequest request)
                                                                                 throws GPUdbException
```
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(DeleteRecordsRequest).
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    typeDescriptor - Type descriptor used for decoding returned objects.
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsFromCollectionResponse
  - getRecordsFromCollection
```
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(Object typeDescriptor,
                                                                                        String tableName,
                                                                                        long offset,
                                                                                        long limit,
                                                                                        Map<String,String> options)
                                                                                 throws GPUdbException
```
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(String, List, Map).
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    typeDescriptor - Type descriptor 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). 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.
    options -
    
    return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: true, false.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeDescriptor is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsFromCollectionResponse
  - getRecordsFromCollection
```
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(GetRecordsFromCollectionRequest request)
                                                                                 throws GPUdbException
```
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(DeleteRecordsRequest).
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    
    Type Parameters:
    
    TResponse - The type of object being retrieved.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsFromCollectionResponse
  - getRecordsFromCollection
```
public <TResponse> GetRecordsFromCollectionResponse<TResponse> getRecordsFromCollection(String tableName,
                                                                                        long offset,
                                                                                        long limit,
                                                                                        Map<String,String> options)
                                                                                 throws GPUdbException
```
    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as deleteRecords(String, List, Map).
    
    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. The Raw version of this method can be used to specify the encoding scheme of the response.
    Type 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). 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.
    options -
    
    return_record_ids: If 'true' then return GPUdb's internal record id along with each returned record. Default is 'false'. Values: true, false.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetRecordsFromCollectionResponse
  - grantPermissionSystem
```
public GrantPermissionSystemResponse grantPermissionSystem(GrantPermissionSystemRequest request)
                                                    throws GPUdbException
```
    Grants a system-level permission to a user or role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantPermissionSystemResponse
  - grantPermissionSystem
```
public GrantPermissionSystemResponse grantPermissionSystem(String name,
                                                           String permission,
                                                           Map<String,String> options)
                                                    throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantPermissionSystemResponse
  - grantPermissionTable
```
public GrantPermissionTableResponse grantPermissionTable(GrantPermissionTableRequest request)
                                                  throws GPUdbException
```
    Grants a table-level permission to a user or role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantPermissionTableResponse
  - grantPermissionTable
```
public GrantPermissionTableResponse grantPermissionTable(String name,
                                                         String permission,
                                                         String tableName,
                                                         String filterExpression,
                                                         Map<String,String> options)
                                                  throws GPUdbException
```
    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.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantPermissionTableResponse
  - grantRole
```
public GrantRoleResponse grantRole(GrantRoleRequest request)
                            throws GPUdbException
```
    Grants membership in a role to a user or role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantRoleResponse
  - grantRole
```
public GrantRoleResponse grantRole(String role,
                                   String member,
                                   Map<String,String> options)
                            throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantRoleResponse
  - hasTable
```
public HasTableResponse hasTable(HasTableRequest request)
                          throws GPUdbException
```
    Checks the existence of a table with the given name in GPUdb.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    HasTableResponse
  - hasTable
```
public HasTableResponse hasTable(String tableName,
                                 Map<String,String> options)
                          throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    HasTableResponse
  - hasType
```
public HasTypeResponse hasType(HasTypeRequest request)
                        throws GPUdbException
```
    Check the existence of a type in GPUdb.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    HasTypeResponse
  - hasType
```
public HasTypeResponse hasType(String typeId,
                               Map<String,String> options)
                        throws GPUdbException
```
    Check the existence of a type in GPUdb.
    
    Parameters:
    
    typeId - Id of the type returned by GPUdb in response to createType(String, String, Map, Map) request.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    HasTypeResponse
  - insertRecordsRaw
```
public InsertRecordsResponse insertRecordsRaw(RawInsertRecordsRequest request)
                                       throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsResponse
  - insertRecords
```
public <TRequest> InsertRecordsResponse insertRecords(InsertRecordsRequest<TRequest> request)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Type Parameters:
    
    TRequest - The type of object being added.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsResponse
  - insertRecords
```
public <TRequest> InsertRecordsResponse insertRecords(TypeObjectMap<TRequest> typeObjectMap,
                                                      InsertRecordsRequest<TRequest> request)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Type Parameters:
    
    TRequest - The type of object being added.
    
    Parameters:
    
    typeObjectMap - Type object map used for encoding input objects.
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeObjectMap is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsResponse
  - insertRecords
```
public <TRequest> InsertRecordsResponse insertRecords(String tableName,
                                                      List<TRequest> data,
                                                      Map<String,String> options)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    Type 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 primary key, 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
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsResponse
  - insertRecords
```
public <TRequest> InsertRecordsResponse insertRecords(TypeObjectMap<TRequest> typeObjectMap,
                                                      String tableName,
                                                      List<TRequest> data,
                                                      Map<String,String> options)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    Type Parameters:
    
    TRequest - The type of object being added.
    
    Parameters:
    
    typeObjectMap - Type object map used for encoding input objects.
    
    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 primary key, 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
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeObjectMap is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsResponse
  - insertRecordsRandom
```
public InsertRecordsRandomResponse insertRecordsRandom(InsertRecordsRandomRequest request)
                                                throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsRandomResponse
  - insertRecordsRandom
```
public InsertRecordsRandomResponse insertRecordsRandom(String tableName,
                                                       long count,
                                                       Map<String,Map<String,Double>> options)
                                                throws GPUdbException
```
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertRecordsRandomResponse
  - insertSymbol
```
public InsertSymbolResponse insertSymbol(InsertSymbolRequest request)
                                  throws GPUdbException
```
    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(VisualizeImageRequest)) if the 'dosymbology' parameter is 'true' then GPUdb uses the value of the 'SYMBOLCODE' column to pick the symbol displayed for each point.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertSymbolResponse
  - insertSymbol
```
public InsertSymbolResponse insertSymbol(String symbolId,
                                         String symbolFormat,
                                         ByteBuffer symbolData,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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(List, List, String, String, List, double, double, double, double, int, int, String, long, Map, Map)) 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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertSymbolResponse
  - lockTable
```
public LockTableResponse lockTable(LockTableRequest request)
                            throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    LockTableResponse
  - lockTable
```
public LockTableResponse lockTable(String tableName,
                                   String lockType,
                                   Map<String,String> options)
                            throws GPUdbException
```
    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.
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    LockTableResponse
  - revokePermissionSystem
```
public RevokePermissionSystemResponse revokePermissionSystem(RevokePermissionSystemRequest request)
                                                      throws GPUdbException
```
    Revokes a system-level permission from a user or role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokePermissionSystemResponse
  - revokePermissionSystem
```
public RevokePermissionSystemResponse revokePermissionSystem(String name,
                                                             String permission,
                                                             Map<String,String> options)
                                                      throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokePermissionSystemResponse
  - revokePermissionTable
```
public RevokePermissionTableResponse revokePermissionTable(RevokePermissionTableRequest request)
                                                    throws GPUdbException
```
    Revokes a table-level permission from a user or role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokePermissionTableResponse
  - revokePermissionTable
```
public RevokePermissionTableResponse revokePermissionTable(String name,
                                                           String permission,
                                                           String tableName,
                                                           Map<String,String> options)
                                                    throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokePermissionTableResponse
  - revokeRole
```
public RevokeRoleResponse revokeRole(RevokeRoleRequest request)
                              throws GPUdbException
```
    Revokes membership in a role from a user or role.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokeRoleResponse
  - revokeRole
```
public RevokeRoleResponse revokeRole(String role,
                                     String member,
                                     Map<String,String> options)
                              throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokeRoleResponse
  - showSecurity
```
public ShowSecurityResponse showSecurity(ShowSecurityRequest request)
                                  throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSecurityResponse
  - showSecurity
```
public ShowSecurityResponse showSecurity(List<String> names,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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 results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSecurityResponse
  - showSystemProperties
```
public ShowSystemPropertiesResponse showSystemProperties(ShowSystemPropertiesRequest request)
                                                  throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSystemPropertiesResponse
  - showSystemProperties
```
public ShowSystemPropertiesResponse showSystemProperties(Map<String,String> options)
                                                  throws GPUdbException
```
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSystemPropertiesResponse
  - showSystemStatus
```
public ShowSystemStatusResponse showSystemStatus(ShowSystemStatusRequest request)
                                          throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSystemStatusResponse
  - showSystemStatus
```
public ShowSystemStatusResponse showSystemStatus(Map<String,String> options)
                                          throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSystemStatusResponse
  - showSystemTiming
```
public ShowSystemTimingResponse showSystemTiming(ShowSystemTimingRequest request)
                                          throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSystemTimingResponse
  - showSystemTiming
```
public ShowSystemTimingResponse showSystemTiming(Map<String,String> options)
                                          throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowSystemTimingResponse
  - showTable
```
public ShowTableResponse showTable(ShowTableRequest request)
                            throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTableResponse
  - showTable
```
public ShowTableResponse showTable(String tableName,
                                   Map<String,String> options)
                            throws GPUdbException
```
    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.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTableResponse
  - showTableMetadata
```
public ShowTableMetadataResponse showTableMetadata(ShowTableMetadataRequest request)
                                            throws GPUdbException
```
    Retrieves the user provided metadata for the specified tables.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTableMetadataResponse
  - showTableMetadata
```
public ShowTableMetadataResponse showTableMetadata(List<String> tableNames,
                                                   Map<String,String> options)
                                            throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTableMetadataResponse
  - showTablesByType
```
public ShowTablesByTypeResponse showTablesByType(ShowTablesByTypeRequest request)
                                          throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTablesByTypeResponse
  - showTablesByType
```
public ShowTablesByTypeResponse showTablesByType(String typeId,
                                                 String label,
                                                 Map<String,String> options)
                                          throws GPUdbException
```
    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 createType(String, String, Map, Map).
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTablesByTypeResponse
  - showTriggers
```
public ShowTriggersResponse showTriggers(ShowTriggersRequest request)
                                  throws GPUdbException
```
    Retrieves information regarding the specified triggers or all existing triggers currently active within GPUdb.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTriggersResponse
  - showTriggers
```
public ShowTriggersResponse showTriggers(List<String> triggerIds,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTriggersResponse
  - showTypes
```
public ShowTypesResponse showTypes(ShowTypesRequest request)
                            throws GPUdbException
```
    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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTypesResponse
  - showTypes
```
public ShowTypesResponse showTypes(String typeId,
                                   String label,
                                   Map<String,String> options)
                            throws GPUdbException
```
    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 createType(String, String, Map, Map).
    
    label - Option string that was supplied by user in a call to createType(String, String, Map, Map).
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowTypesResponse
  - updateRecordsRaw
```
public UpdateRecordsResponse updateRecordsRaw(RawUpdateRecordsRequest request)
                                       throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsResponse
  - updateRecords
```
public <TRequest> UpdateRecordsResponse updateRecords(UpdateRecordsRequest<TRequest> request)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Type Parameters:
    
    TRequest - The type of object being added.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsResponse
  - updateRecords
```
public <TRequest> UpdateRecordsResponse updateRecords(TypeObjectMap<TRequest> typeObjectMap,
                                                      UpdateRecordsRequest<TRequest> request)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    
    Type Parameters:
    
    TRequest - The type of object being added.
    
    Parameters:
    
    typeObjectMap - Type object map used for encoding input objects.
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeObjectMap is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsResponse
  - updateRecords
```
public <TRequest> UpdateRecordsResponse updateRecords(String tableName,
                                                      List<String> expressions,
                                                      List<Map<String,String>> newValuesMaps,
                                                      List<TRequest> data,
                                                      Map<String,String> options)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    Type 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 here.
    
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    
    data - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
    options - Optional parameters.
    
    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 insertRecords(String, List, Map). Values: true, false.
    record_id: ID of a single record to be updated (returned in the call to insertRecords(String, List, Map) or getRecordsFromCollection(Object, String, long, long, Map)).
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsResponse
  - updateRecords
```
public <TRequest> UpdateRecordsResponse updateRecords(TypeObjectMap<TRequest> typeObjectMap,
                                                      String tableName,
                                                      List<String> expressions,
                                                      List<Map<String,String>> newValuesMaps,
                                                      List<TRequest> data,
                                                      Map<String,String> options)
                                               throws GPUdbException
```
    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. The Raw version of this method can be used to specify the encoding scheme of the request.
    Type Parameters:
    
    TRequest - The type of object being added.
    
    Parameters:
    
    typeObjectMap - Type object map used for encoding input objects.
    
    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 here.
    
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    
    data - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table.
    options - Optional parameters.
    
    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 insertRecords(TypeObjectMap, String, List, Map). Values: true, false.
    record_id: ID of a single record to be updated (returned in the call to insertRecords(TypeObjectMap, String, List, Map) or getRecordsFromCollection(Object, String, long, long, Map)).
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    IllegalArgumentException - if typeObjectMap is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsResponse
  - updateRecordsBySeries
```
public UpdateRecordsBySeriesResponse updateRecordsBySeries(UpdateRecordsBySeriesRequest request)
                                                    throws GPUdbException
```
    Updates the view specified by tableName to include full series (track) information from the worldTableName for the series (tracks) present in the viewName.
    
    Parameters:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsBySeriesResponse
  - updateRecordsBySeries
```
public UpdateRecordsBySeriesResponse updateRecordsBySeries(String tableName,
                                                           String worldTableName,
                                                           String viewName,
                                                           List<String> reserved,
                                                           Map<String,String> options)
                                                    throws GPUdbException
```
    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.
    
    reserved -
    
    options - Optional parameters.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    UpdateRecordsBySeriesResponse
  - visualizeImage
```
public VisualizeImageResponse visualizeImage(VisualizeImageRequest request)
                                      throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImage
```
public VisualizeImageResponse visualizeImage(List<String> tableNames,
                                             List<String> worldTableNames,
                                             String xColumnName,
                                             String yColumnName,
                                             List<List<String>> trackIds,
                                             double minX,
                                             double maxX,
                                             double minY,
                                             double maxY,
                                             int width,
                                             int height,
                                             String projection,
                                             long bgColor,
                                             Map<String,List<String>> styleOptions,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageClassbreak
```
public VisualizeImageClassbreakResponse visualizeImageClassbreak(VisualizeImageClassbreakRequest request)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageClassbreak
```
public VisualizeImageClassbreakResponse visualizeImageClassbreak(List<String> tableNames,
                                                                 List<String> worldTableNames,
                                                                 String xColumnName,
                                                                 String yColumnName,
                                                                 List<List<String>> trackIds,
                                                                 String cbColumnName1,
                                                                 List<String> cbVals1,
                                                                 List<String> cbColumnName2,
                                                                 List<List<String>> cbVals2,
                                                                 double minX,
                                                                 double maxX,
                                                                 double minY,
                                                                 double maxY,
                                                                 int width,
                                                                 int height,
                                                                 String projection,
                                                                 long bgColor,
                                                                 Map<String,List<String>> styleOptions,
                                                                 Map<String,String> options)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageHeatmap
```
public VisualizeImageHeatmapResponse visualizeImageHeatmap(VisualizeImageHeatmapRequest request)
                                                    throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageHeatmap
```
public VisualizeImageHeatmapResponse visualizeImageHeatmap(List<String> tableNames,
                                                           String xColumnName,
                                                           String yColumnName,
                                                           String valueColumnName,
                                                           double minX,
                                                           double maxX,
                                                           double minY,
                                                           double maxY,
                                                           int width,
                                                           int height,
                                                           String projection,
                                                           Map<String,String> styleOptions,
                                                           Map<String,String> options)
                                                    throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageLabels
```
public VisualizeImageLabelsResponse visualizeImageLabels(VisualizeImageLabelsRequest request)
                                                  throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageLabels
```
public VisualizeImageLabelsResponse visualizeImageLabels(String tableName,
                                                         String xColumnName,
                                                         String yColumnName,
                                                         String xOffset,
                                                         String yOffset,
                                                         String textString,
                                                         String font,
                                                         String textColor,
                                                         String textAngle,
                                                         String textScale,
                                                         String drawBox,
                                                         String drawLeader,
                                                         String lineWidth,
                                                         String lineColor,
                                                         String fillColor,
                                                         String leaderXColumnName,
                                                         String leaderYColumnName,
                                                         double minX,
                                                         double maxX,
                                                         double minY,
                                                         double maxY,
                                                         int width,
                                                         int height,
                                                         String projection,
                                                         Map<String,String> options)
                                                  throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeVideo
```
public VisualizeVideoResponse visualizeVideo(VisualizeVideoRequest request)
                                      throws GPUdbException
```
    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://: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:
    
    request - Request object containing the parameters for the operation.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    VisualizeVideoResponse
  - visualizeVideo
```
public VisualizeVideoResponse visualizeVideo(List<String> tableNames,
                                             List<String> worldTableNames,
                                             List<List<String>> trackIds,
                                             String xColumnName,
                                             String yColumnName,
                                             double minX,
                                             double maxX,
                                             double minY,
                                             double maxY,
                                             int width,
                                             int height,
                                             String projection,
                                             long bgColor,
                                             List<List<Double>> timeIntervals,
                                             String videoStyle,
                                             String sessionKey,
                                             Map<String,List<String>> styleOptions,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    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://: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.
    
    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.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    VisualizeVideoResponse
  - visualizeVideoHeatmap
```
public VisualizeVideoHeatmapResponse visualizeVideoHeatmap(VisualizeVideoHeatmapRequest request)
                                                    throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeVideoHeatmap
```
public VisualizeVideoHeatmapResponse visualizeVideoHeatmap(List<String> tableNames,
                                                           String xColumnName,
                                                           String yColumnName,
                                                           double minX,
                                                           double maxX,
                                                           double minY,
                                                           double maxY,
                                                           List<List<Double>> timeIntervals,
                                                           int width,
                                                           int height,
                                                           String projection,
                                                           String videoStyle,
                                                           String sessionKey,
                                                           Map<String,String> styleOptions,
                                                           Map<String,String> options)
                                                    throws GPUdbException
```
    Throws:
    
    GPUdbException

Class GPUdb

Nested Class Summary

Nested classes/interfaces inherited from class com.gpudb.GPUdbBase

Field Summary

Fields inherited from class com.gpudb.GPUdbBase

Constructor Summary

Method Summary

Methods inherited from class com.gpudb.GPUdbBase

Methods inherited from class java.lang.Object

Constructor Detail

GPUdb

GPUdb

GPUdb

GPUdb

Method Detail

adminDeleteNode

adminDeleteNode

adminGetShardAssignments

adminGetShardAssignments

adminOffline

adminOffline

adminRebalance

adminRebalance

adminSetShardAssignments

adminSetShardAssignments

adminShutdown

adminShutdown

adminVerifyDb

adminVerifyDb

aggregateConvexHull

aggregateConvexHull

aggregateGroupByRaw

aggregateGroupBy

aggregateGroupBy

aggregateHistogram

aggregateHistogram

aggregateKMeans

aggregateKMeans

aggregateMinMax

aggregateMinMax

aggregateStatistics

aggregateStatistics

aggregateStatisticsByRange

aggregateStatisticsByRange

aggregateUniqueRaw

aggregateUnique

aggregateUnique

alterSystemProperties

alterSystemProperties

alterTable

alterTable

alterTableMetadata

alterTableMetadata

alterUser

alterUser

clearTable

clearTable

clearTableMonitor

clearTableMonitor

clearTrigger

clearTrigger

createJoinTable

createJoinTable

createRole

createRole

createTable

createTable

createTableMonitor

createTableMonitor

createTriggerByArea

createTriggerByArea

createTriggerByRange

createTriggerByRange

createType

createType

createUnion

createUnion

createUserExternal

createUserExternal

createUserInternal