GPUdb (Kinetica Java API 6.2.4.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.HASynchronicityMode, GPUdbBase.Options, GPUdbBase.SubmitException

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

Constructor Summary

Constructors
Constructor and Description
`GPUdb(List<URL> urls)` Creates a `GPUdb` instance for the GPUdb server with the specified URLs using default options.
`GPUdb(List<URL> urls, GPUdbBase.Options options)` Creates a `GPUdb` instance for the GPUdb server with the specified URLs using the specified options.
`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
`AdminAlterJobsResponse`	`adminAlterJobs(AdminAlterJobsRequest request)` Perform the requested action on a list of one or more job(s).
`AdminAlterJobsResponse`	`adminAlterJobs(List<Integer> jobIds, String action, Map<String,String> options)` Perform the requested action on a list of one or more job(s).
`AdminOfflineResponse`	`adminOffline(AdminOfflineRequest request)` Take the system offline.
`AdminOfflineResponse`	`adminOffline(boolean offline, Map<String,String> options)` Take the system offline.
`AdminReplaceTomResponse`	`adminReplaceTom(AdminReplaceTomRequest request)`
`AdminReplaceTomResponse`	`adminReplaceTom(long oldRankTom, long newRankTom)`
`AdminShowAlertsResponse`	`adminShowAlerts(AdminShowAlertsRequest request)` Retrieves a list of the most recent alerts generated.
`AdminShowAlertsResponse`	`adminShowAlerts(int numAlerts, Map<String,String> options)` Retrieves a list of the most recent alerts generated.
`AdminShowJobsResponse`	`adminShowJobs(AdminShowJobsRequest request)` Get a list of the current jobs in GPUdb.
`AdminShowJobsResponse`	`adminShowJobs(Map<String,String> options)` Get a list of the current jobs in GPUdb.
`AdminShowShardsResponse`	`adminShowShards(AdminShowShardsRequest request)` Show the mapping of shards to the corresponding rank and tom.
`AdminShowShardsResponse`	`adminShowShards(Map<String,String> options)` Show the mapping of shards to the corresponding rank and tom.
`AdminShutdownResponse`	`adminShutdown(AdminShutdownRequest request)` Exits the database server application.
`AdminShutdownResponse`	`adminShutdown(String exitType, String authorization, Map<String,String> options)` Exits the database 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.
`AggregateMinMaxGeometryResponse`	`aggregateMinMaxGeometry(AggregateMinMaxGeometryRequest request)` Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
`AggregateMinMaxGeometryResponse`	`aggregateMinMaxGeometry(String tableName, String columnName, Map<String,String> options)` Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
`AggregateStatisticsResponse`	`aggregateStatistics(AggregateStatisticsRequest request)` Calculates the requested statistics of the given column(s) in a given table.
`AggregateStatisticsResponse`	`aggregateStatistics(String tableName, String columnName, String stats, Map<String,String> options)` Calculates the requested statistics of the given column(s) 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 or collection (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 or collection (specified by `tableName`).
`RawAggregateUniqueResponse`	`aggregateUniqueRaw(AggregateUniqueRequest request)` Returns all the unique values from a particular column (specified by `columnName`) of a particular table or collection (specified by `tableName`).
`AggregateUnpivotResponse`	`aggregateUnpivot(AggregateUnpivotRequest request)` Rotate the column values into rows values.
`AggregateUnpivotResponse`	`aggregateUnpivot(String tableName, List<String> columnNames, String variableColumnName, String valueColumnName, List<String> pivotedColumns, Map<String,String> options)` Rotate the column values into rows values.
`RawAggregateUnpivotResponse`	`aggregateUnpivotRaw(AggregateUnpivotRequest request)` Rotate the column values into rows values.
`AlterSystemPropertiesResponse`	`alterSystemProperties(AlterSystemPropertiesRequest request)` The `alterSystemProperties(AlterSystemPropertiesRequest)` endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.
`AlterSystemPropertiesResponse`	`alterSystemProperties(Map<String,String> propertyUpdatesMap, Map<String,String> options)` The `alterSystemProperties(Map, Map)` endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.
`AlterTableResponse`	`alterTable(AlterTableRequest request)` Apply various modifications to a table, view, or collection.
`AlterTableResponse`	`alterTable(String tableName, String action, String value, Map<String,String> options)` Apply various modifications to a table, view, 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.
`AppendRecordsResponse`	`appendRecords(AppendRecordsRequest request)` Append (or insert) all records from a source table (specified by `sourceTableName`) to a particular target table (specified by `tableName`).
`AppendRecordsResponse`	`appendRecords(String tableName, String sourceTableName, Map<String,String> fieldMap, Map<String,String> options)` Append (or insert) all records from a source table (specified by `sourceTableName`) to a particular target table (specified by `tableName`).
`ClearTableResponse`	`clearTable(ClearTableRequest request)` Clears (drops) one or all tables in the database cluster.
`ClearTableResponse`	`clearTable(String tableName, String authorization, Map<String,String> options)` Clears (drops) one or all tables in the database 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.
`CreateJobResponse`	`createJob(CreateJobRequest request)` Create a job which will run asynchronously.
`CreateJobResponse`	`createJob(String endpoint, String requestEncoding, ByteBuffer data, String dataStr, Map<String,String> options)` Create a job which will run asynchronously.
`CreateJoinTableResponse`	`createJoinTable(CreateJoinTableRequest request)` Creates a table that is the result of a SQL JOIN.
`CreateJoinTableResponse`	`createJoinTable(String joinTableName, List<String> tableNames, List<String> columnNames, List<String> expressions, Map<String,String> options)` Creates a table that is the result of a SQL JOIN.
`CreateMaterializedViewResponse`	`createMaterializedView(CreateMaterializedViewRequest request)` Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
`CreateMaterializedViewResponse`	`createMaterializedView(String tableName, Map<String,String> options)` Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
`CreateProcResponse`	`createProc(CreateProcRequest request)` Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.
`CreateProcResponse`	`createProc(String procName, String executionMode, Map<String,ByteBuffer> files, String command, List<String> args, Map<String,String> options)` Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution.
`CreateProjectionResponse`	`createProjection(CreateProjectionRequest request)` Creates a new projection of an existing table.
`CreateProjectionResponse`	`createProjection(String tableName, String projectionName, List<String> columnNames, Map<String,String> options)` Creates a new projection of an existing table.
`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.
`CreateTableResponse`	`createTable(String tableName, String typeId, Map<String,String> options)` Creates a new table or collection.
`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 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 describing the layout or schema of a table.
`CreateUnionResponse`	`createUnion(CreateUnionRequest request)` Merges data from one or more tables with comparable data types into a new table.
`CreateUnionResponse`	`createUnion(String tableName, List<String> tableNames, List<List<String>> inputColumnNames, List<String> outputColumnNames, Map<String,String> options)` Merges data from one or more tables with comparable data types into a new table.
`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 the database system).
`CreateUserInternalResponse`	`createUserInternal(String name, String password, Map<String,String> options)` Creates a new internal user (a user whose credentials are managed by the database system).
`DeleteProcResponse`	`deleteProc(DeleteProcRequest request)` Deletes a proc.
`DeleteProcResponse`	`deleteProc(String procName, Map<String,String> options)` Deletes a proc.
`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.
`ExecuteProcResponse`	`executeProc(String procName, Map<String,String> params, Map<String,ByteBuffer> binParams, List<String> inputTableNames, Map<String,List<String>> inputColumnNames, List<String> outputTableNames, Map<String,String> options)` Executes a proc.
`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).
`FilterByAreaGeometryResponse`	`filterByAreaGeometry(FilterByAreaGeometryRequest request)` Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon).
`FilterByAreaGeometryResponse`	`filterByAreaGeometry(String tableName, String viewName, String columnName, List<Double> xVector, List<Double> yVector, Map<String,String> options)` Calculates which geospatial geometry objects from a table intersect 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.
`FilterByBoxGeometryResponse`	`filterByBoxGeometry(FilterByBoxGeometryRequest request)` Calculates which geospatial geometry objects from a table intersect a rectangular box.
`FilterByBoxGeometryResponse`	`filterByBoxGeometry(String tableName, String viewName, String columnName, double minX, double maxX, double minY, double maxY, Map<String,String> options)` Calculates which geospatial geometry objects from a table intersect a rectangular box.
`FilterByGeometryResponse`	`filterByGeometry(FilterByGeometryRequest request)` Applies a geometry filter against a geospatial geometry column 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 geospatial geometry column 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.
`FilterByRadiusGeometryResponse`	`filterByRadiusGeometry(FilterByRadiusGeometryRequest request)` Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e.
`FilterByRadiusGeometryResponse`	`filterByRadiusGeometry(String tableName, String viewName, String columnName, double xCenter, double yCenter, double radius, Map<String,String> options)` Calculates which geospatial geometry objects from a table intersect 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.
`GetJobResponse`	`getJob(GetJobRequest request)`
`GetJobResponse`	`getJob(int jobId, Map<String,String> options)`
`<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 from the requested column(s).
`GetRecordsByColumnResponse`	`getRecordsByColumn(String tableName, List<String> columnNames, long offset, long limit, Map<String,String> options)` For a given table, retrieves the values from the requested column(s).
`RawGetRecordsByColumnResponse`	`getRecordsByColumnRaw(GetRecordsByColumnRequest request)` For a given table, retrieves the values from the requested column(s).
`<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.
`HasProcResponse`	`hasProc(HasProcRequest request)` Checks the existence of a proc with the given name.
`HasProcResponse`	`hasProc(String procName, Map<String,String> options)` Checks the existence of a proc with the given name.
`HasTableResponse`	`hasTable(HasTableRequest request)` Checks for the existence of a table with the given name.
`HasTableResponse`	`hasTable(String tableName, Map<String,String> options)` Checks for the existence of a table with the given name.
`HasTypeResponse`	`hasType(HasTypeRequest request)` Check for the existence of a type.
`HasTypeResponse`	`hasType(String typeId, Map<String,String> options)` Check for the existence of a type.
`<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.
`KillProcResponse`	`killProc(KillProcRequest request)` Kills a running proc instance.
`KillProcResponse`	`killProc(String runId, Map<String,String> options)` Kills a running proc instance.
`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.
`MergeRecordsResponse`	`mergeRecords(MergeRecordsRequest request)` Create a new empty result table (specified by `tableName`), and insert all records from source tables (specified by `sourceTableNames`) based on the field mapping information (specified by `fieldMaps`).
`MergeRecordsResponse`	`mergeRecords(String tableName, List<String> sourceTableNames, List<Map<String,String>> fieldMaps, Map<String,String> options)` Create a new empty result table (specified by `tableName`), and insert all records from source tables (specified by `sourceTableNames`) based on the field mapping information (specified by `fieldMaps`).
`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.
`ShowProcResponse`	`showProc(ShowProcRequest request)` Shows information about a proc.
`ShowProcResponse`	`showProc(String procName, Map<String,String> options)` Shows information about a proc.
`ShowProcStatusResponse`	`showProcStatus(ShowProcStatusRequest request)` Shows the statuses of running or completed proc instances.
`ShowProcStatusResponse`	`showProcStatus(String runId, Map<String,String> options)` Shows the statuses of running or completed proc instances.
`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 database requests along with the request timing and internal job id.
`ShowSystemTimingResponse`	`showSystemTiming(ShowSystemTimingRequest request)` Returns the last 100 database requests along with the request timing and internal job id.
`ShowTableResponse`	`showTable(ShowTableRequest request)` Retrieves detailed information about tables, views, and collections.
`ShowTableResponse`	`showTable(String tableName, Map<String,String> options)` Retrieves detailed information about tables, views, and collections.
`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 whose type matches the given criteria.
`ShowTablesByTypeResponse`	`showTablesByType(String typeId, String label, Map<String,String> options)` Gets names of the tables whose type matches the given criteria.
`ShowTriggersResponse`	`showTriggers(List<String> triggerIds, Map<String,String> options)` Retrieves information regarding the specified triggers or all existing triggers currently active.
`ShowTriggersResponse`	`showTriggers(ShowTriggersRequest request)` Retrieves information regarding the specified triggers or all existing triggers currently active.
`ShowTypesResponse`	`showTypes(ShowTypesRequest request)` Retrieves information for the specified data type ID or type label.
`ShowTypesResponse`	`showTypes(String typeId, String label, Map<String,String> options)` Retrieves information for the specified data type ID or type label.
`<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, String geometryColumnName, 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)`
`VisualizeImageChartResponse`	`visualizeImageChart(String tableName, List<String> xColumnNames, List<String> yColumnNames, double minX, double maxX, double minY, double maxY, int width, int height, String bgColor, Map<String,List<String>> styleOptions, Map<String,String> options)` Scatter plot is the only plot type currently supported.
`VisualizeImageChartResponse`	`visualizeImageChart(VisualizeImageChartRequest request)` Scatter plot is the only plot type currently supported.
`VisualizeImageClassbreakResponse`	visualizeImageClassbreak(List<String> tableNames, List<String> worldTableNames, String xColumnName, String yColumnName, String geometryColumnName, List<List<String>> trackIds, String cbAttr, List<String> cbVals, String cbPointcolorAttr, List<String> cbPointcolorVals, String cbPointsizeAttr, List<String> cbPointsizeVals, String cbPointshapeAttr, List<String> cbPointshapeVals, 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)`
`VisualizeImageContourResponse`	`visualizeImageContour(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)`
`VisualizeImageContourResponse`	`visualizeImageContour(VisualizeImageContourRequest request)`
`VisualizeImageHeatmapResponse`	`visualizeImageHeatmap(List<String> tableNames, String xColumnName, String yColumnName, String valueColumnName, String geometryColumnName, 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, String filter, 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, String geometryColumnName, 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)`
`VisualizeVideoResponse`	`visualizeVideo(VisualizeVideoRequest request)`
`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 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(List<URL> urls)
      throws GPUdbException
```
    Creates a GPUdb instance for the GPUdb server with the specified URLs using default options. At any given time, one URL (initially selected at random from the list) will be active and used for all GPUdb calls, but in the event of failure, the other URLs will be tried in order, and if a working one is found it will become the new active URL. Note that the default options cannot be changed subsequently; to use different options, a new GPUdb instance must be created.
    
    Parameters:
    
    urls - The URLs 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.
  - GPUdb
```
public GPUdb(List<URL> urls,
             GPUdbBase.Options options)
      throws GPUdbException
```
    Creates a GPUdb instance for the GPUdb server with the specified URLs using the specified options. At any given time, one URL (initially selected at random from the list) will be active and used for all GPUdb calls, but in the event of failure, the other URLs will be tried in order, and if a working one is found it will become the new active URL. Note that the specified options cannot be changed subsequently; to use different options, a new GPUdb instance must be created.
    
    Parameters:
    
    urls - The URLs of the GPUdb server.
    
    options - The options to use.
    
    Throws:
    
    GPUdbException - if an error occurs during creation.
- Method Detail
  - adminAlterJobs
```
public AdminAlterJobsResponse adminAlterJobs(AdminAlterJobsRequest request)
                                      throws GPUdbException
```
    Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
    
    Parameters:
    
    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:
    
    AdminAlterJobsResponse
  - adminAlterJobs
```
public AdminAlterJobsResponse adminAlterJobs(List<Integer> jobIds,
                                             String action,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
    Parameters:
    
    jobIds - Jobs to be modified.
    action - Action to be performed on the jobs specified by job_ids. Supported values:
    
    CANCEL
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminAlterJobsResponse
  - 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. Supported values:
    
    TRUE
    FALSE
    options - Optional parameters.
    
    FLUSH_TO_DISK: Flush to disk when going offline Supported values:
    
    TRUE
    FALSE
    
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminOfflineResponse
  - adminShowAlerts
```
public AdminShowAlertsResponse adminShowAlerts(AdminShowAlertsRequest request)
                                        throws GPUdbException
```
    Retrieves a list of the most recent alerts generated. The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest
    
    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:
    
    AdminShowAlertsResponse
  - adminShowAlerts
```
public AdminShowAlertsResponse adminShowAlerts(int numAlerts,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    Retrieves a list of the most recent alerts generated. The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest
    
    Parameters:
    
    numAlerts - Number of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminShowAlertsResponse
  - adminShowJobs
```
public AdminShowJobsResponse adminShowJobs(AdminShowJobsRequest request)
                                    throws GPUdbException
```
    Get a list of the current jobs 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:
    
    AdminShowJobsResponse
  - adminShowJobs
```
public AdminShowJobsResponse adminShowJobs(Map<String,String> options)
                                    throws GPUdbException
```
    Get a list of the current jobs in GPUdb.
    Parameters:
    options - Optional parameters.
    
    SHOW_DETAILS: Supported values:
    
    TRUE
    FALSE
    
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminShowJobsResponse
  - adminShowShards
```
public AdminShowShardsResponse adminShowShards(AdminShowShardsRequest request)
                                        throws GPUdbException
```
    Show the mapping of shards to the corresponding rank and tom. The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
    
    Parameters:
    
    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:
    
    AdminShowShardsResponse
  - adminShowShards
```
public AdminShowShardsResponse adminShowShards(Map<String,String> options)
                                        throws GPUdbException
```
    Show the mapping of shards to the corresponding rank and tom. The response message contains list of 16384 (total number of shards in the system) Rank and TOM numbers corresponding to each shard.
    
    Parameters:
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AdminShowShardsResponse
  - adminShutdown
```
public AdminShutdownResponse adminShutdown(AdminShutdownRequest request)
                                    throws GPUdbException
```
    Exits the database 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 database 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. The default value is an empty Map.
    
    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.
    
    REBUILD_ON_ERROR: Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    VERIFY_PERSIST: Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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 an existing table. It cannot be a collection.
    
    xColumnName - Name of the column containing the x coordinates of the points for the operation being performed.
    
    yColumnName - Name of the column containing the y coordinates of the points for the operation being performed.
    
    options - Optional parameters. The default value is an empty Map.
    
    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.
    For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
    Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
    The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
    options can be used to customize behavior of this call e.g. filtering or sorting the results.
    To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
    To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
    Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
    Available grouping functions are Rollup, Cube, and Grouping Sets
    This service also provides support for Pivot operations.
    Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    If a result_table name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
    
    Parameters:
    
    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.
    For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
    Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
    The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
    options can be used to customize behavior of this call e.g. filtering or sorting the results.
    To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
    To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
    Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
    Available grouping functions are Rollup, Cube, and Grouping Sets
    This service also provides support for Pivot operations.
    Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    If a result_table name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
    
    Parameters:
    
    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.
    For aggregation details and examples, see Aggregation. For limitations, see Aggregation Limitations.
    Any column(s) can be grouped on, and all column types except unrestricted-length strings may be used for computing applicable aggregates; columns marked as store-only are unable to be used in grouping or aggregation.
    The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}.
    options can be used to customize behavior of this call e.g. filtering or sorting the results.
    To group by columns 'x' and 'y' and compute the number of objects within each group, use: column_names=['x','y','count(*)'].
    To also compute the sum of 'z' over each group, use: column_names=['x','y','count(*)','sum(z)'].
    Available aggregation functions are: count(*), sum, min, max, avg, mean, stddev, stddev_pop, stddev_samp, var, var_pop, var_samp, arg_min, arg_max and count_distinct.
    Available grouping functions are Rollup, Cube, and Grouping Sets
    This service also provides support for Pivot operations.
    Filtering on aggregates is supported via expressions using aggregation functions supplied to having.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    If a result_table name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column names must adhere to standard naming conventions; column/aggregation expressions will need to be aliased. If the source table's shard key is used as the grouping column(s) and all result records are selected (offset is 0 and limit is -9999), the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available when any of the values of columnNames is an unrestricted-length string.
    Parameters:
    
    tableName - Name of the table on which the operation will be performed. Must be an existing table/view/collection.
    
    columnNames - List of one or more column names, expressions, and aggregate expressions.
    
    offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 1000.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. Additionally this option is invalid if tableName is a collection.
    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. Supported values:
    
    ASCENDING: Indicates that the returned values should be sorted in ascending order.
    DESCENDING: Indicates that the returned values should be sorted in descending order.
    The default value is ASCENDING.
    SORT_BY: String determining how the results are sorted. Supported values:
    
    KEY: Indicates that the returned values should be sorted by key, which corresponds to the grouping columns. If you have multiple grouping columns (and are sorting by key), it will first sort the first grouping column, then the second grouping column, etc.
    VALUE: Indicates that the returned values should be sorted by value, which corresponds to the aggregates. If you have multiple aggregates (and are sorting by value), it will first sort by the first aggregate, then the second aggregate, etc.
    The default value is VALUE.
    RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. Column names (group-by and aggregate fields) need to be given aliases e.g. ["FChar256 as fchar256", "sum(FDouble) as sfd"]. If present, no results are returned in the response. This option is not available if one of the grouping attributes is an unrestricted string (i.e.; not charN) type.
    RESULT_TABLE_PERSIST: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    RESULT_TABLE_GENERATE_PK: If 'true' then set a primary key for the result table. Must be used in combination with the result_table option. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    TTL: Sets the TTL of the table specified in result_table.
    CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
    CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the result table. Must be used in combination with the result_table option.
    VIEW_ID: view this result table is part of. The default value is ''.
    MATERIALIZE_ON_GPU: If true then the columns of the groupby result table will be cached on the GPU. Must be used in combination with the result_table option. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    PIVOT: pivot column
    PIVOT_VALUES: The value list provided will become the column headers in the output. Should be the values from the pivot_column.
    GROUPING_SETS: Customize the grouping attribute sets to compute the aggregates. These sets can include ROLLUP or CUBE operartors. The attribute sets should be enclosed in paranthesis and can include composite attributes. All attributes specified in the grouping sets must present in the groupby attributes.
    ROLLUP: This option is used to specify the multilevel aggregates.
    CUBE: This option is used to specify the multidimensional aggregates.
    The default value is an empty Map.
    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 this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
    NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.
    
    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 this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
    NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.
    Parameters:
    
    tableName - Name of the table on which the operation will be performed. Must be an existing table or collection.
    
    columnName - Name of a column or an expression of one or more column names over which the histogram will be calculated.
    
    start - Lower end value of the histogram interval, inclusive.
    
    end - Upper end value of the histogram interval, inclusive.
    
    interval - The size of each bin within the start and end parameters.
    options - Optional parameters.
    
    VALUE_COLUMN: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).
    The default value is an empty Map.
    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.
    NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this 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:
    
    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.
    NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
    Parameters:
    
    tableName - Name of the table on which the operation will be performed. Must be an existing table or collection.
    
    columnNames - List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
    
    k - The number of mean points to be determined by the algorithm.
    
    tolerance - Stop iterating when the distances between successive points is less than the given tolerance.
    options - Optional parameters.
    
    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.
    The default value is an empty Map.
    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 an existing table.
    
    columnName - Name of a column or an expression of one or more column on which the min-max will be calculated.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateMinMaxResponse
  - aggregateMinMaxGeometry
```
public AggregateMinMaxGeometryResponse aggregateMinMaxGeometry(AggregateMinMaxGeometryRequest request)
                                                        throws GPUdbException
```
    Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry 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:
    
    AggregateMinMaxGeometryResponse
  - aggregateMinMaxGeometry
```
public AggregateMinMaxGeometryResponse aggregateMinMaxGeometry(String tableName,
                                                               String columnName,
                                                               Map<String,String> options)
                                                        throws GPUdbException
```
    Calculates and returns the minimum and maximum x- and y-coordinates of a particular geospatial geometry column in a table.
    
    Parameters:
    
    tableName - Name of the table on which the operation will be performed. Must be an existing table.
    
    columnName - Name of a geospatial geometry column on which the min-max will be calculated.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateMinMaxGeometryResponse
  - aggregateStatistics
```
public AggregateStatisticsResponse aggregateStatistics(AggregateStatisticsRequest request)
                                                throws GPUdbException
```
    Calculates the requested statistics of the given column(s) in a given table.
    The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
    Estimated cardinality is calculated by using the hyperloglog approximation technique.
    Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
    A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
    The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.
    Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation--individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
    The response includes a list of key/value pairs of each statistic requested and its corresponding value.
    
    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 the given column(s) in a given table.
    The available statistics are count (number of total objects), mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, weighted_average, cardinality (unique count), estimated_cardinality, percentile and percentile_rank.
    Estimated cardinality is calculated by using the hyperloglog approximation technique.
    Percentiles and percentile ranks are approximate and are calculated using the t-digest algorithm. They must include the desired percentile/percentile_rank. To compute multiple percentiles each value must be specified separately (i.e. 'percentile(75.0),percentile(99.0),percentile_rank(1234.56),percentile_rank(-5)').
    A second, comma-separated value can be added to the percentile statistic to calculate percentile resolution, e.g., a 50th percentile with 200 resolution would be 'percentile(50,200)'.
    The weighted average statistic requires a weight_column_name to be specified in options. The weighted average is then defined as the sum of the products of columnName times the weight_column_name values divided by the sum of the weight_column_name values.
    Additional columns can be used in the calculation of statistics via the additional_column_names option. Values in these columns will be included in the overall aggregate calculation--individual aggregates will not be calculated per additional column. For instance, requesting the count & mean of columnName x and additional_column_names y & z, where x holds the numbers 1-10, y holds 11-20, and z holds 21-30, would return the total number of x, y, & z values (30), and the single average value across all x, y, & z values (15.5).
    The response includes a list of key/value pairs of each statistic requested and its corresponding value.
    Parameters:
    
    tableName - Name of the table on which the statistics operation will be performed.
    
    columnName - Name of the primary column for which the statistics are to be calculated.
    stats - Comma separated list of the statistics to calculate, e.g. "sum,mean". Supported values:
    
    COUNT: Number of objects (independent of the given column(s)).
    MEAN: Arithmetic mean (average), equivalent to sum/count.
    STDV: Sample standard deviation (denominator is count-1).
    VARIANCE: Unbiased sample variance (denominator is count-1).
    SKEW: Skewness (third standardized moment).
    KURTOSIS: Kurtosis (fourth standardized moment).
    SUM: Sum of all values in the column(s).
    MIN: Minimum value of the column(s).
    MAX: Maximum value of the column(s).
    WEIGHTED_AVERAGE: Weighted arithmetic mean (using the option weight_column_name as the weighting column).
    CARDINALITY: Number of unique values in the column(s).
    ESTIMATED_CARDINALITY: Estimate (via hyperloglog technique) of the number of unique values in the column(s).
    PERCENTILE: Estimate (via t-digest) of the given percentile of the column(s) (percentile(50.0) will be an approximation of the median). Add a second, comma-separated value to calculate percentile resolution, e.g., 'percentile(75,150)'
    PERCENTILE_RANK: Estimate (via t-digest) of the percentile rank of the given value in the column(s) (if the given value is the median of the column(s), percentile_rank() will return approximately 50.0).
    options - Optional parameters.
    
    ADDITIONAL_COLUMN_NAMES: A list of comma separated column names over which statistics can be accumulated along with the primary column. All columns listed and columnName must be of the same type. Must not include the column specified in columnName and no column can be listed twice.
    WEIGHT_COLUMN_NAME: Name of column used as weighting attribute for the weighted average statistic.
    The default value is an empty Map.
    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.
    NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this 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:
    
    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.
    NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.
    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. The default value is ''.
    
    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.
    The default value is an empty Map.
    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 or collection (specified by tableName). If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.
    Columns marked as store-only are unable to be used with this function.
    To get the first 10 unique values sorted in descending order options would be::
    {"limit":"10","sort_order":"descending"}.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    If a result_table name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.
    
    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 or collection (specified by tableName). If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.
    Columns marked as store-only are unable to be used with this function.
    To get the first 10 unique values sorted in descending order options would be::
    {"limit":"10","sort_order":"descending"}.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    If a result_table name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.
    
    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 or collection (specified by tableName). If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.
    Columns marked as store-only are unable to be used with this function.
    To get the first 10 unique values sorted in descending order options would be::
    {"limit":"10","sort_order":"descending"}.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    If a result_table name is specified in the options, the results are stored in a new table with that name--no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.
    Parameters:
    
    tableName - Name of an existing table/collection on which the operation will be performed.
    
    columnName - Name of the column or an expression containing one or more column names on which the unique function would be applied.
    
    offset - A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table. Additionally this option is invalid if tableName is a collection.
    EXPRESSION: Optional filter expression to apply to the table.
    SORT_ORDER: String indicating how the returned values should be sorted. Supported values:
    
    ASCENDING
    DESCENDING
    The default value is ASCENDING.
    RESULT_TABLE: The name of the table used to store the results. If present, no results are returned in the response. Has the same naming restrictions as tables. Not available if tableName is a collection or when columnName is an unrestricted-length string.
    RESULT_TABLE_PERSIST: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    RESULT_TABLE_GENERATE_PK: If 'true' then set a primary key for the result table. Must be used in combination with the result_table option. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    TTL: Sets the TTL of the table specified in result_table.
    CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
    VIEW_ID: view this result table is part of. The default value is ''.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateUniqueResponse
  - aggregateUnpivotRaw
```
public RawAggregateUnpivotResponse aggregateUnpivotRaw(AggregateUnpivotRequest request)
                                                throws GPUdbException
```
    Rotate the column values into rows values.
    For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
    Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    
    Parameters:
    
    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:
    
    RawAggregateUnpivotResponse
  - aggregateUnpivot
```
public AggregateUnpivotResponse aggregateUnpivot(AggregateUnpivotRequest request)
                                          throws GPUdbException
```
    Rotate the column values into rows values.
    For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
    Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    
    Parameters:
    
    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:
    
    AggregateUnpivotResponse
  - aggregateUnpivot
```
public AggregateUnpivotResponse aggregateUnpivot(String tableName,
                                                 List<String> columnNames,
                                                 String variableColumnName,
                                                 String valueColumnName,
                                                 List<String> pivotedColumns,
                                                 Map<String,String> options)
                                          throws GPUdbException
```
    Rotate the column values into rows values.
    For unpivot details and examples, see Unpivot. For limitations, see Unpivot Limitations.
    Unpivot is used to normalize tables that are built for cross tabular reporting purposes. The unpivot operator rotates the column values for all the pivoted columns. A variable column, value column and all columns from the source table except the unpivot columns are projected into the result table. The variable column and value columns in the result table indicate the pivoted column name and values respectively.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    Parameters:
    
    tableName - Name of the table on which the operation will be performed. Must be an existing table/view.
    
    columnNames - List of column names or expressions. A wildcard '*' can be used to include all the non-pivoted columns from the source table.
    
    variableColumnName - Specifies the variable/parameter column name. The default value is ''.
    
    valueColumnName - Specifies the value column name. The default value is ''.
    
    pivotedColumns - List of one or more values typically the column names of the input table. All the columns in the source table must have the same data type.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the table specified in result_table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the table will be a top-level table.
    RESULT_TABLE: The name of the table used to store the results. Has the same naming restrictions as tables. If present, no results are returned in the response.
    RESULT_TABLE_PERSIST: If true, then the result table specified in result_table will be persisted and will not expire unless a ttl is specified. If false, then the result table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    EXPRESSION: Filter expression to apply to the table prior to unpivot processing.
    ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in input table. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
    CHUNK_SIZE: Indicates the chunk size to be used for the result table. Must be used in combination with the result_table option.
    LIMIT: The number of records to keep. The default value is ''.
    TTL: Sets the TTL of the table specified in result_table.
    VIEW_ID: view this result table is part of. The default value is ''.
    MATERIALIZE_ON_GPU: If true then the output columns will be cached on the GPU. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the table specified in result_table. The columns specified must be present in output column names. If any alias is given for any column name, the alias must be used, rather than the original column name.
    RESULT_TABLE_FORCE_REPLICATED: Force the result table to be replicated (ignores any sharding). Must be used in combination with the result_table option. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AggregateUnpivotResponse
  - alterSystemProperties
```
public AlterSystemPropertiesResponse alterSystemProperties(AlterSystemPropertiesRequest request)
                                                    throws GPUdbException
```
    The alterSystemProperties(AlterSystemPropertiesRequest) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
    
    Parameters:
    
    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 alterSystemProperties(Map, Map) endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution. Commands are given through the propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
    Parameters:
    propertyUpdatesMap - Map containing the properties of the system to be updated. Error if empty.
    
    SM_OMP_THREADS: Set the number of OpenMP threads that will be used to service filter & aggregation requests against collections to the specified integer value.
    KERNEL_OMP_THREADS: Set the number of kernel OpenMP 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. Supported values:
    
    TRUE
    FALSE
    
    CHUNK_SIZE: Sets the chunk size of all new sets to the specified integer value.
    EXECUTION_MODE: Sets the execution_mode for kernel executions to the specified string value. Possible values are host, device, default (engine decides) or an integer value that indicates max chunk size to exec on host
    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 num 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 Supported values:
    
    TRUE
    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 semicolon-separated list of = expressions. Valid expressions are: seconds= where time is the time in seconds to run the test; data_size= where size 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 filtering (e.g., filter(String, String, String, Map)) and aggregating (e.g., aggregateGroupByRaw(AggregateGroupByRequest)) queries will timeout. The default value is '20'.
    MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'.
    MEMORY_ALLOCATION_LIMIT_MB: Set the memory allocation limit for all rank processes in megabytes, 0 means no limit. Overrides any individual rank memory allocation limits. The default value is '0'.
    ENABLE_AUDIT: Enable or disable auditing.
    AUDIT_HEADERS: Enable or disable auditing of request headers.
    AUDIT_BODY: Enable or disable auditing of request bodies.
    AUDIT_DATA: Enable or disable auditing of request data.
    ENABLE_JOB_MANAGER: Enable JobManager to enforce processing of requests in the order received.
    CHUNK_CACHE_ENABLED: Enable chunk level query caching. Flushes the chunk cache when value is false
    CHUNK_CACHE_SIZE: Size of the chunk cache in bytes. The default value is '10000000'.
    options - Optional parameters. The default value is an empty Map.
    
    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, view, or collection. The available modifications include the following:
    Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
    Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
    Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
    Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
    Allow homogeneous tables within a collection.
    Manage a table's columns--a column can be added, removed, or have its type and properties modified.
    Set or unset compression for a column.
    
    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, view, or collection. The available modifications include the following:
    Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
    Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.
    Set the global access mode (i.e. locking) for a table. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.
    Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.
    Allow homogeneous tables within a collection.
    Manage a table's columns--a column can be added, removed, or have its type and properties modified.
    Set or unset compression for a column.
    Parameters:
    
    tableName - Table on which the operation will be performed. Must be an existing table, view, or collection.
    action - Modification operation to be applied Supported values:
    
    ALLOW_HOMOGENEOUS_TABLES: Sets whether homogeneous tables are allowed in the given collection. This action is only valid if tableName is a collection. The value must be either 'true' or 'false'.
    CREATE_INDEX: Creates an index on the column name specified in value. If this column is already indexed, an error will be returned.
    DELETE_INDEX: Deletes an existing index on the column name specified in value. If this column does not have indexing turned on, an error will be returned.
    MOVE_TO_COLLECTION: Moves a table into a collection value.
    PROTECTED: Sets whether the given tableName should be protected or not. The value must be either 'true' or 'false'.
    RENAME_TABLE: Renames a table, view or collection to value. Has the same naming restrictions as tables.
    TTL: Sets the time-to-live in minutes of the table, view, or collection specified in tableName.
    MEMORY_TTL: Sets the time-to-live in minutes for the individual chunks of the columns of the table, view, or collection specified in tableName to free their memory if unused longer than the given time. Specify an empty string to restore the global memory_ttl setting and a value of '-1' for an infinite timeout.
    ADD_COLUMN: Adds the column specified in value to the table specified in tableName. Use column_type and column_properties in options to set the column's type and properties, respectively.
    CHANGE_COLUMN: Changes type and properties of the column specified in value. Use column_type and column_properties in options to set the column's type and properties, respectively. Note that primary key and/or shard key columns cannot be changed. All unchanging column properties must be listed for the change to take place, e.g., to add dictionary encoding to an existing 'char4' column, both 'char4' and 'dict' must be specified in the options map.
    SET_COLUMN_COMPRESSION: Modifies the compression setting on the column specified in value.
    DELETE_COLUMN: Deletes the column specified in value from the table specified in tableName.
    CREATE_FOREIGN_KEY: Creates a foreign key using the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
    DELETE_FOREIGN_KEY: Deletes a foreign key. The value should be the foreign_key_name specified when creating the key or the complete string used to define it.
    SET_GLOBAL_ACCESS_MODE: Sets the global access mode (i.e. locking) for the table specified in tableName. Specify the access mode in value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.
    REFRESH: Replays all the table creation commands required to create this materialized view.
    SET_REFRESH_METHOD: Sets the method by which this materialized view is refreshed - one of 'manual', 'periodic', 'on_change'.
    SET_REFRESH_START_TIME: Sets the time to start periodic refreshes of this materialized view to datetime string with format 'YYYY-MM-DD HH:MM:SS'. Subsequent refreshes occur at the specified time + N * the refresh period.
    SET_REFRESH_PERIOD: Sets the time interval in seconds at which to refresh this materialized view. Also, sets the refresh method to periodic if not alreay set.
    REMOVE_TEXT_SEARCH_ATTRIBUTES: remove text_search attribute from all columns, if exists.
    value - The value of the modification. May be a column name, 'true' or 'false', a TTL, or the global access mode depending on action.
    options - Optional parameters.
    
    COLUMN_DEFAULT_VALUE: When adding a column, set a default value for existing records. For nullable columns, the default value will be null, regardless of data type.
    COLUMN_PROPERTIES: When adding or changing a column, set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc).
    COLUMN_TYPE: When adding or changing a column, set the column type (strings, separated by a comma: int, double, string, null etc).
    COMPRESSION_TYPE: When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type. Supported values:
    
    NONE
    SNAPPY
    LZ4
    LZ4HC
    The default value is SNAPPY.
    COPY_VALUES_FROM_COLUMN: please see add_column_expression instead.
    RENAME_COLUMN: When changing a column, specify new column name.
    VALIDATE_CHANGE_COLUMN: When changing a column, validate the change before applying it. If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. Supported values:
    
    TRUE: true
    FALSE: false
    The default value is TRUE.
    UPDATE_LAST_ACCESS_TIME: Indicates whether need to update the last_access_time. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    ADD_COLUMN_EXPRESSION: expression for new column's values (optional with add_column). Any valid expressions including existing columns.
    The default value is an empty Map.
    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, or an error will be returned.
    
    metadataMap - A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
    
    options - Optional parameters. The default value is an empty Map.
    
    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. Supported values:
    
    SET_PASSWORD: Sets the password of the user. The user must be an internal user.
    value - The value of the modification, depending on action.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AlterUserResponse
  - appendRecords
```
public AppendRecordsResponse appendRecords(AppendRecordsRequest request)
                                    throws GPUdbException
```
    Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
    
    Parameters:
    
    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:
    
    AppendRecordsResponse
  - appendRecords
```
public AppendRecordsResponse appendRecords(String tableName,
                                           String sourceTableName,
                                           Map<String,String> fieldMap,
                                           Map<String,String> options)
                                    throws GPUdbException
```
    Append (or insert) all records from a source table (specified by sourceTableName) to a particular target table (specified by tableName). The field map (specified by fieldMap) holds the user specified map of target table column names with their mapped source column names.
    Parameters:
    
    tableName - The table name for the records to be appended. Must be an existing table.
    
    sourceTableName - The source table name to get records from. Must be an existing table name.
    
    fieldMap - Contains the mapping of column names from the target table (specified by tableName) as the keys, and corresponding column names or expressions (e.g., 'col_name+1') from the source table (specified by sourceTableName). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
    options - Optional parameters.
    
    OFFSET: A positive integer indicating the number of initial results to skip from source table (specified by sourceTableName). Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is '0'.
    LIMIT: A positive integer indicating the maximum number of results to be returned from source table (specified by sourceTableName). Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
    EXPRESSION: Optional filter expression to apply to the source table (specified by sourceTableName). Empty by default. The default value is ''.
    ORDER_BY: Comma-separated list of the columns and expressions to be sorted by from the source table (specified by sourceTableName); e.g. 'timestamp asc, x desc'. The order_by columns do not have to be present in fieldMap. The default value is ''.
    UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting the source table records (specified by sourceTableName) into the target table (specified by tableName) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    TRUNCATE_STRINGS: If set to true, it allows inserting unrestricted length strings into charN string columns by truncating the unrestricted length strings to fit. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    AppendRecordsResponse
  - clearTable
```
public ClearTableResponse clearTable(ClearTableRequest request)
                              throws GPUdbException
```
    Clears (drops) one or all tables in the database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
    
    Parameters:
    
    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 database cluster. The operation is synchronous meaning that the table will be cleared before the function returns. The response payload returns the status of the operation along with the name of the table that was cleared.
    Parameters:
    
    tableName - Name of the table to be cleared. Must be an existing table. Empty string clears all available tables, though this behavior is be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''.
    
    authorization - No longer used. User can pass an empty string. The default value is ''.
    options - Optional parameters.
    
    NO_ERROR_IF_NOT_EXISTS: If true and if the table specified in tableName does not exist no error is returned. If false and if the table specified in tableName does not exist then an error is returned. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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. The default value is an empty Map.
    
    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. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ClearTriggerResponse
  - createJob
```
public CreateJobResponse createJob(CreateJobRequest request)
                            throws GPUdbException
```
    Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob(GetJobRequest).
    
    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:
    
    CreateJobResponse
  - createJob
```
public CreateJobResponse createJob(String endpoint,
                                   String requestEncoding,
                                   ByteBuffer data,
                                   String dataStr,
                                   Map<String,String> options)
                            throws GPUdbException
```
    Create a job which will run asynchronously. The response returns a job ID, which can be used to query the status and result of the job. The status and the result of the job upon completion can be requested by getJob(int, Map).
    Parameters:
    
    endpoint - Indicates which endpoint to execute, e.g. '/alter/table'.
    requestEncoding - The encoding of the request payload for the job. Supported values:
    
    BINARY
    JSON
    SNAPPY
    The default value is BINARY.
    data - Binary-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be binary or snappy.
    
    dataStr - JSON-encoded payload for the job to be run asynchronously. The payload must contain the relevant input parameters for the endpoint indicated in endpoint. Please see the documentation for the appropriate endpoint to see what values must (or can) be specified. If this parameter is used, then requestEncoding must be json.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateJobResponse
  - createJoinTable
```
public CreateJoinTableResponse createJoinTable(CreateJoinTableRequest request)
                                        throws GPUdbException
```
    Creates a table that is the result of a SQL JOIN.
    For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
    
    Parameters:
    
    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> columnNames,
                                               List<String> expressions,
                                               Map<String,String> options)
                                        throws GPUdbException
```
    Creates a table that is the result of a SQL JOIN.
    For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.
    Parameters:
    
    joinTableName - Name of the join table to be created. Has the same naming restrictions as tables.
    
    tableNames - The list of table names composing the join. Corresponds to a SQL statement FROM clause.
    
    columnNames - List of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased--therefore, the '*' wild card cannot be used if column names aren't unique across all tables.
    
    expressions - An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty List.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level. The default value is ''.
    MAX_QUERY_DIMENSIONS: The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
    OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
    
    MANUAL: refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh
    ON_QUERY: incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query. TTL will be set to not expire; any ttl specified will be ignored.
    ON_INSERT: incrementally refresh (refresh just those records added) whenever new data is inserted into a base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query. TTL will be set to not expire; any ttl specified will be ignored.
    The default value is MANUAL.
    REFRESH: Do a manual refresh of the join if it exists - throws an error otherwise Supported values:
    
    NO_REFRESH: don't refresh
    REFRESH: incrementally refresh (refresh just those records added) if new data has been inserted into the base table. A full refresh of all the records occurs if there have been inserts to any non-base-tables since the last refresh
    FULL_REFRESH: always refresh even if no new records have been added. Only refresh method guaranteed to do a full refresh (refresh all the records) if a delete or update has occurred since the last refresh.
    The default value is NO_REFRESH.
    TTL: Sets the TTL of the join table specified in joinTableName. Ignored if refresh_method is either on_insert or on_query.
    VIEW_ID: view this projection is part of. The default value is ''.
    NO_COUNT: return a count of 0 for the join table for logging and for show_table. optimization needed for large overlapped equi-join stencils. The default value is 'false'.
    CHUNK_SIZE: Maximum size of a joined-chunk for this table. Defaults to the gpudb.conf file chunk size
    ALLOW_RIGHT_PRIMARY_KEY_JOIN: When true allows right joins from a key to a primary key to be done as primary key joins. Such a join table cannot be joined to other join tables. When false the right join shall be done as an equi-join. The default value is 'false'.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateJoinTableResponse
  - createMaterializedView
```
public CreateMaterializedViewResponse createMaterializedView(CreateMaterializedViewRequest request)
                                                      throws GPUdbException
```
    Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
    For materialized view details and examples, see Materialized Views.
    The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
    
    Parameters:
    
    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:
    
    CreateMaterializedViewResponse
  - createMaterializedView
```
public CreateMaterializedViewResponse createMaterializedView(String tableName,
                                                             Map<String,String> options)
                                                      throws GPUdbException
```
    Initiates the process of creating a materialized view, reserving the view's name to prevent other views or tables from being created with that name.
    For materialized view details and examples, see Materialized Views.
    The response contains viewId, which is used to tag each subsequent operation (projection, union, aggregation, filter, or join) that will compose the view.
    Parameters:
    
    tableName - Name of the table to be created that is the top-level table of the materialized view.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
    TTL: Sets the TTL of the table specified in tableName.
    PERSIST: If true, then the materialized view specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
    
    MANUAL: Refresh only occurs when manually requested by calling alterTable(String, String, String, Map) with an 'action' of 'refresh'
    ON_QUERY: For future use.
    ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
    PERIODIC: Refresh table periodically at rate specified by refresh_period
    The default value is MANUAL.
    REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
    REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateMaterializedViewResponse
  - createProc
```
public CreateProcResponse createProc(CreateProcRequest request)
                              throws GPUdbException
```
    Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. For details on UDFs, see: User-Defined Functions
    
    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:
    
    CreateProcResponse
  - createProc
```
public CreateProcResponse createProc(String procName,
                                     String executionMode,
                                     Map<String,ByteBuffer> files,
                                     String command,
                                     List<String> args,
                                     Map<String,String> options)
                              throws GPUdbException
```
    Creates an instance (proc) of the user-defined function (UDF) specified by the given command, options, and files, and makes it available for execution. For details on UDFs, see: User-Defined Functions
    Parameters:
    
    procName - Name of the proc to be created. Must not be the name of a currently existing proc.
    executionMode - The execution mode of the proc. Supported values:
    
    DISTRIBUTED: Input table data will be divided into data segments that are distributed across all nodes in the cluster, and the proc command will be invoked once per data segment in parallel. Output table data from each invocation will be saved to the same node as the corresponding input data.
    NONDISTRIBUTED: The proc command will be invoked only once per execution, and will not have access to any input or output table data.
    The default value is DISTRIBUTED.
    files - A map of the files that make up the proc. The keys of the map are file names, and the values are the binary contents of the files. The file names may include subdirectory names (e.g. 'subdir/file') but must not resolve to a directory above the root for the proc. The default value is an empty Map.
    
    command - The command (excluding arguments) that will be invoked when the proc is executed. It will be invoked from the directory containing the proc files and may be any command that can be resolved from that directory. It need not refer to a file actually in that directory; for example, it could be 'java' if the proc is a Java application; however, any necessary external programs must be preinstalled on every database node. If the command refers to a file in that directory, it must be preceded with './' as per Linux convention. If not specified, and exactly one file is provided in files, that file will be invoked. The default value is ''.
    
    args - An array of command-line arguments that will be passed to command when the proc is executed. The default value is an empty List.
    options - Optional parameters.
    
    MAX_CONCURRENCY_PER_NODE: The maximum number of concurrent instances of the proc that will be executed per node. 0 allows unlimited concurrency. The default value is '0'.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateProcResponse
  - createProjection
```
public CreateProjectionResponse createProjection(CreateProjectionRequest request)
                                          throws GPUdbException
```
    Creates a new projection of an existing table. A projection represents a subset of the columns (potentially including derived columns) of a table.
    For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
    Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumnRaw(GetRecordsByColumnRequest).
    A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.
    
    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:
    
    CreateProjectionResponse
  - createProjection
```
public CreateProjectionResponse createProjection(String tableName,
                                                 String projectionName,
                                                 List<String> columnNames,
                                                 Map<String,String> options)
                                          throws GPUdbException
```
    Creates a new projection of an existing table. A projection represents a subset of the columns (potentially including derived columns) of a table.
    For projection details and examples, see Projections. For limitations, see Projection Limitations and Cautions.
    Window functions, which can perform operations like moving averages, are available through this endpoint as well as getRecordsByColumnRaw(GetRecordsByColumnRequest).
    A projection can be created with a different shard key than the source table. By specifying shard_key, the projection will be sharded according to the specified columns, regardless of how the source table is sharded. The source table can even be unsharded or replicated.
    Parameters:
    
    tableName - Name of the existing table on which the projection is to be applied.
    
    projectionName - Name of the projection to be created. Has the same naming restrictions as tables.
    
    columnNames - List of columns from tableName to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column_name as alias'.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. The default value is ''.
    EXPRESSION: An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
    IS_REPLICATED: If true then the projection will be replicated even if the source table is not. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    LIMIT: The number of records to keep. The default value is ''.
    ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
    MATERIALIZE_ON_GPU: If true then the columns of the projection will be cached on the GPU. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    CHUNK_SIZE: Indicates the chunk size to be used for this table.
    CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.
    TTL: Sets the TTL of the projection specified in projectionName.
    SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
    PERSIST: If true, then the projection specified in projectionName will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    PRESERVE_DICT_ENCODING: If true, then columns that were dict encoded in the source table will be dict encoded in the projection table. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    VIEW_ID: view this projection is part of. The default value is ''.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateProjectionResponse
  - 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.
    
    options - Optional parameters. The default value is an empty Map.
    
    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. If a new table is being created, the type of the table is given by typeId, which must the be the 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, it will be created.
    To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.
    
    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. If a new table is being created, the type of the table is given by typeId, which must the be the 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, it will be created.
    To create a new collection, specify the name of the collection in tableName and set the is_collection option to true; typeId will be ignored.
    Parameters:
    
    tableName - Name of the table to be created. Error for requests with existing table of the same name and type id may be suppressed by using the no_error_if_exists option. See Tables for naming restrictions.
    
    typeId - ID of a currently registered type. All objects added to the newly created table will be of this type. Ignored if is_collection is true.
    options - Optional parameters.
    
    NO_ERROR_IF_EXISTS: If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    COLLECTION_NAME: Name of a collection which is to contain the newly created table. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
    IS_COLLECTION: Indicates whether the new table to be created will be a collection. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    DISALLOW_HOMOGENEOUS_TABLES: For a collection, indicates whether the collection prohibits containment of multiple tables of exactly the same data type. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    IS_REPLICATED: For a table, indicates the distribution scheme for the table's data. If true, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given typeId, or randomly sharded, if no shard key is specified. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.
    FOREIGN_SHARD_KEY: Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'
    TTL: For a table, sets the TTL of the table specified in tableName.
    CHUNK_SIZE: Indicates the chunk size to be used for this table.
    IS_RESULT_TABLE: For a table, indicates whether the table is an in-memory table. A result table cannot contain store_only, text_search, or string columns (charN columns are acceptable), and it will not be retained if the server is restarted. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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 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 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. The default value is an empty Map.
    
    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 the trigger port (by default '9001' but able to be retrieved 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 the trigger port (by default '9001' but able to be retrieved 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 - User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
    
    tableNames - Names of the tables on which the trigger will be activated and maintained.
    
    xColumnName - Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
    
    xVector - The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
    
    yColumnName - Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
    
    yVector - The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 the trigger port (by default '9001' but able to be retrieved 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 the trigger port (by default '9001' but able to be retrieved 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 - User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.
    
    tableNames - Tables on which the trigger will be active.
    
    columnName - Name of a numeric column_name on which the trigger is activated.
    
    min - The lower bound (inclusive) for the trigger range.
    
    max - The upper bound (inclusive) for the trigger range.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 describing the layout or schema of a table. The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive--i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
    A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
    Example of a type definition with some of the parameters::
    {"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
    Properties::
    {"group_id":["store_only"], "msg_id":["store_only","text_search"] }
    
    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 describing the layout or schema of a table. The type definition is a JSON string describing the fields (i.e. columns) of the type. Each field consists of a name and a data type. Supported data types are: double, float, int, long, string, and bytes. In addition one or more properties can be specified for each column which customize the memory usage and query availability of that column. Note that some properties are mutually exclusive--i.e. they cannot be specified for any given column simultaneously. One example of mutually exclusive properties are data and store_only.
    A single primary key and/or single shard key can be set across one or more columns. If a primary key is specified, then a uniqueness constraint is enforced, in that only a single object can exist with a given primary key. When inserting data into a table with a primary key, depending on the parameters in the request, incoming objects with primary key values that match existing objects will either overwrite (i.e. update) the existing object or will be skipped and not added into the set.
    Example of a type definition with some of the parameters::
    {"type":"record", "name":"point", "fields":[{"name":"msg_id","type":"string"}, {"name":"x","type":"double"}, {"name":"y","type":"double"}, {"name":"TIMESTAMP","type":"double"}, {"name":"source","type":"string"}, {"name":"group_id","type":"string"}, {"name":"OBJECT_ID","type":"string"}] }
    Properties::
    {"group_id":["store_only"], "msg_id":["store_only","text_search"] }
    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). Valid values are:
    
    DATA: Default property for all numeric and string type columns; makes the column available for GPU queries.
    TEXT_SEARCH: Valid only for 'string' columns. Enables full text search for string columns. Can be set independently of data and store_only.
    STORE_ONLY: Persist the column value but do not make it available to queries (e.g. filter(String, String, String, Map))-i.e. it is mutually exclusive to the data property. Any 'bytes' type column must have a store_only property. This property reduces system memory usage.
    DISK_OPTIMIZED: Works in conjunction with the data property for string columns. This property reduces system disk usage by disabling reverse string lookups. Queries like filter(String, String, String, Map), filterByList(String, String, Map, Map), and filterByValue(String, String, boolean, double, String, String, Map) work as usual but aggregateUniqueRaw(AggregateUniqueRequest), aggregateGroupByRaw(AggregateGroupByRequest) and getRecordsByColumnRaw(GetRecordsByColumnRequest) are not allowed on columns with this property.
    TIMESTAMP: Valid only for 'long' columns. Indicates that this field represents a timestamp and will be provided in milliseconds since the Unix epoch: 00:00:00 Jan 1 1970. Dates represented by a timestamp must fall between the year 1000 and the year 2900.
    DECIMAL: Valid only for 'string' columns. It represents a SQL type NUMERIC(19, 4) data type. There can be up to 15 digits before the decimal point and up to four digits in the fractional part. The value can be positive or negative (indicated by a minus sign at the beginning). This property is mutually exclusive with the text_search property.
    DATE: Valid only for 'string' columns. Indicates that this field represents a date and will be provided in the format 'YYYY-MM-DD'. The allowable range is 1000-01-01 through 2900-01-01. This property is mutually exclusive with the text_search property.
    TIME: Valid only for 'string' columns. Indicates that this field represents a time-of-day and will be provided in the format 'HH:MM:SS.mmm'. The allowable range is 00:00:00.000 through 23:59:59.999. This property is mutually exclusive with the text_search property.
    DATETIME: Valid only for 'string' columns. Indicates that this field represents a datetime and will be provided in the format 'YYYY-MM-DD HH:MM:SS.mmm'. The allowable range is 1000-01-01 00:00:00.000 through 2900-01-01 23:59:59.999. This property is mutually exclusive with the text_search property.
    CHAR1: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 1 character.
    CHAR2: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 2 characters.
    CHAR4: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 4 characters.
    CHAR8: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 8 characters.
    CHAR16: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 16 characters.
    CHAR32: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 32 characters.
    CHAR64: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 64 characters.
    CHAR128: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 128 characters.
    CHAR256: This property provides optimized memory, disk and query performance for string columns. Strings with this property must be no longer than 256 characters.
    INT8: This property provides optimized memory and query performance for int columns. Ints with this property must be between -128 and +127 (inclusive)
    INT16: This property provides optimized memory and query performance for int columns. Ints with this property must be between -32768 and +32767 (inclusive)
    IPV4: This property provides optimized memory, disk and query performance for string columns representing IPv4 addresses (i.e. 192.168.1.1). Strings with this property must be of the form: A.B.C.D where A, B, C and D are in the range of 0-255.
    WKT: Valid only for 'string' and 'bytes' columns. Indicates that this field contains geospatial geometry objects in Well-Known Text (WKT) or Well-Known Binary (WKB) format.
    PRIMARY_KEY: This property indicates that this column will be part of (or the entire) primary key.
    SHARD_KEY: This property indicates that this column will be part of (or the entire) shard key.
    NULLABLE: This property indicates that this column is nullable. However, setting this property is insufficient for making the column nullable. The user must declare the type of the column as a union between its regular type and 'null' in the avro schema for the record type in typeDefinition. For example, if a column is of type integer and is nullable, then the entry for the column in the avro schema must be: ['int', 'null']. The C++, C#, Java, and Python APIs have built-in convenience for bypassing setting the avro schema by hand. For those languages, one can use this property as usual and not have to worry about the avro schema for the record.
    DICT: This property indicates that this column should be dictionary encoded. It can only be used in conjunction with string columns marked with a charN or date property or with int or long columns. This property is appropriate for columns where the cardinality (the number of unique values) is expected to be low, and can save a large amount of memory.
    INIT_WITH_NOW: For columns with attributes of date, time, datetime or timestamp, at insert time, replace empty strings and invalid timestamps with NOW()
    options - Optional parameters. The default value is an empty Map.
    
    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
```
    Merges data from one or more tables with comparable data types into a new table.
    The following merges are supported:
    UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
    INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
    EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
    MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
    Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
    
    Parameters:
    
    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
```
    Merges data from one or more tables with comparable data types into a new table.
    The following merges are supported:
    UNION (DISTINCT/ALL) - For data set union details and examples, see Union. For limitations, see Union Limitations and Cautions.
    INTERSECT (DISTINCT/ALL) - For data set intersection details and examples, see Intersect. For limitations, see Intersect Limitations.
    EXCEPT (DISTINCT/ALL) - For data set subtraction details and examples, see Except. For limitations, see Except Limitations.
    MERGE VIEWS - For a given set of filtered views on a single table, creates a single filtered view containing all of the unique records across all of the given filtered data sets.
    Non-charN 'string' and 'bytes' column types cannot be merged, nor can columns marked as store-only.
    Parameters:
    
    tableName - Name of the table to be created. Has the same naming restrictions as tables.
    
    tableNames - The list of table names to merge. Must contain the names of one or more existing tables.
    
    inputColumnNames - The list of columns from each of the corresponding input tables.
    
    outputColumnNames - The list of names of the columns to be stored in the output table.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the output table. If the collection provided is non-existent, the collection will be automatically created. If empty, the output table will be a top-level table. The default value is ''.
    MATERIALIZE_ON_GPU: If true, then the columns of the output table will be cached on the GPU. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    MODE: If merge_views, then this operation will merge the provided views. All tableNames must be views from the same underlying base table. Supported values:
    
    UNION_ALL: Retains all rows from the specified tables.
    UNION: Retains all unique rows from the specified tables (synonym for union_distinct).
    UNION_DISTINCT: Retains all unique rows from the specified tables.
    EXCEPT: Retains all unique rows from the first table that do not appear in the second table (only works on 2 tables).
    EXCEPT_ALL: Retains all rows(including duplicates) from the first table that do not appear in the second table (only works on 2 tables).
    INTERSECT: Retains all unique rows that appear in both of the specified tables (only works on 2 tables).
    INTERSECT_ALL: Retains all rows(including duplicates) that appear in both of the specified tables (only works on 2 tables).
    MERGE_VIEWS: Merge two or more views (or views of views) of the same base data set into a new view. If this mode is selected inputColumnNames AND outputColumnNames must be empty. The resulting view would match the results of a SQL OR operation, e.g., if filter 1 creates a view using the expression 'x = 20' and filter 2 creates a view using the expression 'x <= 10', then the merge views operation creates a new view using the expression 'x = 20 OR x <= 10'.
    The default value is UNION_ALL.
    CHUNK_SIZE: Indicates the chunk size to be used for this table.
    CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in outputColumnNames.
    TTL: Sets the TTL of the table specified in tableName.
    PERSIST: If true, then the table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    VIEW_ID: view the output table will be a part of. The default value is ''.
    FORCE_REPLICATED: If true, then the table specified in tableName will be replicated even if the source tables are not. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 the database system).
    
    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 the database system).
    
    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.
    
    password - Initial password of the user to be created. May be an empty string for no password.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    CreateUserInternalResponse
  - deleteProc
```
public DeleteProcResponse deleteProc(DeleteProcRequest request)
                              throws GPUdbException
```
    Deletes a proc. Any currently running instances of the proc will be killed.
    
    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:
    
    DeleteProcResponse
  - deleteProc
```
public DeleteProcResponse deleteProc(String procName,
                                     Map<String,String> options)
                              throws GPUdbException
```
    Deletes a proc. Any currently running instances of the proc will be killed.
    
    Parameters:
    
    procName - Name of the proc to be deleted. Must be the name of a currently existing proc.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    DeleteProcResponse
  - 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), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
    
    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), a single record identified by record_id options, or all records when using delete_all_records. Note that the three selection criteria are mutually exclusive. This operation cannot be run on a collection or a view. The operation is synchronous meaning that a response will not be available until the request is completely processed and all the matching records are deleted.
    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. The default value is ''.
    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. This option cannot be used to delete records from replicated tables.
    DELETE_ALL_RECORDS: If set to true, all records in the table will be deleted. If set to false, then the option is effectively ignored. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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. The default value is an empty Map.
    
    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. The default value is an empty Map.
    
    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. This endpoint is asynchronous and does not wait for the proc to complete before returning.
    
    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 procName,
                                       Map<String,String> params,
                                       Map<String,ByteBuffer> binParams,
                                       List<String> inputTableNames,
                                       Map<String,List<String>> inputColumnNames,
                                       List<String> outputTableNames,
                                       Map<String,String> options)
                                throws GPUdbException
```
    Executes a proc. This endpoint is asynchronous and does not wait for the proc to complete before returning.
    Parameters:
    
    procName - Name of the proc to execute. Must be the name of a currently existing proc.
    
    params - A map containing named parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Map.
    
    binParams - A map containing named binary parameters to pass to the proc. Each key/value pair specifies the name of a parameter and its value. The default value is an empty Map.
    
    inputTableNames - Names of the tables containing data to be passed to the proc. Each name specified must be the name of a currently existing table. If no table names are specified, no data will be passed to the proc. The default value is an empty List.
    
    inputColumnNames - Map of table names from inputTableNames to lists of names of columns from those tables that will be passed to the proc. Each column name specified must be the name of an existing column in the corresponding table. If a table name from inputTableNames is not included, all columns from that table will be passed to the proc. The default value is an empty Map.
    
    outputTableNames - Names of the tables to which output data from the proc will be written. If a specified table does not exist, it will automatically be created with the same schema as the corresponding table (by order) from inputTableNames, excluding any primary and shard keys. If a specified table is a non-persistent result table, it must not have primary or shard keys. If no table names are specified, no output data can be returned from the proc. The default value is an empty List.
    options - Optional parameters.
    
    CACHE_INPUT: A comma-delimited list of table names from inputTableNames from which input data will be cached for use in subsequent calls to executeProc(String, Map, Map, List, Map, List, Map) with the use_cached_input option. Cached input data will be retained until the proc status is cleared with the clear_complete option of showProcStatus(String, Map) and all proc instances using the cached data have completed. The default value is ''.
    USE_CACHED_INPUT: A comma-delimited list of run IDs (as returned from prior calls to executeProc(String, Map, Map, List, Map, List, Map)) of running or completed proc instances from which input data cached using the cache_input option will be used. Cached input data will not be used for any tables specified in inputTableNames, but data from all other tables cached for the specified run IDs will be passed to the proc. If the same table was cached for multiple specified run IDs, the cached data from the first run ID specified in the list that includes that table will be used. The default value is ''.
    KIFS_INPUT_DIRS: A comma-delimited list of KiFS directories whose local files will be made directly accessible to the proc through the API. (All KiFS files, local or not, are also accessible through the file system below the KiFS mount point.) Each name specified must the name of an existing KiFS directory. The default value is ''.
    The default value is an empty Map.
    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 Expressions.
    The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
    
    Parameters:
    
    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 Expressions.
    The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
    Parameters:
    
    tableName - Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    expression - The select expression to filter the specified table. For details see Expressions.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    VIEW_ID: view this filtered-view is part of. The default value is ''.
    TTL: Sets the TTL of the view specified in viewName.
    The default value is an empty Map.
    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 a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
    
    Parameters:
    
    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 a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
    Parameters:
    
    tableName - Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    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.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByAreaResponse
  - filterByAreaGeometry
```
public FilterByAreaGeometryResponse filterByAreaGeometry(FilterByAreaGeometryRequest request)
                                                  throws GPUdbException
```
    Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
    
    Parameters:
    
    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:
    
    FilterByAreaGeometryResponse
  - filterByAreaGeometry
```
public FilterByAreaGeometryResponse filterByAreaGeometry(String tableName,
                                                         String viewName,
                                                         String columnName,
                                                         List<Double> xVector,
                                                         List<Double> yVector,
                                                         Map<String,String> options)
                                                  throws GPUdbException
```
    Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.
    Parameters:
    
    tableName - Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
    
    viewName - If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. The default value is ''.
    
    columnName - Name of the geospatial geometry column to be filtered.
    
    xVector - List of x coordinates of the vertices of the polygon representing the area to be filtered.
    
    yVector - List of y coordinates of the vertices of the polygon representing the area to be filtered.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByAreaGeometryResponse
  - 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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
    
    Parameters:
    
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
    Parameters:
    
    tableName - Name of the table on which the bounding box operation will be performed. Must be an existing table.
    
    viewName - Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. The default value is ''.
    
    xColumnName - Name of the column on which to perform the bounding box query. Must be a valid numeric column.
    
    minX - Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
    
    maxX - Upper bound for xColumnName. Must be greater than or equal to minX.
    
    yColumnName - Name of a column on which to perform the bounding box query. Must be a valid numeric column.
    
    minY - Lower bound for yColumnName. Must be less than or equal to maxY.
    
    maxY - Upper bound for yColumnName. Must be greater than or equal to minY.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByBoxResponse
  - filterByBoxGeometry
```
public FilterByBoxGeometryResponse filterByBoxGeometry(FilterByBoxGeometryRequest request)
                                                throws GPUdbException
```
    Calculates which geospatial geometry objects from a table intersect a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
    
    Parameters:
    
    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:
    
    FilterByBoxGeometryResponse
  - filterByBoxGeometry
```
public FilterByBoxGeometryResponse filterByBoxGeometry(String tableName,
                                                       String viewName,
                                                       String columnName,
                                                       double minX,
                                                       double maxX,
                                                       double minY,
                                                       double maxY,
                                                       Map<String,String> options)
                                                throws GPUdbException
```
    Calculates which geospatial geometry objects from a table intersect a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.
    Parameters:
    
    tableName - Name of the table on which the bounding box operation will be performed. Must be an existing table.
    
    viewName - Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view. The default value is ''.
    
    columnName - Name of the geospatial geometry column to be filtered.
    
    minX - Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.
    
    maxX - Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.
    
    minY - Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.
    
    maxY - Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByBoxGeometryResponse
  - filterByGeometry
```
public FilterByGeometryResponse filterByGeometry(FilterByGeometryRequest request)
                                          throws GPUdbException
```
    Applies a geometry filter against a geospatial geometry column 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 geospatial geometry column 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 geospatial geometry column.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    columnName - Name of the column to be used in the filter. Must be a geospatial geometry column.
    
    inputWkt - A geometry in WKT format that will be used to filter the objects in tableName. The default value is ''.
    operation - The geometric filtering operation to perform Supported values:
    
    CONTAINS: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry.
    CROSSES: Matches records that cross the given WKT.
    DISJOINT: Matches records that are disjoint from the given WKT.
    EQUALS: Matches records that are the same as the given WKT.
    INTERSECTS: Matches records that intersect the given WKT.
    OVERLAPS: Matches records that overlap the given WKT.
    TOUCHES: Matches records that touch the given WKT.
    WITHIN: Matches records that are within the given WKT.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
    For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
    
    Parameters:
    
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.
    For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.
    Parameters:
    
    tableName - Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    columnValuesMap - List of values for the corresponding column in the table
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    FILTER_MODE: String indicating the filter mode, either 'in_list' or 'not_in_list'. Supported values:
    
    IN_LIST: The filter will match all items that are in the provided list(s).
    NOT_IN_LIST: The filter will match all items that are not in the provided list(s).
    The default value is IN_LIST.
    The default value is an empty Map.
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
    For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
    
    Parameters:
    
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
    For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
    Parameters:
    
    tableName - Name of the table on which the filter by radius operation will be performed. Must be an existing table.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    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.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByRadiusResponse
  - filterByRadiusGeometry
```
public FilterByRadiusGeometryResponse filterByRadiusGeometry(FilterByRadiusGeometryRequest request)
                                                      throws GPUdbException
```
    Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
    
    Parameters:
    
    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:
    
    FilterByRadiusGeometryResponse
  - filterByRadiusGeometry
```
public FilterByRadiusGeometryResponse filterByRadiusGeometry(String tableName,
                                                             String viewName,
                                                             String columnName,
                                                             double xCenter,
                                                             double yCenter,
                                                             double radius,
                                                             Map<String,String> options)
                                                      throws GPUdbException
```
    Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.
    Parameters:
    
    tableName - Name of the table on which the filter by radius operation will be performed. Must be an existing table.
    
    viewName - If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. The default value is ''.
    
    columnName - Name of the geospatial geometry column to be filtered.
    
    xCenter - Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
    
    yCenter - Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
    
    radius - The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByRadiusGeometryResponse
  - 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. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
    For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
    
    Parameters:
    
    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. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
    For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).
    Parameters:
    
    tableName - Name of the table on which the filter by range operation will be performed. Must be an existing table.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    columnName - Name of a column on which the operation would be applied.
    
    lowerBound - Value of the lower bound (inclusive).
    
    upperBound - Value of the upper bound (inclusive).
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    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 a response will not be returned 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 a response will not be returned 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 a track present.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    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.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    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'. Supported values:
    
    EUCLIDEAN
    GREAT_CIRCLE
    
    The default value is an empty Map.
    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 options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.
    
    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 options 'case_sensitive' can be used to modify the behavior for all modes except 'search'. For 'search' mode details and limitations, see Full Text Search.
    Parameters:
    
    tableName - Name of the table on which the filter operation will be performed. Must be an existing table, collection or view.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    expression - The expression with which to filter the table.
    mode - The string filtering mode to apply. See below for details. Supported values:
    
    SEARCH: Full text search query with wildcards and boolean operators. Note that for this mode, no column can be specified in columnNames; all string columns of the table that have text search enabled will be searched.
    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.
    columnNames - List of columns on which to apply the filter. Ignored for 'search' mode.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    CASE_SENSITIVE: If 'false' then string filtering will ignore case. Does not apply to 'search' mode. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    The default value is an empty Map.
    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 a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
    
    Parameters:
    
    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 a response will not be returned until all objects are fully available in the result view. The return value contains the count (i.e. the size) of the resulting view.
    Parameters:
    
    tableName - Name of the table whose data will be filtered. Must be an existing table.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    columnName - Name of the column by whose value the data will be filtered from the table designated by tableName.
    
    sourceTableName - Name of the table whose data will be compared against in the table called tableName. Must be an existing table.
    
    sourceTableColumnName - Name of the column in the sourceTableName whose values will be used as the filter for table tableName. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the columnName.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    FILTER_MODE: String indicating the filter mode, either in_table or not_in_table. Supported values:
    
    IN_TABLE
    NOT_IN_TABLE
    The default value is IN_TABLE.
    MODE: Mode - should be either spatial or normal. Supported values:
    
    NORMAL
    SPATIAL
    The default value is NORMAL.
    BUFFER: Buffer size, in meters. Only relevant for spatial mode. The default value is '0'.
    BUFFER_METHOD: Method used to buffer polygons. Only relevant for spatial mode. Supported values:
    
    NORMAL
    GEOS: Use geos 1 edge per corner algorithm
    The default value is NORMAL.
    MAX_PARTITION_SIZE: Maximum number of points in a partition. Only relevant for spatial mode. The default value is '0'.
    MAX_PARTITION_SCORE: Maximum number of points * edges in a partition. Only relevant for spatial mode. The default value is '8000000'.
    X_COLUMN_NAME: Name of column containing x value of point being filtered in spatial mode. The default value is 'x'.
    Y_COLUMN_NAME: Name of column containing y value of point being filtered in spatial mode. The default value is 'y'.
    The default value is an empty Map.
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
    
    Parameters:
    
    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 a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
    Parameters:
    
    tableName - Name of an existing table on which to perform the calculation.
    
    viewName - If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''.
    
    isString - Indicates whether the value being searched for is string or numeric.
    
    value - The value to search for. The default value is 0.
    
    valueStr - The string value to search for. The default value is ''.
    
    columnName - Name of a column on which the filter by value would be applied.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    FilterByValueResponse
  - getJob
```
public GetJobResponse getJob(GetJobRequest request)
                      throws GPUdbException
```
    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:
    
    GetJobResponse
  - getJob
```
public GetJobResponse getJob(int jobId,
                             Map<String,String> options)
                      throws GPUdbException
```
    Parameters:
    
    jobId - A unique identifier for the job whose status and result is to be fetched.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GetJobResponse
  - 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 be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
    This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
    
    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 be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
    This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
    
    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 be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
    This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
    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 default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000.
    options -
    
    EXPRESSION: Optional filter expression to apply to the table.
    FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    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. If sort_order is provided, sort_by has to be provided. Supported values:
    
    ASCENDING
    DESCENDING
    The default value is ASCENDING.
    The default value is an empty Map.
    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 be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
    This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
    
    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 be performed on tables, views, or on homogeneous collections (collections containing tables of all the same type). Records can be returned encoded as binary, json or geojson.
    This operation supports paging through the data via the offset and limit parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.
    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 default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000.
    options -
    
    EXPRESSION: Optional filter expression to apply to the table.
    FAST_INDEX_LOOKUP: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from [0 to END_OF_SET]. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    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. If sort_order is provided, sort_by has to be provided. Supported values:
    
    ASCENDING
    DESCENDING
    The default value is ASCENDING.
    The default value is an empty Map.
    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 from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
    Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(CreateProjectionRequest).
    When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
    The response is returned as a dynamic schema. For details see: dynamic schemas 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:
    
    RawGetRecordsByColumnResponse
  - getRecordsByColumn
```
public GetRecordsByColumnResponse getRecordsByColumn(GetRecordsByColumnRequest request)
                                              throws GPUdbException
```
    For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
    Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(CreateProjectionRequest).
    When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
    The response is returned as a dynamic schema. For details see: dynamic schemas 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:
    
    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 from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.
    Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(String, String, List, Map).
    When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.
    The response is returned as a dynamic schema. For details see: dynamic schemas documentation.
    Parameters:
    
    tableName - Name of the table on which this operation will be performed. The table cannot be a parent set.
    
    columnNames - The list of column values to retrieve.
    
    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_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned.
    options -
    
    EXPRESSION: Optional filter expression to apply to the table.
    SORT_BY: Optional column(s) 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. If sort_order is provided, sort_by has to be provided. Supported values:
    
    ASCENDING
    DESCENDING
    The default value is ASCENDING.
    ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. 'timestamp asc, x desc'. The default value is ''.
    CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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.
    
    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.
    
    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.
    
    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 default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.
    
    options - Optional parameters. The default value is an empty Map.
    
    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.
    
    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.
    
    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 default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of series/tracks to be returned. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 250.
    
    options - Optional parameters. The default value is an empty Map.
    
    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.
    
    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.
    
    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.
    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 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 default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000.
    options -
    
    RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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.
    
    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.
    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 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 default value is 0.The minimum allowed value is 0. The maximum allowed value is MAX_INT.
    
    limit - A positive integer indicating the maximum number of results to be returned, or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is 10000.
    options -
    
    RETURN_RECORD_IDS: If 'true' then return the internal record ID along with each returned record. Default is 'false'. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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. Supported values:
    
    SYSTEM_ADMIN: Full access to all data and system functions.
    SYSTEM_WRITE: Read and write access to all tables.
    SYSTEM_READ: Read-only access to all tables.
    options - Optional parameters. The default value is an empty Map.
    
    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. Supported values:
    
    TABLE_ADMIN: Full read/write and administrative access to the table.
    TABLE_INSERT: Insert access to the table.
    TABLE_UPDATE: Update access to the table.
    TABLE_DELETE: Delete access to the table.
    TABLE_READ: Read access to the table.
    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. The default value is ''.
    
    options - Optional parameters. The default value is an empty Map.
    
    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. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    GrantRoleResponse
  - hasProc
```
public HasProcResponse hasProc(HasProcRequest request)
                        throws GPUdbException
```
    Checks the existence of a proc with the given name.
    
    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:
    
    HasProcResponse
  - hasProc
```
public HasProcResponse hasProc(String procName,
                               Map<String,String> options)
                        throws GPUdbException
```
    Checks the existence of a proc with the given name.
    
    Parameters:
    
    procName - Name of the proc to check for existence.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    HasProcResponse
  - hasTable
```
public HasTableResponse hasTable(HasTableRequest request)
                          throws GPUdbException
```
    Checks for the existence of a table with the given name.
    
    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 for the existence of a table with the given name.
    
    Parameters:
    
    tableName - Name of the table to check for existence.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 for the existence of a type.
    
    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 for the existence of a type.
    
    Parameters:
    
    typeId - Id of the type returned in response to createType(String, String, Map, Map) request.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
    The options parameter can be used to customize this function's behavior.
    The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
    The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
    
    Parameters:
    
    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 a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
    The options parameter can be used to customize this function's behavior.
    The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
    The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
    
    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 a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
    The options parameter can be used to customize this function's behavior.
    The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
    The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
    
    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 a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
    The options parameter can be used to customize this function's behavior.
    The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
    The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
    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: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    RETURN_RECORD_IDS: If true then return the internal record id along for each inserted record. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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 a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
    The options parameter can be used to customize this function's behavior.
    The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
    The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
    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: Specifies the record collision policy for inserting into a table with a primary key. If set to true, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record. If set to false, any existing table record with primary key values that match those of a record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    RETURN_RECORD_IDS: If true then return the internal record id along for each inserted record. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty 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:
    
    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 a response will not be returned 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 a response will not be returned 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. These parameters take on different meanings depending on the type of the column. Below follows a more detailed description of the map:
    
    SEED: If provided, the internal random number generator will be initialized with the given value. The minimum is 0. This allows for the same set of random numbers to be generated across invocation of this endpoint in case the user wants to repeat the test. Since options, is a map of maps, we need an internal map to provide the seed value. For example, to pass 100 as the seed value through this parameter, you need something equivalent to: 'options' = {'seed': { 'value': 100 } }
    
    VALUE: Pass the seed value here.
    
    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 columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [0, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    MAX: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings 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 [0, 200]. If the *max* is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    INTERVAL: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
    NULL_PERCENTAGE: If specified, then generate the given percentage of the count as nulls for all nullable columns. This option will be ignored for non-nullable columns. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
    CARDINALITY: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
    
    ATTR_NAME: Use the desired column name in place of attr_name, and set the following parameters for the column specified. This overrides any parameter set by all.
    
    MIN: For numerical columns, the minimum of the generated values is set to this value. Default is -99999. For point, shape, and track columns, min for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are -180.0 and -90.0. For the 'TIMESTAMP' column, the default minimum corresponds to Jan 1, 2010. For string columns, the minimum length of the randomly generated strings is set to this value (default is 0). If both minimum and maximum are provided, minimum must be less than or equal to max. Value needs to be within [0, 200]. If the min is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    MAX: For numerical columns, the maximum of the generated values is set to this value. Default is 99999. For point, shape, and track columns, max for numeric 'x' and 'y' columns needs to be within [-180, 180] and [-90, 90], respectively. The default minimum possible values for these columns in such cases are 180.0 and 90.0. For string columns, the maximum length of the randomly generated strings 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 [0, 200]. If the *max* is outside the accepted ranges for strings columns and 'x' and 'y' columns for point/shape/track, then those parameters will not be set; however, an error will not be thrown in such a case. It is the responsibility of the user to use the all parameter judiciously.
    INTERVAL: If specified, generate values for all columns evenly spaced with the given interval value. If a max value is specified for a given column the data is randomly generated between min and max and decimated down to the interval. If no max is provided the data is linerally generated starting at the minimum value (instead of generating random data). For non-decimated string-type columns the interval value is ignored. Instead the values are generated following the pattern: 'attrname_creationIndex#', i.e. the column name suffixed with an underscore and a running counter (starting at 0). For string types with limited size (eg char4) the prefix is dropped. No nulls will be generated for nullable columns.
    NULL_PERCENTAGE: If specified and if this column is nullable, then generate the given percentage of the count as nulls. This option will result in an error if the column is not nullable. The value must be within the range [0, 1.0]. The default value is 5% (0.05).
    CARDINALITY: If specified, limit the randomly generated values to a fixed set. Not allowed on a column with interval specified, and is not applicable to WKT or Track-specific columns. The value must be greater than 0. This option is disabled by default.
    
    TRACK_LENGTH: This key-map pair is only valid for track data sets (an error is thrown otherwise). No nulls would be generated for nullable columns.
    
    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.
    
    The default value is an empty Map.
    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) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used 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) if the 'dosymbology' parameter is 'true' then the value of the 'SYMBOLCODE' column is used 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'. Supported 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.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    InsertSymbolResponse
  - killProc
```
public KillProcResponse killProc(KillProcRequest request)
                          throws GPUdbException
```
    Kills a running proc instance.
    
    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:
    
    KillProcResponse
  - killProc
```
public KillProcResponse killProc(String runId,
                                 Map<String,String> options)
                          throws GPUdbException
```
    Kills a running proc instance.
    
    Parameters:
    
    runId - The run ID of the running proc instance. If the run ID is not found or the proc instance has already completed, this does nothing. If not specified, all running proc instances will be killed. The default value is ''.
    
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    KillProcResponse
  - lockTable
```
public LockTableResponse lockTable(LockTableRequest request)
                            throws GPUdbException
```
    Manages global access to a table's data. By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
    
    Parameters:
    
    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 read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
    Parameters:
    
    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. Supported values:
    
    STATUS: Show locked status
    NO_ACCESS: Allow no read/write operations
    READ_ONLY: Allow only read operations
    WRITE_ONLY: Allow only write operations
    READ_WRITE: Allow all read/write operations
    The default value is STATUS.
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    LockTableResponse
  - mergeRecords
```
public MergeRecordsResponse mergeRecords(MergeRecordsRequest request)
                                  throws GPUdbException
```
    Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
    For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions. The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
    
    Parameters:
    
    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:
    
    MergeRecordsResponse
  - mergeRecords
```
public MergeRecordsResponse mergeRecords(String tableName,
                                         List<String> sourceTableNames,
                                         List<Map<String,String>> fieldMaps,
                                         Map<String,String> options)
                                  throws GPUdbException
```
    Create a new empty result table (specified by tableName), and insert all records from source tables (specified by sourceTableNames) based on the field mapping information (specified by fieldMaps).
    For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions. The field map (specified by fieldMaps) holds the user-specified maps of target table column names to source table columns. The array of fieldMaps must match one-to-one with the sourceTableNames, e.g., there's a map present in fieldMaps for each table listed in sourceTableNames.
    Parameters:
    
    tableName - The new result table name for the records to be merged. Must NOT be an existing table.
    
    sourceTableNames - The list of source table names to get the records from. Must be existing table names.
    
    fieldMaps - Contains a list of source/target column mappings, one mapping for each source table listed in sourceTableNames being merged into the target table specified by tableName. Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.
    options - Optional parameters.
    
    COLLECTION_NAME: Name of a collection which is to contain the newly created merged table specified by tableName. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created merged table will be a top-level table.
    IS_REPLICATED: Indicates the distribution scheme for the data of the merged table specified in tableName. If true, the table will be replicated. If false, the table will be randomly sharded. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    TTL: Sets the TTL of the merged table specified in tableName.
    PERSIST: If true, then the table specified in tableName will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    CHUNK_SIZE: Indicates the chunk size to be used for the merged table specified in tableName.
    VIEW_ID: view this result table is part of. The default value is ''.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    MergeRecordsResponse
  - adminReplaceTom
```
public AdminReplaceTomResponse adminReplaceTom(AdminReplaceTomRequest request)
                                        throws GPUdbException
```
    Throws:
    
    GPUdbException
  - adminReplaceTom
```
public AdminReplaceTomResponse adminReplaceTom(long oldRankTom,
                                               long newRankTom)
                                        throws GPUdbException
```
    Throws:
    
    GPUdbException
  - 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. Supported values:
    
    SYSTEM_ADMIN: Full access to all data and system functions.
    SYSTEM_WRITE: Read and write access to all tables.
    SYSTEM_READ: Read-only access to all tables.
    options - Optional parameters. The default value is an empty Map.
    
    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. Supported values:
    
    TABLE_ADMIN: Full read/write and administrative access to the table.
    TABLE_INSERT: Insert access to the table.
    TABLE_UPDATE: Update access to the table.
    TABLE_DELETE: Delete access to the table.
    TABLE_READ: Read access to the table.
    tableName - Name of the table to which the permission grants access. Must be an existing table, collection, or view.
    
    options - Optional parameters. The default value is an empty Map.
    
    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. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    RevokeRoleResponse
  - showProc
```
public ShowProcResponse showProc(ShowProcRequest request)
                          throws GPUdbException
```
    Shows information about a proc.
    
    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:
    
    ShowProcResponse
  - showProc
```
public ShowProcResponse showProc(String procName,
                                 Map<String,String> options)
                          throws GPUdbException
```
    Shows information about a proc.
    Parameters:
    
    procName - Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ''.
    options - Optional parameters.
    
    INCLUDE_FILES: If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowProcResponse
  - showProcStatus
```
public ShowProcStatusResponse showProcStatus(ShowProcStatusRequest request)
                                      throws GPUdbException
```
    Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from executeProc(ExecuteProcRequest)) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
    
    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:
    
    ShowProcStatusResponse
  - showProcStatus
```
public ShowProcStatusResponse showProcStatus(String runId,
                                             Map<String,String> options)
                                      throws GPUdbException
```
    Shows the statuses of running or completed proc instances. Results are grouped by run ID (as returned from executeProc(String, Map, Map, List, Map, List, Map)) and data segment ID (each invocation of the proc command on a data segment is assigned a data segment ID).
    Parameters:
    
    runId - The run ID of a specific running or completed proc instance for which the status will be returned. If the run ID is not found, nothing will be returned. If not specified, the statuses of all running and completed proc instances will be returned. The default value is ''.
    options - Optional parameters.
    
    CLEAR_COMPLETE: If set to true, if a proc instance has completed (either successfully or unsuccessfully) then its status will be cleared and no longer returned in subsequent calls. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    ShowProcStatusResponse
  - 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. The default value is an empty Map.
    
    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 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 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.
    The default value is an empty Map.
    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 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 admin tool uses it to present server related information to the user.
    
    Parameters:
    
    options - Optional parameters, currently unused. The default value is an empty Map.
    
    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 database requests along with the request timing and internal job id. The admin tool uses it to present request timing information to the user.
    
    Parameters:
    
    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 database requests along with the request timing and internal job id. The admin tool uses it to present request timing information to the user.
    
    Parameters:
    
    options - Optional parameters, currently unused. The default value is an empty Map.
    
    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 tables, views, and collections.
    If tableName specifies a table or view, information specific to that entity will be returned.
    If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).
    If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.
    If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.
    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).
    
    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 tables, views, and collections.
    If tableName specifies a table or view, information specific to that entity will be returned.
    If tableName specifies a collection, the call can return information about either the collection itself (setting the show_children option to false) or the tables and views it contains (setting show_children to true).
    If tableName is empty, information about all collections and top-level tables and views can be returned. Note: show_children must be set to true.
    If tableName is '*', information about all tables, collections, and views will be returned. Note: show_children must be set to true.
    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).
    Parameters:
    
    tableName - Name of the table for which to retrieve the information. If blank, then information about all collections and top-level tables and views is returned.
    options - Optional parameters.
    
    FORCE_SYNCHRONOUS: If true then the table sizes will wait for read lock before returning. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    GET_SIZES: If true then the table sizes will be returned; blank, otherwise. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    SHOW_CHILDREN: If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself. If tableName is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. Supported values:
    
    TRUE
    FALSE
    The default value is TRUE.
    NO_ERROR_IF_NOT_EXISTS: If false will return an error if the provided tableName does not exist. If true then it will return an empty result. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    GET_COLUMN_INFO: If true then column info (memory usage, etc) will be returned. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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, or an error is returned.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
    
    Parameters:
    
    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 whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.
    
    Parameters:
    
    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. The default value is an empty Map.
    
    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.
    
    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.
    
    Parameters:
    
    triggerIds - List of IDs of the triggers whose information is to be retrieved. An empty list means information will be retrieved on all active triggers.
    
    options - Optional parameters. The default value is an empty Map.
    
    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 ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
    
    Parameters:
    
    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 ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.
    Parameters:
    
    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.
    
    NO_JOIN_TYPES: When set to 'true', no join types will be included. Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    The default value is an empty Map.
    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.
    
    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.
    
    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.
    
    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.
    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. The default value is an empty List.
    options - Optional parameters.
    
    GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ''.
    BYPASS_SAFETY_CHECKS: When set to true, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values:
    
    TRUE
    FALSE
    The default value is 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). Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    USE_EXPRESSIONS_IN_NEW_VALUES_MAPS: When set to true, all new values in newValuesMaps are considered as expression values. When set to false, all new values in newValuesMaps are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. Supported values:
    
    TRUE
    FALSE
    The default value is 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)).
    The default value is an empty 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.
    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. The default value is an empty List.
    options - Optional parameters.
    
    GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ''.
    BYPASS_SAFETY_CHECKS: When set to true, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values:
    
    TRUE
    FALSE
    The default value is 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). Supported values:
    
    TRUE
    FALSE
    The default value is FALSE.
    USE_EXPRESSIONS_IN_NEW_VALUES_MAPS: When set to true, all new values in newValuesMaps are considered as expression values. When set to false, all new values in newValuesMaps are considered as constants. NOTE: When true, string constants will need to be quoted to avoid being evaluated as expressions. Supported values:
    
    TRUE
    FALSE
    The default value is 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)).
    The default value is an empty 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 an existing view.
    
    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. The default value is ''.
    
    reserved - The default value is an empty List.
    
    options - Optional parameters. The default value is an empty Map.
    
    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,
                                             String geometryColumnName,
                                             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
  - visualizeImageChart
```
public VisualizeImageChartResponse visualizeImageChart(VisualizeImageChartRequest request)
                                                throws GPUdbException
```
    Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
    
    Parameters:
    
    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:
    
    VisualizeImageChartResponse
  - visualizeImageChart
```
public VisualizeImageChartResponse visualizeImageChart(String tableName,
                                                       List<String> xColumnNames,
                                                       List<String> yColumnNames,
                                                       double minX,
                                                       double maxX,
                                                       double minY,
                                                       double maxY,
                                                       int width,
                                                       int height,
                                                       String bgColor,
                                                       Map<String,List<String>> styleOptions,
                                                       Map<String,String> options)
                                                throws GPUdbException
```
    Scatter plot is the only plot type currently supported. A non-numeric column can be specified as x or y column and jitters can be added to them to avoid excessive overlapping. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The image is contained in the imageData field.
    Parameters:
    
    tableName - Name of the table containing the data to be drawn as a chart.
    
    xColumnNames - Names of the columns containing the data mapped to the x axis of a chart.
    
    yColumnNames - Names of the columns containing the data mapped to the y axis of a chart.
    
    minX - Lower bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
    
    maxX - Upper bound for the x column values. For non-numeric x column, each x column item is mapped to an integral value starting from 0.
    
    minY - Lower bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
    
    maxY - Upper bound for the y column values. For non-numeric y column, each y column item is mapped to an integral value starting from 0.
    
    width - Width of the generated image in pixels.
    
    height - Height of the generated image in pixels.
    
    bgColor - Background color of the generated image.
    styleOptions - Rendering style options for a chart.
    
    POINTCOLOR: The color of points in the plot represented as a hexadecimal number. The default value is '0000FF'.
    POINTSIZE: The size of points in the plot represented as number of pixels. The default value is '3'.
    POINTSHAPE: The shape of points in the plot. Supported values:
    
    NONE
    CIRCLE
    SQUARE
    DIAMOND
    HOLLOWCIRCLE
    HOLLOWSQUARE
    HOLLOWDIAMOND
    The default value is SQUARE.
    CB_POINTCOLORS: Point color class break information consisting of three entries: class-break attribute, class-break values/ranges, and point color values. This option overrides the pointcolor option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point color values are separated by cb_delimiter, e.g. {"price", "20:30;30:40;40:50", "0xFF0000;0x00FF00;0x0000FF"}.
    CB_POINTSIZES: Point size class break information consisting of three entries: class-break attribute, class-break values/ranges, and point size values. This option overrides the pointsize option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point size values are separated by cb_delimiter, e.g. {"states", "NY;TX;CA", "3;5;7"}.
    CB_POINTSHAPES: Point shape class break information consisting of three entries: class-break attribute, class-break values/ranges, and point shape names. This option overrides the pointshape option if both are provided. Class-break ranges are represented in the form of "min:max". Class-break values/ranges and point shape names are separated by cb_delimiter, e.g. {"states", "NY;TX;CA", "circle;square;diamond"}.
    CB_DELIMITER: A character or string which separates per-class values in a class-break style option string. The default value is ';'.
    X_ORDER_BY: An expression or aggregate expression by which non-numeric x column values are sorted, e.g. "avg(price) descending".
    Y_ORDER_BY: An expression or aggregate expression by which non-numeric y column values are sorted, e.g. "avg(price)", which defaults to "avg(price) ascending".
    SCALE_TYPE_X: Type of x axis scale. Supported values:
    
    NONE: No scale is applied to the x axis.
    LOG: A base-10 log scale is applied to the x axis.
    The default value is NONE.
    SCALE_TYPE_Y: Type of y axis scale. Supported values:
    
    NONE: No scale is applied to the y axis.
    LOG: A base-10 log scale is applied to the y axis.
    The default value is NONE.
    MIN_MAX_SCALED: If this options is set to "false", this endpoint expects request's min/max values are not yet scaled. They will be scaled according to scale_type_x or scale_type_y for response. If this options is set to "true", this endpoint expects request's min/max values are already scaled according to scale_type_x/scale_type_y. Response's min/max values will be equal to request's min/max values. The default value is 'false'.
    JITTER_X: Amplitude of horizontal jitter applied to non-numeric x column values. The default value is '0.0'.
    JITTER_Y: Amplitude of vertical jitter applied to non-numeric y column values. The default value is '0.0'.
    PLOT_ALL: If this options is set to "true", all non-numeric column values are plotted ignoring min_x, max_x, min_y and max_y parameters. The default value is 'false'.
    options - Optional parameters. The default value is an empty Map.
    
    Returns:
    
    Response object containing the results of the operation.
    
    Throws:
    
    GPUdbException - if an error occurs during the operation.
    
    See Also:
    
    VisualizeImageChartResponse
  - visualizeImageClassbreak
```
public VisualizeImageClassbreakResponse visualizeImageClassbreak(VisualizeImageClassbreakRequest request)
                                                          throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageClassbreak
```
public VisualizeImageClassbreakResponse visualizeImageClassbreak(List<String> tableNames,
                                                                 List<String> worldTableNames,
                                                                 String xColumnName,
                                                                 String yColumnName,
                                                                 String geometryColumnName,
                                                                 List<List<String>> trackIds,
                                                                 String cbAttr,
                                                                 List<String> cbVals,
                                                                 String cbPointcolorAttr,
                                                                 List<String> cbPointcolorVals,
                                                                 String cbPointsizeAttr,
                                                                 List<String> cbPointsizeVals,
                                                                 String cbPointshapeAttr,
                                                                 List<String> cbPointshapeVals,
                                                                 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
  - visualizeImageContour
```
public VisualizeImageContourResponse visualizeImageContour(VisualizeImageContourRequest request)
                                                    throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageContour
```
public VisualizeImageContourResponse visualizeImageContour(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
  - visualizeImageHeatmap
```
public VisualizeImageHeatmapResponse visualizeImageHeatmap(VisualizeImageHeatmapRequest request)
                                                    throws GPUdbException
```
    Throws:
    
    GPUdbException
  - visualizeImageHeatmap
```
public VisualizeImageHeatmapResponse visualizeImageHeatmap(List<String> tableNames,
                                                           String xColumnName,
                                                           String yColumnName,
                                                           String valueColumnName,
                                                           String geometryColumnName,
                                                           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,
                                                         String filter,
                                                         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
```
    Throws:
    
    GPUdbException
  - visualizeVideo
```
public VisualizeVideoResponse visualizeVideo(List<String> tableNames,
                                             List<String> worldTableNames,
                                             List<List<String>> trackIds,
                                             String xColumnName,
                                             String yColumnName,
                                             String geometryColumnName,
                                             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
```
    Throws:
    
    GPUdbException
  - 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

GPUdb

GPUdb

Method Detail

adminAlterJobs

adminAlterJobs

adminOffline

adminOffline

adminShowAlerts

adminShowAlerts

adminShowJobs

adminShowJobs

adminShowShards

adminShowShards

adminShutdown

adminShutdown

adminVerifyDb

adminVerifyDb

aggregateConvexHull

aggregateConvexHull

aggregateGroupByRaw

aggregateGroupBy

aggregateGroupBy

aggregateHistogram

aggregateHistogram

aggregateKMeans

aggregateKMeans

aggregateMinMax

aggregateMinMax

aggregateMinMaxGeometry

aggregateMinMaxGeometry

aggregateStatistics

aggregateStatistics

aggregateStatisticsByRange

aggregateStatisticsByRange

aggregateUniqueRaw

aggregateUnique

aggregateUnique

aggregateUnpivotRaw

aggregateUnpivot

aggregateUnpivot

alterSystemProperties

alterSystemProperties

alterTable

alterTable

alterTableMetadata

alterTableMetadata

alterUser

alterUser

appendRecords

appendRecords

clearTable

clearTable

clearTableMonitor

clearTableMonitor

clearTrigger

clearTrigger

createJob

createJob

createJoinTable

createJoinTable

createMaterializedView

createMaterializedView

createProc

createProc

createProjection

createProjection